From bf3833cbf94a5657ae0ce0aea413c230355c3c56 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Sun, 30 Apr 2023 22:58:10 -0700 Subject: [PATCH 1/2] [chore] use type in apache receiver --- receiver/apachereceiver/config_test.go | 4 +++- receiver/apachereceiver/documentation.md | 2 +- receiver/apachereceiver/factory.go | 6 ++---- .../apachereceiver/internal/metadata/generated_config.go | 6 +++--- .../apachereceiver/internal/metadata/generated_status.go | 2 +- receiver/apachereceiver/metadata.yaml | 2 +- receiver/apachereceiver/testdata/integration/expected.yaml | 2 +- receiver/apachereceiver/testdata/scraper/expected.yaml | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/receiver/apachereceiver/config_test.go b/receiver/apachereceiver/config_test.go index 8b51c3f9196d..53fccfbcd28b 100644 --- a/receiver/apachereceiver/config_test.go +++ b/receiver/apachereceiver/config_test.go @@ -22,6 +22,8 @@ import ( "github.com/stretchr/testify/require" "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/confmap/confmaptest" + + "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/apachereceiver/internal/metadata" ) func TestValidate(t *testing.T) { @@ -97,7 +99,7 @@ func TestLoadConfig(t *testing.T) { factory := NewFactory() cfg := factory.CreateDefaultConfig() - sub, err := cm.Sub(component.NewIDWithName(typeStr, "").String()) + sub, err := cm.Sub(component.NewIDWithName(metadata.Type, "").String()) require.NoError(t, err) require.NoError(t, component.UnmarshalConfig(sub, cfg)) diff --git a/receiver/apachereceiver/documentation.md b/receiver/apachereceiver/documentation.md index 283b4c3d3476..a0514c8405d2 100644 --- a/receiver/apachereceiver/documentation.md +++ b/receiver/apachereceiver/documentation.md @@ -1,6 +1,6 @@ [comment]: <> (Code generated by mdatagen. DO NOT EDIT.) -# apachereceiver +# apache ## Default Metrics diff --git a/receiver/apachereceiver/factory.go b/receiver/apachereceiver/factory.go index 160791c9a0b3..134717bb83fd 100644 --- a/receiver/apachereceiver/factory.go +++ b/receiver/apachereceiver/factory.go @@ -29,8 +29,6 @@ import ( ) const ( - typeStr = "apache" - httpDefaultPort = "80" httpsDefaultPort = "443" ) @@ -38,7 +36,7 @@ const ( // NewFactory creates a factory for apache receiver. func NewFactory() receiver.Factory { return receiver.NewFactory( - typeStr, + metadata.Type, createDefaultConfig, receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability)) } @@ -86,7 +84,7 @@ func createMetricsReceiver( } ns := newApacheScraper(params, cfg, serverName, port) - scraper, err := scraperhelper.NewScraper(typeStr, ns.scrape, scraperhelper.WithStart(ns.start)) + scraper, err := scraperhelper.NewScraper(metadata.Type, ns.scrape, scraperhelper.WithStart(ns.start)) if err != nil { return nil, err } diff --git a/receiver/apachereceiver/internal/metadata/generated_config.go b/receiver/apachereceiver/internal/metadata/generated_config.go index e59757a5432d..74c9818683f8 100644 --- a/receiver/apachereceiver/internal/metadata/generated_config.go +++ b/receiver/apachereceiver/internal/metadata/generated_config.go @@ -23,7 +23,7 @@ func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error { return nil } -// MetricsConfig provides config for apachereceiver metrics. +// MetricsConfig provides config for apache metrics. type MetricsConfig struct { ApacheCPULoad MetricConfig `mapstructure:"apache.cpu.load"` ApacheCPUTime MetricConfig `mapstructure:"apache.cpu.time"` @@ -85,7 +85,7 @@ type ResourceAttributeConfig struct { Enabled bool `mapstructure:"enabled"` } -// ResourceAttributesConfig provides config for apachereceiver resource attributes. +// ResourceAttributesConfig provides config for apache resource attributes. type ResourceAttributesConfig struct { ApacheServerName ResourceAttributeConfig `mapstructure:"apache.server.name"` ApacheServerPort ResourceAttributeConfig `mapstructure:"apache.server.port"` @@ -102,7 +102,7 @@ func DefaultResourceAttributesConfig() ResourceAttributesConfig { } } -// MetricsBuilderConfig is a configuration for apachereceiver metrics builder. +// MetricsBuilderConfig is a configuration for apache metrics builder. type MetricsBuilderConfig struct { Metrics MetricsConfig `mapstructure:"metrics"` ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"` diff --git a/receiver/apachereceiver/internal/metadata/generated_status.go b/receiver/apachereceiver/internal/metadata/generated_status.go index 6166a12a91eb..e736a3a1c284 100644 --- a/receiver/apachereceiver/internal/metadata/generated_status.go +++ b/receiver/apachereceiver/internal/metadata/generated_status.go @@ -7,6 +7,6 @@ import ( ) const ( - Type = "apachereceiver" + Type = "apache" MetricsStability = component.StabilityLevelBeta ) diff --git a/receiver/apachereceiver/metadata.yaml b/receiver/apachereceiver/metadata.yaml index 0ebcc4b6a73f..2e07220b1b2c 100644 --- a/receiver/apachereceiver/metadata.yaml +++ b/receiver/apachereceiver/metadata.yaml @@ -1,4 +1,4 @@ -type: apachereceiver +type: apache status: class: receiver diff --git a/receiver/apachereceiver/testdata/integration/expected.yaml b/receiver/apachereceiver/testdata/integration/expected.yaml index b658dedcb444..1186c98cbbfe 100644 --- a/receiver/apachereceiver/testdata/integration/expected.yaml +++ b/receiver/apachereceiver/testdata/integration/expected.yaml @@ -215,5 +215,5 @@ resourceMetrics: timeUnixNano: "1632495518500962000" unit: '{workers}' scope: - name: otelcol/apachereceiver + name: otelcol/apache version: latest diff --git a/receiver/apachereceiver/testdata/scraper/expected.yaml b/receiver/apachereceiver/testdata/scraper/expected.yaml index 43fc0003c7ef..f8259673ea2f 100644 --- a/receiver/apachereceiver/testdata/scraper/expected.yaml +++ b/receiver/apachereceiver/testdata/scraper/expected.yaml @@ -215,5 +215,5 @@ resourceMetrics: timeUnixNano: "1632495518500962000" unit: '{workers}' scope: - name: otelcol/apachereceiver + name: otelcol/apache version: latest From 9081c7466b3e5ffeb3a5b05ef20db6229e2500e9 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Wed, 10 May 2023 20:38:32 -0700 Subject: [PATCH 2/2] use latest generator --- receiver/apachereceiver/testdata/integration/expected.yaml | 2 +- receiver/apachereceiver/testdata/scraper/expected.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/receiver/apachereceiver/testdata/integration/expected.yaml b/receiver/apachereceiver/testdata/integration/expected.yaml index 1186c98cbbfe..b658dedcb444 100644 --- a/receiver/apachereceiver/testdata/integration/expected.yaml +++ b/receiver/apachereceiver/testdata/integration/expected.yaml @@ -215,5 +215,5 @@ resourceMetrics: timeUnixNano: "1632495518500962000" unit: '{workers}' scope: - name: otelcol/apache + name: otelcol/apachereceiver version: latest diff --git a/receiver/apachereceiver/testdata/scraper/expected.yaml b/receiver/apachereceiver/testdata/scraper/expected.yaml index f8259673ea2f..43fc0003c7ef 100644 --- a/receiver/apachereceiver/testdata/scraper/expected.yaml +++ b/receiver/apachereceiver/testdata/scraper/expected.yaml @@ -215,5 +215,5 @@ resourceMetrics: timeUnixNano: "1632495518500962000" unit: '{workers}' scope: - name: otelcol/apache + name: otelcol/apachereceiver version: latest