[receiver/expvar] use generated status header (open-telemetry#22765)

This PR updates the component to generate the status table using mdatagen. Linked issue: open-telemetry#21213 Signed-off-by: Alex Boten <[email protected]>
SolaceDev · May 25, 2023 · 3744b55 · 3744b55
1 parent ab650dd
commit 3744b55
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 26 deletions.
diff --git a/receiver/expvarreceiver/README.md b/receiver/expvarreceiver/README.md
@@ -1,10 +1,15 @@
 # Expvar Receiver
 
-| Status                   |                   |
-| ------------------------ |-------------------|
-| Stability                | [alpha]           |
-| Supported pipeline types | metrics           |
-| Distributions            | [contrib], [sumo] |
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [alpha]: metrics   |
+| Distributions | [contrib], [sumo] |
+
+[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
+<!-- end autogenerated section -->
 
 An Expvar Receiver scrapes metrics from [expvar](https://pkg.go.dev/expvar), 
 which exposes data in JSON format from an HTTP endpoint. The metrics are 
@@ -50,7 +55,3 @@ receivers:
       process.runtime.memstats.mallocs:
         enabled: false
 ```
-
-[alpha]:https://github.com/open-telemetry/opentelemetry-collector#alpha
-[contrib]:https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
-[sumo]: https://github.com/SumoLogic/sumologic-otel-collector
diff --git a/receiver/expvarreceiver/config_test.go b/receiver/expvarreceiver/config_test.go
@@ -34,11 +34,11 @@ func TestLoadConfig(t *testing.T) {
 		errorMessage string
 	}{
 		{
-			id:       component.NewIDWithName(typeStr, "default"),
+			id:       component.NewIDWithName(metadata.Type, "default"),
 			expected: factory.CreateDefaultConfig(),
 		},
 		{
-			id: component.NewIDWithName(typeStr, "custom"),
+			id: component.NewIDWithName(metadata.Type, "custom"),
 			expected: &Config{
 				ScraperControllerSettings: scraperhelper.ScraperControllerSettings{
 					CollectionInterval: 30 * time.Second,
@@ -51,15 +51,15 @@ func TestLoadConfig(t *testing.T) {
 			},
 		},
 		{
-			id:           component.NewIDWithName(typeStr, "bad_schemeless_endpoint"),
+			id:           component.NewIDWithName(metadata.Type, "bad_schemeless_endpoint"),
 			errorMessage: "scheme must be 'http' or 'https', but was 'localhost'",
 		},
 		{
-			id:           component.NewIDWithName(typeStr, "bad_hostless_endpoint"),
+			id:           component.NewIDWithName(metadata.Type, "bad_hostless_endpoint"),
 			errorMessage: "host not found in HTTP endpoint",
 		},
 		{
-			id:           component.NewIDWithName(typeStr, "bad_invalid_url"),
+			id:           component.NewIDWithName(metadata.Type, "bad_invalid_url"),
 			errorMessage: "endpoint is not a valid URL: parse \"#$%^&*()_\": invalid URL escape \"%^&\"",
 		},
 	}

diff --git a/receiver/expvarreceiver/doc.go b/receiver/expvarreceiver/doc.go
@@ -1,6 +1,6 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package expvarreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/expvarreceiver"
-
 //go:generate mdatagen metadata.yaml
+
+package expvarreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/expvarreceiver"
diff --git a/receiver/expvarreceiver/documentation.md b/receiver/expvarreceiver/documentation.md
@@ -1,6 +1,6 @@
 [comment]: <> (Code generated by mdatagen. DO NOT EDIT.)
 
-# expvarreceiver
+# expvar
 
 ## Default Metrics
 

diff --git a/receiver/expvarreceiver/factory.go b/receiver/expvarreceiver/factory.go
@@ -17,18 +17,16 @@ import (
 )
 
 const (
-	typeStr         = "expvar"
-	stability       = component.StabilityLevelBeta
 	defaultPath     = "/debug/vars"
 	defaultEndpoint = "http://localhost:8000" + defaultPath
 	defaultTimeout  = 3 * time.Second
 )
 
 func NewFactory() receiver.Factory {
 	return receiver.NewFactory(
-		typeStr,
+		metadata.Type,
 		newDefaultConfig,
-		receiver.WithMetrics(newMetricsReceiver, stability))
+		receiver.WithMetrics(newMetricsReceiver, metadata.MetricsStability))
 }
 
 func newMetricsReceiver(
@@ -41,7 +39,7 @@ func newMetricsReceiver(
 
 	expVar := newExpVarScraper(cfg, set)
 	scraper, err := scraperhelper.NewScraper(
-		typeStr,
+		metadata.Type,
 		expVar.scrape,
 		scraperhelper.WithStart(expVar.start),
 	)
@@ -59,7 +57,7 @@ func newMetricsReceiver(
 
 func newDefaultConfig() component.Config {
 	return &Config{
-		ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(typeStr),
+		ScraperControllerSettings: scraperhelper.NewDefaultScraperControllerSettings(metadata.Type),
 		HTTPClientSettings: confighttp.HTTPClientSettings{
 			Endpoint: defaultEndpoint,
 			Timeout:  defaultTimeout,

diff --git a/receiver/expvarreceiver/internal/metadata/generated_config.go b/receiver/expvarreceiver/internal/metadata/generated_config.go
diff --git a/receiver/expvarreceiver/internal/metadata/generated_status.go b/receiver/expvarreceiver/internal/metadata/generated_status.go
diff --git a/receiver/expvarreceiver/metadata.yaml b/receiver/expvarreceiver/metadata.yaml
@@ -1,4 +1,10 @@
-type: expvarreceiver
+type: expvar
+
+status:
+  class: receiver
+  stability:
+    alpha: [metrics]
+  distributions: [contrib, sumo]
 
 metrics:
   process.runtime.memstats.total_alloc: