update mdatagen to support per signal stability (open-telemetry#21153)

This will allow us to move more components to using mdatagen. Next steps would be to move mdatagen to the build-tools repo to make it more widely usable. --------- Signed-off-by: Alex Boten <[email protected]>
zdelagrange · May 5, 2023 · b2eea6e · b2eea6e
1 parent dda09dc
commit b2eea6e
Show file tree

Hide file tree

Showing 239 changed files with 679 additions and 615 deletions.
diff --git a/.chloggen/codeboten_add-stability-per-signal.yaml b/.chloggen/codeboten_add-stability-per-signal.yaml
@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: mdatagen
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Support stability level per signal
+
+# One or more tracking issues related to the change
+issues: [21153]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
diff --git a/cmd/mdatagen/main.go b/cmd/mdatagen/main.go
@@ -24,6 +24,7 @@ import (
  "os"
  "path/filepath"
  "regexp"
+ "sort"
  "strings"
  "text/template"
 
@@ -131,6 +132,16 @@ func templatize(tmplFile string, md metadata) *template.Template {
  "distroURL": func(name string) string {
  return distros[name]
  },
+ "keys": func(input map[string]string) []string {
+ keys := []string{}
+ for k := range input {
+ keys = append(keys, k)
+ }
+ sort.Slice(keys, func(i, j int) bool {
+ return keys[i] > keys[j]
+ })
+ return keys
+ },
  // ParseFS delegates the parsing of the files to `Glob`
  // which uses the `\` as a special character.
  // Meaning on windows based machines, the `\` needs to be replaced

diff --git a/cmd/mdatagen/main_test.go b/cmd/mdatagen/main_test.go
@@ -58,8 +58,8 @@ metrics:
 type: metricreceiver
 status:
  class: exporter
- stability: beta
- pipelines: [metrics, logs, traces]
+ stability:
+  beta: [traces, metrics, logs]
  distributions: [contrib]
 `,
  wantStatusGenerated: true,
@@ -141,6 +141,7 @@ func Test_inlineReplace(t *testing.T) {
  outputFile string
  componentClass string
  warnings []string
+ stability map[string][]string
  }{
  {
  name: "readme with empty status",
@@ -202,13 +203,28 @@ Some warning there.
  outputFile: "readme_with_warnings.md",
  warnings: []string{"warning1"},
  },
+ {
+ name: "readme with multiple signals",
+ markdown: `# Some component
+
+<!-- status autogenerated section -->
+<!-- end autogenerated section -->
+
+Some info about a component
+`,
+ outputFile: "readme_with_multiple_signals.md",
+ stability: map[string][]string{"beta": {"metrics"}, "alpha": {"logs"}},
+ },
  }
  for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
+ stability := map[string][]string{"beta": {"metrics"}}
+ if len(tt.stability) > 0 {
+ stability = tt.stability
+ }
  md := metadata{
  Status: Status{
- Stability: "beta",
- Pipelines: []string{"metrics"},
+ Stability: stability,
  Distributions: []string{"contrib"},
  Class: tt.componentClass,
  Warnings: tt.warnings,
@@ -229,7 +245,7 @@ Some warning there.
  expected, err := os.ReadFile(filepath.Join("testdata", tt.outputFile))
  require.NoError(t, err)
  expected = bytes.ReplaceAll(expected, []byte("\r\n"), []byte("\n"))
- require.Equal(t, expected, got)
+ require.Equal(t, expected, got, "got: %s\nexpected: %s", got, expected)
  })
  }
 }
@@ -246,8 +262,7 @@ func TestGenerateStatusMetadata(t *testing.T) {
  md: metadata{
  Type: "foo",
  Status: Status{
- Stability: "beta",
- Pipelines: []string{"metrics"},
+ Stability: map[string][]string{"beta": {"metrics"}},
  Distributions: []string{"contrib"},
  Class: "receiver",
  },
@@ -261,8 +276,8 @@ import (
 )
 
 const (
- Type = "foo"
- Stability = component.StabilityLevelBeta
+ Type  = "foo"
+ MetricsStability = component.StabilityLevelBeta
 )
 `,
  },
@@ -271,8 +286,7 @@ const (
  md: metadata{
  Type: "foo",
  Status: Status{
- Stability: "alpha",
- Pipelines: []string{"metrics"},
+ Stability: map[string][]string{"alpha": {"metrics"}},
  Distributions: []string{"contrib"},
  Class: "receiver",
  },
@@ -286,8 +300,8 @@ import (
 )
 
 const (
- Type = "foo"
- Stability = component.StabilityLevelAlpha
+ Type  = "foo"
+ MetricsStability = component.StabilityLevelAlpha
 )
 `,
  },

diff --git a/cmd/mdatagen/statusdata.go b/cmd/mdatagen/statusdata.go
@@ -24,9 +24,8 @@ var distros = map[string]string{
 }
 
 type Status struct {
- Stability string `mapstructure:"stability"`
- Pipelines []string `mapstructure:"pipelines"`
- Distributions []string `mapstructure:"distributions"`
- Class string `mapstructure:"class"`
- Warnings []string `mapstructure:"warnings"`
+ Stability map[string][]string `mapstructure:"stability"`
+ Distributions []string `mapstructure:"distributions"`
+ Class string `mapstructure:"class"`
+ Warnings []string `mapstructure:"warnings"`
 }
diff --git a/cmd/mdatagen/templates/readme.md.tmpl b/cmd/mdatagen/templates/readme.md.tmpl
@@ -1,17 +1,20 @@
 <!-- status autogenerated section -->
-{{- if ne .Status.Stability "" }}
-| Status | |
-| ------------------------ |-----------|
-| Stability | [{{ .Status.Stability }}] |
-{{- if ne .Status.Class "extension" }}
-| Supported pipeline types | {{ stringsJoin .Status.Pipelines ", " }} |
+{{- if len .Status.Stability }}
+| Status | |
+| ------------- |-----------|
+{{- $class := .Status.Class }}
+{{- $idx := 0 }}
+{{- range $stability, $value := .Status.Stability }}
+| {{ if not $idx }}Stability{{ else }} {{ end }} | [{{ $stability }}]{{ if ne $class "extension" }}: {{ stringsJoin $value ", " }} {{ end }} |
+{{- $idx = inc $idx }}
 {{- end }}
-| Distributions  | [{{ stringsJoin .Status.Distributions "], [" }}] |
+| Distributions | [{{ stringsJoin .Status.Distributions "], [" }}] |
 {{- if .Status.Warnings }}
-| Warnings | [{{ stringsJoin .Status.Warnings ", " }}](#warnings) |
+| Warnings | [{{ stringsJoin .Status.Warnings ", " }}](#warnings) |
+{{- end }}
+{{range $stability, $val := .Status.Stability}}
+[{{ $stability }}]: https://github.com/open-telemetry/opentelemetry-collector#{{ $stability }}
 {{- end }}
-
-[{{ .Status.Stability }}]: https://github.com/open-telemetry/opentelemetry-collector#{{ .Status.Stability }}
 {{- range .Status.Distributions }}
 [{{.}}]: {{ distroURL . }}
 {{- end }}

diff --git a/cmd/mdatagen/templates/status.go.tmpl b/cmd/mdatagen/templates/status.go.tmpl
@@ -8,5 +8,9 @@ import (
 
 const (
  Type = "{{ .Type }}"
- Stability = component.StabilityLevel{{ casesTitle .Status.Stability }}
+ {{- range $stability, $signals := .Status.Stability }}
+ {{- range $signal := $signals }} 
+ {{ casesTitle $signal }}Stability = component.StabilityLevel{{ casesTitle $stability }}
+ {{- end }}
+ {{- end }}
 )
diff --git a/cmd/mdatagen/testdata/readme_with_multiple_signals.md b/cmd/mdatagen/testdata/readme_with_multiple_signals.md
@@ -0,0 +1,15 @@
+# Some component
+
+<!-- status autogenerated section -->
+| Status | |
+| ------------- |-----------|
+| Stability | [alpha]: logs |
+| | [beta]: metrics |
+| Distributions | [contrib] |
+
+[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
+[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
+
+Some info about a component
diff --git a/cmd/mdatagen/testdata/readme_with_status.md b/cmd/mdatagen/testdata/readme_with_status.md
@@ -1,11 +1,10 @@
 # Some component
 
 <!-- status autogenerated section -->
-| Status | |
-| ------------------------ |-----------|
-| Stability | [beta] |
-| Supported pipeline types | metrics |
-| Distributions | [contrib] |
+| Status | |
+| ------------- |-----------|
+| Stability | [beta]: metrics |
+| Distributions | [contrib] |
 
 [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

diff --git a/cmd/mdatagen/testdata/readme_with_status_extension.md b/cmd/mdatagen/testdata/readme_with_status_extension.md
@@ -1,10 +1,10 @@
 # Some component
 
 <!-- status autogenerated section -->
-| Status  | |
-| ------------------------ |-----------|
-| Stability  | [beta]  |
-| Distributions  | [contrib] |
+| Status | |
+| ------------- |-----------|
+| Stability | [beta] |
+| Distributions | [contrib] |
 
 [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

diff --git a/cmd/mdatagen/testdata/readme_with_warnings.md b/cmd/mdatagen/testdata/readme_with_warnings.md
@@ -1,12 +1,11 @@
 # Some component
 
 <!-- status autogenerated section -->
-| Status | |
-| ------------------------ |-----------|
-| Stability | [beta] |
-| Supported pipeline types | metrics |
-| Distributions | [contrib] |
-| Warnings | [warning1](#warnings) |
+| Status | |
+| ------------- |-----------|
+| Stability | [beta]: metrics |
+| Distributions | [contrib] |
+| Warnings | [warning1](#warnings) |
 
 [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

diff --git a/exporter/awss3exporter/README.md b/exporter/awss3exporter/README.md
@@ -1,11 +1,10 @@
 # AWS S3 Exporter for OpenTelemetry Collector
 
 <!-- status autogenerated section -->
-| Status | |
-| ------------------------ |-----------|
-| Stability | [alpha] |
-| Supported pipeline types | logs, metrics, traces |
-| Distributions | [contrib] |
+| Status | |
+| ------------- |-----------|
+| Stability | [alpha]: traces, metrics, logs |
+| Distributions | [contrib] |
 
 [alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

diff --git a/exporter/awss3exporter/factory.go b/exporter/awss3exporter/factory.go
@@ -29,9 +29,9 @@ func NewFactory() exporter.Factory {
  return exporter.NewFactory(
  metadata.Type,
  createDefaultConfig,
- exporter.WithTraces(createTracesExporter, metadata.Stability),
- exporter.WithLogs(createLogsExporter, metadata.Stability),
- exporter.WithMetrics(createMetricsExporter, metadata.Stability),
+ exporter.WithTraces(createTracesExporter, metadata.TracesStability),
+ exporter.WithLogs(createLogsExporter, metadata.LogsStability),
+ exporter.WithMetrics(createMetricsExporter, metadata.MetricsStability),
  )
 }
 

diff --git a/exporter/awss3exporter/internal/metadata/generated_status.go b/exporter/awss3exporter/internal/metadata/generated_status.go
diff --git a/exporter/awss3exporter/metadata.yaml b/exporter/awss3exporter/metadata.yaml
@@ -2,6 +2,6 @@ type: awss3
 
 status:
  class: exporter
- stability: alpha
- pipelines: [logs, metrics, traces]
+ stability:
+  alpha: [traces, metrics, logs]
  distributions: [contrib]
diff --git a/exporter/cassandraexporter/factory.go b/exporter/cassandraexporter/factory.go
@@ -28,8 +28,8 @@ import (
 func NewFactory() exporter.Factory {
  return exporter.NewFactory(metadata.Type,
  createDefaultConfig,
- exporter.WithTraces(createTracesExporter, metadata.Stability),
- exporter.WithLogs(createLogsExporter, metadata.Stability),
+ exporter.WithTraces(createTracesExporter, metadata.TracesStability),
+ exporter.WithLogs(createLogsExporter, metadata.LogsStability),
  )
 }
 

diff --git a/exporter/cassandraexporter/internal/metadata/generated_status.go b/exporter/cassandraexporter/internal/metadata/generated_status.go
diff --git a/exporter/cassandraexporter/metadata.yaml b/exporter/cassandraexporter/metadata.yaml
@@ -2,7 +2,7 @@ type: cassandra
 
 status:
  class: exporter
- stability: alpha
- pipelines: [logs, traces]
+ stability:
+  alpha: [traces, logs]
  distributions: [contrib]
 
diff --git a/exporter/lokiexporter/README.md b/exporter/lokiexporter/README.md
@@ -1,11 +1,10 @@
 # Loki Exporter
 
 <!-- status autogenerated section -->
-| Status | |
-| ------------------------ |-----------|
-| Stability | [beta] |
-| Supported pipeline types | logs |
-| Distributions | [contrib] |
+| Status | |
+| ------------- |-----------|
+| Stability | [beta]: logs |
+| Distributions | [contrib] |
 
 [beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
 [contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib

diff --git a/exporter/lokiexporter/factory.go b/exporter/lokiexporter/factory.go
@@ -34,7 +34,7 @@ func NewFactory() exporter.Factory {
  return exporter.NewFactory(
  metadata.Type,
  createDefaultConfig,
- exporter.WithLogs(createLogsExporter, metadata.Stability),
+ exporter.WithLogs(createLogsExporter, metadata.LogsStability),
  )
 }
 

diff --git a/exporter/lokiexporter/internal/metadata/generated_status.go b/exporter/lokiexporter/internal/metadata/generated_status.go
diff --git a/exporter/lokiexporter/metadata.yaml b/exporter/lokiexporter/metadata.yaml
@@ -2,6 +2,6 @@ type: loki
 
 status:
  class: exporter
- stability: beta
- pipelines: [logs]
+ stability:
+  beta: [logs]
  distributions: [contrib]