Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .chloggen/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ components:
- receiver/systemd
- receiver/tcp_log
- receiver/tcpcheck
- receiver/tlscheck
- receiver/tls_check
- receiver/udp_log
- receiver/vcenter
- receiver/vcr
Expand Down
13 changes: 13 additions & 0 deletions .chloggen/rename-tls-check-receiver.yaml
Original file line number Diff line number Diff line change
@@ -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]
5 changes: 4 additions & 1 deletion receiver/tlscheckreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion receiver/tlscheckreceiver/documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)

# tlscheck
# tls_check

## Default Metrics

Expand Down
7 changes: 5 additions & 2 deletions receiver/tlscheckreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand All @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion receiver/tlscheckreceiver/generated_component_test.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion receiver/tlscheckreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion receiver/tlscheckreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion reports/distributions/contrib.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ components:
- systemd
- tcp_log
- tcpcheck
- tlscheck
- tls_check
- udp_log
- vcenter
- wavefront
Expand Down
Loading