diff --git a/.chloggen/config.yaml b/.chloggen/config.yaml index 785d07bad76aa..1abc1c3d818f0 100644 --- a/.chloggen/config.yaml +++ b/.chloggen/config.yaml @@ -234,7 +234,7 @@ components: - receiver/active_directory_ds - receiver/aerospike - receiver/apache - - receiver/apachespark + - receiver/apache_spark - receiver/awscloudwatch - receiver/awscontainerinsightreceiver - receiver/awsecscontainermetrics diff --git a/.chloggen/rename-apache-spark-receiver.yaml b/.chloggen/rename-apache-spark-receiver.yaml new file mode 100644 index 0000000000000..38e87734e4760 --- /dev/null +++ b/.chloggen/rename-apache-spark-receiver.yaml @@ -0,0 +1,13 @@ +# Use this changelog template to create an entry for release notes. + +change_type: deprecation + +component: receiver/apache_spark + +note: Rename `apachespark` receiver to `apache_spark` with deprecated alias `apachespark` + +issues: [45339] + +subtext: + +change_logs: [user] diff --git a/receiver/apachesparkreceiver/README.md b/receiver/apachesparkreceiver/README.md index e9522e24b5df5..da1f92b699691 100644 --- a/receiver/apachesparkreceiver/README.md +++ b/receiver/apachesparkreceiver/README.md @@ -30,6 +30,9 @@ This receiver supports Apache Spark versions: ## Configuration +> **Note:** This receiver was renamed from `apachespark` to `apache_spark` to match the snake_case naming convention. +> The deprecated component type `apachespark` is still accepted as an alias and will log a deprecation warning. + These configuration options are for connecting to an Apache Spark application. The following settings are optional: @@ -43,7 +46,7 @@ The following settings are optional: ```yaml receivers: - apachespark: + apache_spark: collection_interval: 60s endpoint: http://localhost:4040 application_names: diff --git a/receiver/apachesparkreceiver/documentation.md b/receiver/apachesparkreceiver/documentation.md index 8ad025080870d..219995aefc9e5 100644 --- a/receiver/apachesparkreceiver/documentation.md +++ b/receiver/apachesparkreceiver/documentation.md @@ -1,6 +1,6 @@ [comment]: <> (Code generated by mdatagen. DO NOT EDIT.) -# apachespark +# apache_spark ## Default Metrics diff --git a/receiver/apachesparkreceiver/factory.go b/receiver/apachesparkreceiver/factory.go index 010933c6b62e1..add77fe1addae 100644 --- a/receiver/apachesparkreceiver/factory.go +++ b/receiver/apachesparkreceiver/factory.go @@ -11,6 +11,7 @@ import ( "go.opentelemetry.io/collector/config/confighttp" "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/receiver" + "go.opentelemetry.io/collector/receiver/xreceiver" "go.opentelemetry.io/collector/scraper" "go.opentelemetry.io/collector/scraper/scraperhelper" @@ -21,10 +22,12 @@ var errConfigNotSpark = errors.New("config was not a Spark receiver config") // NewFactory creates a new receiver factory for Spark func NewFactory() receiver.Factory { - return receiver.NewFactory( + return xreceiver.NewFactory( metadata.Type, createDefaultConfig, - receiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability)) + xreceiver.WithMetrics(createMetricsReceiver, metadata.MetricsStability), + xreceiver.WithDeprecatedTypeAlias(metadata.DeprecatedType), + ) } // createDefaultConfig creates a config for Spark with as many default values as possible diff --git a/receiver/apachesparkreceiver/generated_component_test.go b/receiver/apachesparkreceiver/generated_component_test.go index 03a2a2c2e6158..e29d3711711a4 100644 --- a/receiver/apachesparkreceiver/generated_component_test.go +++ b/receiver/apachesparkreceiver/generated_component_test.go @@ -15,7 +15,7 @@ import ( "go.opentelemetry.io/collector/receiver/receivertest" ) -var typ = component.MustNewType("apachespark") +var typ = component.MustNewType("apache_spark") func TestComponentFactoryType(t *testing.T) { require.Equal(t, typ, NewFactory().Type()) diff --git a/receiver/apachesparkreceiver/go.mod b/receiver/apachesparkreceiver/go.mod index 0712e4a089998..7b49553fe42ce 100644 --- a/receiver/apachesparkreceiver/go.mod +++ b/receiver/apachesparkreceiver/go.mod @@ -19,6 +19,7 @@ require ( go.opentelemetry.io/collector/pdata v1.56.1-0.20260415114935-307e3abdbae9 go.opentelemetry.io/collector/receiver v1.56.1-0.20260415114935-307e3abdbae9 go.opentelemetry.io/collector/receiver/receivertest v0.150.1-0.20260415114935-307e3abdbae9 + go.opentelemetry.io/collector/receiver/xreceiver v0.150.1-0.20260415114935-307e3abdbae9 go.opentelemetry.io/collector/scraper v0.150.1-0.20260415114935-307e3abdbae9 go.opentelemetry.io/collector/scraper/scraperhelper v0.150.1-0.20260415114935-307e3abdbae9 go.uber.org/goleak v1.3.0 @@ -107,7 +108,6 @@ require ( go.opentelemetry.io/collector/pipeline v1.56.1-0.20260415114935-307e3abdbae9 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.150.1-0.20260415114935-307e3abdbae9 // indirect go.opentelemetry.io/collector/receiver/receiverhelper v0.150.1-0.20260415114935-307e3abdbae9 // indirect - go.opentelemetry.io/collector/receiver/xreceiver v0.150.1-0.20260415114935-307e3abdbae9 // indirect go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.68.0 // indirect go.opentelemetry.io/otel v1.43.0 // indirect go.opentelemetry.io/otel/metric v1.43.0 // indirect diff --git a/receiver/apachesparkreceiver/internal/metadata/config.schema.yaml b/receiver/apachesparkreceiver/internal/metadata/config.schema.yaml index cbabcb4fc8acf..92bb02554b92f 100644 --- a/receiver/apachesparkreceiver/internal/metadata/config.schema.yaml +++ b/receiver/apachesparkreceiver/internal/metadata/config.schema.yaml @@ -1,7 +1,7 @@ # Code generated by mdatagen. DO NOT EDIT. $defs: metrics_config: - description: MetricsConfig provides config for apachespark metrics. + description: MetricsConfig provides config for apache_spark metrics. type: object properties: spark.driver.block_manager.disk.usage: @@ -776,7 +776,7 @@ $defs: type: boolean default: true resource_attributes_config: - description: ResourceAttributesConfig provides config for apachespark resource attributes. + description: ResourceAttributesConfig provides config for apache_spark resource attributes. type: object properties: spark.application.id: @@ -882,7 +882,7 @@ $defs: items: $ref: go.opentelemetry.io/collector/filter.config metrics_builder_config: - description: MetricsBuilderConfig is a configuration for apachespark metrics builder. + description: MetricsBuilderConfig is a configuration for apache_spark metrics builder. type: object properties: metrics: diff --git a/receiver/apachesparkreceiver/internal/metadata/generated_config.go b/receiver/apachesparkreceiver/internal/metadata/generated_config.go index 128301e14e9c3..89d5e7d32520a 100644 --- a/receiver/apachesparkreceiver/internal/metadata/generated_config.go +++ b/receiver/apachesparkreceiver/internal/metadata/generated_config.go @@ -1834,7 +1834,7 @@ func (ms *SparkStageTaskResultSizeMetricConfig) Unmarshal(parser *confmap.Conf) return nil } -// MetricsConfig provides config for apachespark metrics. +// MetricsConfig provides config for apache_spark metrics. type MetricsConfig struct { SparkDriverBlockManagerDiskUsage SparkDriverBlockManagerDiskUsageMetricConfig `mapstructure:"spark.driver.block_manager.disk.usage"` SparkDriverBlockManagerMemoryUsage SparkDriverBlockManagerMemoryUsageMetricConfig `mapstructure:"spark.driver.block_manager.memory.usage"` @@ -2161,7 +2161,7 @@ func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error { return nil } -// ResourceAttributesConfig provides config for apachespark resource attributes. +// ResourceAttributesConfig provides config for apache_spark resource attributes. type ResourceAttributesConfig struct { SparkApplicationID ResourceAttributeConfig `mapstructure:"spark.application.id"` SparkApplicationName ResourceAttributeConfig `mapstructure:"spark.application.name"` @@ -2194,7 +2194,7 @@ func DefaultResourceAttributesConfig() ResourceAttributesConfig { } } -// MetricsBuilderConfig is a configuration for apachespark metrics builder. +// MetricsBuilderConfig is a configuration for apache_spark metrics builder. type MetricsBuilderConfig struct { Metrics MetricsConfig `mapstructure:"metrics"` ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"` diff --git a/receiver/apachesparkreceiver/internal/metadata/generated_status.go b/receiver/apachesparkreceiver/internal/metadata/generated_status.go index f55425ad9509a..7e590aacc0f2c 100644 --- a/receiver/apachesparkreceiver/internal/metadata/generated_status.go +++ b/receiver/apachesparkreceiver/internal/metadata/generated_status.go @@ -7,8 +7,9 @@ import ( ) var ( - Type = component.MustNewType("apachespark") - ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/apachesparkreceiver" + Type = component.MustNewType("apache_spark") + DeprecatedType = component.MustNewType("apachespark") + ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/apachesparkreceiver" ) const ( diff --git a/receiver/apachesparkreceiver/metadata.yaml b/receiver/apachesparkreceiver/metadata.yaml index e739996173ae2..2616556586e26 100644 --- a/receiver/apachesparkreceiver/metadata.yaml +++ b/receiver/apachesparkreceiver/metadata.yaml @@ -1,5 +1,6 @@ display_name: Apache Spark Receiver -type: apachespark +type: apache_spark +deprecated_type: apachespark description: | The Apache Spark Receiver fetches metrics for an Apache Spark cluster through the Apache Spark REST API - specifically, diff --git a/receiver/apachesparkreceiver/testdata/config.yaml b/receiver/apachesparkreceiver/testdata/config.yaml index 23e5ebaa6d5af..8a1f1859861d6 100644 --- a/receiver/apachesparkreceiver/testdata/config.yaml +++ b/receiver/apachesparkreceiver/testdata/config.yaml @@ -1,6 +1,6 @@ # ./bin/otelcontribcol_darwin_arm64 --config ./receiver/apachesparkreceiver/testdata/config.yaml receivers: - apachespark: + apache_spark: collection_interval: 15s exporters: file: @@ -9,5 +9,5 @@ exporters: service: pipelines: metrics: - receivers: [apachespark] + receivers: [apache_spark] exporters: [file] diff --git a/reports/distributions/contrib.yaml b/reports/distributions/contrib.yaml index 51141bb3c3f7c..0ef4bc12377fb 100644 --- a/reports/distributions/contrib.yaml +++ b/reports/distributions/contrib.yaml @@ -136,7 +136,7 @@ components: - active_directory_ds - aerospike - apache - - apachespark + - apache_spark - awscloudwatch - awscontainerinsightreceiver - awsecscontainermetrics