[receiver/dockerstats] use generated status header (#22767)

This PR updates the component to generate the status table using mdatagen. Linked issue: #21213 Signed-off-by: Alex Boten <aboten@lightstep.com>
open-telemetry · May 25, 2023 · fbd9a99 · fbd9a99
1 parent a74f8e5
commit fbd9a99
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 26 deletions.
diff --git a/receiver/dockerstatsreceiver/README.md b/receiver/dockerstatsreceiver/README.md
@@ -1,10 +1,16 @@
 # Docker Stats Receiver
 
-| Status                   |                               |
-| ------------------------ |-------------------------------|
-| Stability                | [alpha]                       |
-| Supported pipeline types | metrics                       |
-| Distributions            | [contrib], [observiq], [sumo] |
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [alpha]: metrics   |
+| Distributions | [contrib], [observiq], [sumo] |
+
+[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+[observiq]: https://github.com/observIQ/observiq-otel-collector
+[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
+<!-- end autogenerated section -->
 
 The Docker Stats receiver queries the local Docker daemon's container stats API for
 all desired running containers on a configured interval.  These stats are for container
@@ -64,11 +70,6 @@ receivers:
 The full list of settings exposed for this receiver are documented [here](./config.go)
 with detailed sample configurations [here](./testdata/config.yaml).
 
-[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
-[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
-[observiq]: https://github.com/observIQ/observiq-otel-collector
-[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
-
 ### Migrating from ScraperV1 to ScraperV2
 
 *Note: These changes are now in effect and ScraperV1 have been removed as of v0.71.*

diff --git a/receiver/dockerstatsreceiver/config_test.go b/receiver/dockerstatsreceiver/config_test.go
@@ -27,11 +27,11 @@ func TestLoadConfig(t *testing.T) {
 		expected component.Config
 	}{
 		{
-			id:       component.NewIDWithName(typeStr, ""),
+			id:       component.NewIDWithName(metadata.Type, ""),
 			expected: createDefaultConfig(),
 		},
 		{
-			id: component.NewIDWithName(typeStr, "allsettings"),
+			id: component.NewIDWithName(metadata.Type, "allsettings"),
 			expected: &Config{
 				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
 					CollectionInterval: 2 * time.Second,

diff --git a/receiver/dockerstatsreceiver/documentation.md b/receiver/dockerstatsreceiver/documentation.md
@@ -1,6 +1,6 @@
 [comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
 
-# dockerstatsreceiver
+# docker_stats
 
 ## Default Metrics
 

diff --git a/receiver/dockerstatsreceiver/factory.go b/receiver/dockerstatsreceiver/factory.go
@@ -16,11 +16,6 @@ import (
 	"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/dockerstatsreceiver/internal/metadata"
 )
 
-const (
-	typeStr   = "docker_stats"
-	stability = component.StabilityLevelAlpha
-)
-
 var _ = featuregate.GlobalRegistry().MustRegister(
 	"receiver.dockerstats.useScraperV2",
 	featuregate.StageStable,
@@ -31,13 +26,13 @@ var _ = featuregate.GlobalRegistry().MustRegister(
 
 func NewFactory() rcvr.Factory {
 	return rcvr.NewFactory(
-		typeStr,
+		metadata.Type,
 		createDefaultConfig,
-		rcvr.WithMetrics(createMetricsReceiver, stability))
+		rcvr.WithMetrics(createMetricsReceiver, metadata.MetricsStability))
 }
 
 func createDefaultConfig() component.Config {
-	scs := scraperhelper.NewDefaultScraperControllerSettings(typeStr)
+	scs := scraperhelper.NewDefaultScraperControllerSettings(metadata.Type)
 	scs.CollectionInterval = 10 * time.Second
 	return &Config{
 		ScraperControllerSettings: scs,
@@ -57,7 +52,7 @@ func createMetricsReceiver(
 	dockerConfig := config.(*Config)
 	dsr := newReceiver(params, dockerConfig)
 
-	scrp, err := scraperhelper.NewScraper(typeStr, dsr.scrapeV2, scraperhelper.WithStart(dsr.start))
+	scrp, err := scraperhelper.NewScraper(metadata.Type, dsr.scrapeV2, scraperhelper.WithStart(dsr.start))
 	if err != nil {
 		return nil, err
 	}

diff --git a/receiver/dockerstatsreceiver/internal/metadata/generated_config.go b/receiver/dockerstatsreceiver/internal/metadata/generated_config.go
diff --git a/receiver/dockerstatsreceiver/internal/metadata/generated_status.go b/receiver/dockerstatsreceiver/internal/metadata/generated_status.go
diff --git a/receiver/dockerstatsreceiver/metadata.yaml b/receiver/dockerstatsreceiver/metadata.yaml
@@ -1,4 +1,10 @@
-type: dockerstatsreceiver
+type: docker_stats
+
+status:
+  class: receiver
+  stability:
+    alpha: [metrics]
+  distributions: [contrib, observiq, sumo]
 
 sem_conv_version: 1.6.1