diff --git a/.chloggen/config.yaml b/.chloggen/config.yaml index ee200277c080d..badae30897da8 100644 --- a/.chloggen/config.yaml +++ b/.chloggen/config.yaml @@ -331,7 +331,7 @@ components: - receiver/systemd - receiver/tcp_log - receiver/tcpcheck - - receiver/tlscheck + - receiver/tls_check - receiver/udp_log - receiver/vcenter - receiver/vcr diff --git a/.chloggen/rename-tls-check-receiver.yaml b/.chloggen/rename-tls-check-receiver.yaml new file mode 100644 index 0000000000000..1ac69be5a12be --- /dev/null +++ b/.chloggen/rename-tls-check-receiver.yaml @@ -0,0 +1,13 @@ +# Use this changelog template to create an entry for release notes. + +change_type: deprecation + +component: receiver/tls_check + +note: Rename `tlscheck` receiver to `tls_check` with deprecated alias `tlscheck` + +issues: [45339] + +subtext: + +change_logs: [user] diff --git a/receiver/tlscheckreceiver/README.md b/receiver/tlscheckreceiver/README.md index 8bb465126764b..c2b7f206f9f80 100644 --- a/receiver/tlscheckreceiver/README.md +++ b/receiver/tlscheckreceiver/README.md @@ -21,11 +21,14 @@ By default, the TLS Check Receiver will emit a single metric, `tlscheck.time_lef ## Example Configuration +> **Note:** This receiver was renamed from `tlscheck` to `tls_check` to match the snake_case naming convention. +> The deprecated component type `tlscheck` is still accepted as an alias and will log a deprecation warning. + Targets are configured as a remote endpoint accessed via TCP, a PEM-encoded certificate file stored locally on disk, or a Java-format keystore file (JKS or PKCS#12). ```yaml receivers: - tlscheck: + tls_check: targets: # Monitor a local PEM file (default when no file_format is set) - file_path: /etc/istio/certs/cert-chain.pem diff --git a/receiver/tlscheckreceiver/documentation.md b/receiver/tlscheckreceiver/documentation.md index b051576fa2f6d..285ba3b46c7b8 100644 --- a/receiver/tlscheckreceiver/documentation.md +++ b/receiver/tlscheckreceiver/documentation.md @@ -1,6 +1,6 @@ [comment]: <> (Code generated by mdatagen. DO NOT EDIT.) -# tlscheck +# tls_check ## Default Metrics diff --git a/receiver/tlscheckreceiver/factory.go b/receiver/tlscheckreceiver/factory.go index f99c39de43efc..fcdb8173d3596 100644 --- a/receiver/tlscheckreceiver/factory.go +++ b/receiver/tlscheckreceiver/factory.go @@ -10,6 +10,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/receiver" + "go.opentelemetry.io/collector/receiver/xreceiver" collectorscraper "go.opentelemetry.io/collector/scraper" "go.opentelemetry.io/collector/scraper/scraperhelper" @@ -19,10 +20,12 @@ import ( var errConfigNotTLSCheck = errors.New(`invalid config`) func NewFactory() receiver.Factory { - return receiver.NewFactory( + return xreceiver.NewFactory( metadata.Type, newDefaultConfig, - receiver.WithMetrics(newReceiver, metadata.MetricsStability)) + xreceiver.WithMetrics(newReceiver, metadata.MetricsStability), + xreceiver.WithDeprecatedTypeAlias(metadata.DeprecatedType), + ) } func newDefaultConfig() component.Config { diff --git a/receiver/tlscheckreceiver/generated_component_test.go b/receiver/tlscheckreceiver/generated_component_test.go index d0ff395d87bfe..42020ade50516 100644 --- a/receiver/tlscheckreceiver/generated_component_test.go +++ b/receiver/tlscheckreceiver/generated_component_test.go @@ -15,7 +15,7 @@ import ( "go.opentelemetry.io/collector/receiver/receivertest" ) -var typ = component.MustNewType("tlscheck") +var typ = component.MustNewType("tls_check") func TestComponentFactoryType(t *testing.T) { require.Equal(t, typ, NewFactory().Type()) diff --git a/receiver/tlscheckreceiver/go.mod b/receiver/tlscheckreceiver/go.mod index 312ed693e7576..52a2c24db837a 100644 --- a/receiver/tlscheckreceiver/go.mod +++ b/receiver/tlscheckreceiver/go.mod @@ -17,6 +17,7 @@ require ( go.opentelemetry.io/collector/pdata v1.55.1-0.20260408002112-999af6320692 go.opentelemetry.io/collector/receiver v1.55.1-0.20260408002112-999af6320692 go.opentelemetry.io/collector/receiver/receivertest v0.149.1-0.20260408002112-999af6320692 + go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260408002112-999af6320692 go.opentelemetry.io/collector/scraper v0.149.1-0.20260408002112-999af6320692 go.opentelemetry.io/collector/scraper/scraperhelper v0.149.1-0.20260408002112-999af6320692 go.uber.org/goleak v1.3.0 @@ -53,7 +54,6 @@ require ( go.opentelemetry.io/collector/pipeline v1.55.1-0.20260408002112-999af6320692 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.149.1-0.20260408002112-999af6320692 // indirect go.opentelemetry.io/collector/receiver/receiverhelper v0.149.1-0.20260408002112-999af6320692 // indirect - go.opentelemetry.io/collector/receiver/xreceiver v0.149.1-0.20260408002112-999af6320692 // indirect go.opentelemetry.io/otel v1.43.0 // indirect go.opentelemetry.io/otel/metric v1.43.0 // indirect go.opentelemetry.io/otel/sdk v1.43.0 // indirect diff --git a/receiver/tlscheckreceiver/internal/metadata/config.schema.yaml b/receiver/tlscheckreceiver/internal/metadata/config.schema.yaml index 72b298fe8f99e..9af44a561c823 100644 --- a/receiver/tlscheckreceiver/internal/metadata/config.schema.yaml +++ b/receiver/tlscheckreceiver/internal/metadata/config.schema.yaml @@ -1,7 +1,7 @@ # Code generated by mdatagen. DO NOT EDIT. $defs: metrics_config: - description: MetricsConfig provides config for tlscheck metrics. + description: MetricsConfig provides config for tls_check metrics. type: object properties: tlscheck.time_left: @@ -12,7 +12,7 @@ $defs: type: boolean default: true resource_attributes_config: - description: ResourceAttributesConfig provides config for tlscheck resource attributes. + description: ResourceAttributesConfig provides config for tls_check resource attributes. type: object properties: tlscheck.target: @@ -33,7 +33,7 @@ $defs: items: $ref: go.opentelemetry.io/collector/filter.config metrics_builder_config: - description: MetricsBuilderConfig is a configuration for tlscheck metrics builder. + description: MetricsBuilderConfig is a configuration for tls_check metrics builder. type: object properties: metrics: diff --git a/receiver/tlscheckreceiver/internal/metadata/generated_config.go b/receiver/tlscheckreceiver/internal/metadata/generated_config.go index 9dc288a0f44fb..1acb885c0fdac 100644 --- a/receiver/tlscheckreceiver/internal/metadata/generated_config.go +++ b/receiver/tlscheckreceiver/internal/metadata/generated_config.go @@ -27,7 +27,7 @@ func (ms *MetricConfig) Unmarshal(parser *confmap.Conf) error { return nil } -// MetricsConfig provides config for tlscheck metrics. +// MetricsConfig provides config for tls_check metrics. type MetricsConfig struct { TlscheckTimeLeft MetricConfig `mapstructure:"tlscheck.time_left"` } @@ -66,7 +66,7 @@ func (rac *ResourceAttributeConfig) Unmarshal(parser *confmap.Conf) error { return nil } -// ResourceAttributesConfig provides config for tlscheck resource attributes. +// ResourceAttributesConfig provides config for tls_check resource attributes. type ResourceAttributesConfig struct { TlscheckTarget ResourceAttributeConfig `mapstructure:"tlscheck.target"` } @@ -79,7 +79,7 @@ func DefaultResourceAttributesConfig() ResourceAttributesConfig { } } -// MetricsBuilderConfig is a configuration for tlscheck metrics builder. +// MetricsBuilderConfig is a configuration for tls_check metrics builder. type MetricsBuilderConfig struct { Metrics MetricsConfig `mapstructure:"metrics"` ResourceAttributes ResourceAttributesConfig `mapstructure:"resource_attributes"` diff --git a/receiver/tlscheckreceiver/internal/metadata/generated_status.go b/receiver/tlscheckreceiver/internal/metadata/generated_status.go index db483b29005f2..d942d3c5eef35 100644 --- a/receiver/tlscheckreceiver/internal/metadata/generated_status.go +++ b/receiver/tlscheckreceiver/internal/metadata/generated_status.go @@ -7,8 +7,9 @@ import ( ) var ( - Type = component.MustNewType("tlscheck") - ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tlscheckreceiver" + Type = component.MustNewType("tls_check") + DeprecatedType = component.MustNewType("tlscheck") + ScopeName = "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/tlscheckreceiver" ) const ( diff --git a/receiver/tlscheckreceiver/metadata.yaml b/receiver/tlscheckreceiver/metadata.yaml index 9a13becd7c284..97a88c934b41c 100644 --- a/receiver/tlscheckreceiver/metadata.yaml +++ b/receiver/tlscheckreceiver/metadata.yaml @@ -1,5 +1,6 @@ display_name: TLS Check Receiver -type: tlscheck +type: tls_check +deprecated_type: tlscheck description: This receiver emits metrics about x.509 certificates. diff --git a/reports/distributions/contrib.yaml b/reports/distributions/contrib.yaml index 8d7c0e43f1333..5369615076392 100644 --- a/reports/distributions/contrib.yaml +++ b/reports/distributions/contrib.yaml @@ -226,7 +226,7 @@ components: - systemd - tcp_log - tcpcheck - - tlscheck + - tls_check - udp_log - vcenter - wavefront