[chore] Add status metadata to signalfx exporter (open-telemetry#21258)

fluxninja · May 1, 2023 · c97f839 · c97f839
1 parent 11096ef
commit c97f839
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 19 deletions.
diff --git a/exporter/signalfxexporter/README.md b/exporter/signalfxexporter/README.md
@@ -1,10 +1,15 @@
 # SignalFx Metrics Exporter
 
-| Status | |
-| ------------------------ |-------------------------------------------------------------------|
-| Stability | [beta] |
-| Supported pipeline types | logs (events), metrics, traces (trace to metric correlation only) |
-| Distributions | [contrib] |
+<!-- status autogenerated section -->
+| Status | |
+| ------------------------ |-----------|
+| Stability | [beta] |
+| Supported pipeline types | logs, metrics, traces |
+| 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
+<!-- end autogenerated section -->
 
 This exporter can be used to send metrics, events, and trace correlation to SignalFx.
 
@@ -290,6 +295,3 @@ Several helper files are leveraged to provide additional capabilities automatica
 - [HTTP settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md)
 - [TLS and mTLS settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)
 - [Queuing, retry and timeout settings](https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/exporterhelper/README.md)
-
-[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/signalfxexporter/config_test.go b/exporter/signalfxexporter/config_test.go
@@ -33,6 +33,7 @@ import (
  "go.uber.org/zap"
 
  "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/correlation"
+ "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/metadata"
  "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/translation"
  "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/translation/dpfilters"
  "github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
@@ -58,11 +59,11 @@ func TestLoadConfig(t *testing.T) {
  expected *Config
  }{
  {
- id: component.NewIDWithName(typeStr, ""),
+ id: component.NewIDWithName(metadata.Type, ""),
  expected: defaultCfg,
  },
  {
- id: component.NewIDWithName(typeStr, "allsettings"),
+ id: component.NewIDWithName(metadata.Type, "allsettings"),
  expected: &Config{
  AccessToken: "testToken",
  Realm: "us1",

diff --git a/exporter/signalfxexporter/doc.go b/exporter/signalfxexporter/doc.go
@@ -12,5 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//go:generate mdatagen metadata.yaml
+
 // Package signalfxexporter implements an exporter that sends data to SignalFx.
 package signalfxexporter // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter"
diff --git a/exporter/signalfxexporter/factory.go b/exporter/signalfxexporter/factory.go
@@ -27,16 +27,12 @@ import (
  "go.uber.org/zap"
 
  "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/correlation"
+ "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/signalfxexporter/internal/metadata"
  "github.com/open-telemetry/opentelemetry-collector-contrib/internal/splunk"
  "github.com/open-telemetry/opentelemetry-collector-contrib/pkg/batchperresourceattr"
 )
 
 const (
- // The value of "type" key in configuration.
- typeStr = "signalfx"
- // The stability level of the exporter.
- stability = component.StabilityLevelBeta
-
  defaultHTTPTimeout = time.Second * 5
 
  defaultMaxConns = 100
@@ -45,11 +41,11 @@ const (
 // NewFactory creates a factory for SignalFx exporter.
 func NewFactory() exporter.Factory {
  return exporter.NewFactory(
- typeStr,
+ metadata.Type,
  createDefaultConfig,
- exporter.WithMetrics(createMetricsExporter, stability),
- exporter.WithLogs(createLogsExporter, stability),
- exporter.WithTraces(createTracesExporter, stability),
+ exporter.WithMetrics(createMetricsExporter, metadata.Stability),
+ exporter.WithLogs(createLogsExporter, metadata.Stability),
+ exporter.WithTraces(createTracesExporter, metadata.Stability),
  )
 }
 

diff --git a/exporter/signalfxexporter/internal/metadata/generated_status.go b/exporter/signalfxexporter/internal/metadata/generated_status.go
diff --git a/exporter/signalfxexporter/metadata.yaml b/exporter/signalfxexporter/metadata.yaml
@@ -0,0 +1,7 @@
+type: signalfx
+
+status:
+ class: exporter
+ stability: beta
+ pipelines: [logs, metrics, traces]
+ distributions: [contrib]