Skip to content

Commit 472c673

Browse files
authored
[connector/spanmetrics]Rename spanmetricsconnector (#47963)
Part of #45339, follow the lower snake case convention
1 parent c731d26 commit 472c673

10 files changed

Lines changed: 51 additions & 37 deletions

File tree

.chloggen/config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ components:
2727
- connector/servicegraph
2828
- connector/signal_to_metrics
2929
- connector/slowsql
30-
- connector/spanmetrics
30+
- connector/span_metrics
3131
- connector/sum
3232
- exporter/alertmanager
3333
- exporter/alibabacloud_logservice
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
change_type: deprecation
2+
component: connector/span_metrics
3+
note: Rename component type from `spanmetrics` to `span_metrics` to follow snake_case naming convention. The old name is kept as a deprecated alias.
4+
issues: [47963]
5+
change_logs: [user]

connector/spanmetricsconnector/README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
[Stability Level]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#stability-levels
2323
<!-- end autogenerated section -->
2424

25+
> **Deprecation Notice:** The component type has been renamed from `spanmetrics` to `span_metrics`
26+
> to follow the OpenTelemetry snake_case naming convention.
27+
> The old name `spanmetrics` still works but is deprecated and will be removed in a future release.
28+
> Please update your configuration to use `span_metrics`.
29+
2530
⚠️ Breaking Change Warning:
2631
The default duration metrics unit will change from `ms` to `s` to adhere to the OpenTelemetry semantic conventions and a feature gate `connector.spanmetrics.useSecondAsDefaultMetricsUnit` is also added.
2732

@@ -159,7 +164,7 @@ exporters:
159164
nop:
160165

161166
connectors:
162-
spanmetrics:
167+
span_metrics:
163168
histogram:
164169
dimensions:
165170
- name: url.scheme
@@ -195,9 +200,9 @@ service:
195200
pipelines:
196201
traces:
197202
receivers: [nop]
198-
exporters: [spanmetrics]
203+
exporters: [span_metrics]
199204
metrics:
200-
receivers: [spanmetrics]
205+
receivers: [span_metrics]
201206
exporters: [nop]
202207
```
203208
@@ -225,16 +230,16 @@ exporters:
225230
enabled: true
226231
227232
connectors:
228-
spanmetrics:
233+
span_metrics:
229234
namespace: span.metrics
230235
231236
service:
232237
pipelines:
233238
traces:
234239
receivers: [otlp]
235-
exporters: [spanmetrics]
240+
exporters: [span_metrics]
236241
metrics:
237-
receivers: [spanmetrics]
242+
receivers: [span_metrics]
238243
exporters: [prometheusremotewrite]
239244
```
240245

@@ -278,7 +283,7 @@ To reduce the risk of conflicting writes:
278283
* Add `resource_metrics_key_attributes` to your configuration.
279284
```
280285
connectors:
281-
spanmetrics:
286+
span_metrics:
282287
resource_metrics_key_attributes:
283288
- service.name
284289
- telemetry.sdk.language
@@ -343,7 +348,7 @@ processors:
343348
...
344349
345350
connectors:
346-
spanmetrics:
351+
span_metrics:
347352
348353
exporters:
349354
otlp_http/observability-backend:
@@ -354,9 +359,9 @@ service:
354359
traces:
355360
receivers: [otlp]
356361
processors: [transform/sanitize_spans, ...]
357-
exporters: [otlp_http/observability-backend, spanmetrics]
362+
exporters: [otlp_http/observability-backend, span_metrics]
358363
metrics:
359-
receivers: [otlp, spanmetrics]
364+
receivers: [otlp, span_metrics]
360365
processors: [...]
361366
exporters: [otlp_http/observability-backend]
362367
# ...
@@ -406,7 +411,7 @@ processors:
406411
...
407412

408413
connectors:
409-
spanmetrics:
414+
span_metrics:
410415

411416
exporters:
412417
otlp_http/observability-backend:
@@ -417,9 +422,9 @@ service:
417422
traces:
418423
receivers: [otlp]
419424
processors: [transform/sanitize_spans, ...]
420-
exporters: [otlp_http/observability-backend, spanmetrics]
425+
exporters: [otlp_http/observability-backend, span_metrics]
421426
metrics:
422-
receivers: [otlp, spanmetrics]
427+
receivers: [otlp, span_metrics]
423428
processors: [...]
424429
exporters: [otlp_http/observability-backend]
425430
# ...

connector/spanmetricsconnector/factory.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import (
1313
"github.com/jonboulle/clockwork"
1414
"go.opentelemetry.io/collector/component"
1515
"go.opentelemetry.io/collector/connector"
16+
"go.opentelemetry.io/collector/connector/xconnector"
1617
"go.opentelemetry.io/collector/consumer"
1718
"go.opentelemetry.io/collector/featuregate"
1819
"go.opentelemetry.io/collector/pdata/pcommon"
@@ -72,10 +73,11 @@ func init() {
7273

7374
// NewFactory creates a factory for the spanmetrics connector.
7475
func NewFactory() connector.Factory {
75-
return connector.NewFactory(
76+
return xconnector.NewFactory(
7677
metadata.Type,
7778
createDefaultConfig,
78-
connector.WithTracesToMetrics(createTracesToMetricsConnector, metadata.TracesToMetricsStability),
79+
xconnector.WithTracesToMetrics(createTracesToMetricsConnector, metadata.TracesToMetricsStability),
80+
xconnector.WithDeprecatedTypeAlias(metadata.DeprecatedType),
7981
)
8082
}
8183

connector/spanmetricsconnector/generated_component_test.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

connector/spanmetricsconnector/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ require (
1919
go.opentelemetry.io/collector/confmap/xconfmap v0.150.1-0.20260424074859-d91c0edd1da5
2020
go.opentelemetry.io/collector/connector v0.150.1-0.20260424074859-d91c0edd1da5
2121
go.opentelemetry.io/collector/connector/connectortest v0.150.1-0.20260424074859-d91c0edd1da5
22+
go.opentelemetry.io/collector/connector/xconnector v0.150.1-0.20260424074859-d91c0edd1da5
2223
go.opentelemetry.io/collector/consumer v1.56.1-0.20260424074859-d91c0edd1da5
2324
go.opentelemetry.io/collector/consumer/consumertest v0.150.1-0.20260424074859-d91c0edd1da5
2425
go.opentelemetry.io/collector/featuregate v1.56.1-0.20260424074859-d91c0edd1da5
@@ -48,7 +49,6 @@ require (
4849
github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
4950
github.com/pmezard/go-difflib v1.0.0 // indirect
5051
go.opentelemetry.io/auto/sdk v1.2.1 // indirect
51-
go.opentelemetry.io/collector/connector/xconnector v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
5252
go.opentelemetry.io/collector/consumer/xconsumer v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
5353
go.opentelemetry.io/collector/internal/componentalias v0.150.1-0.20260424074859-d91c0edd1da5 // indirect
5454
go.opentelemetry.io/collector/internal/fanoutconsumer v0.150.1-0.20260424074859-d91c0edd1da5 // indirect

connector/spanmetricsconnector/internal/metadata/generated_status.go

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

connector/spanmetricsconnector/metadata.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
type: spanmetrics
1+
type: span_metrics
2+
deprecated_type: spanmetrics
23
display_name: Span Metrics Connector
34

45
status:

connector/spanmetricsconnector/testdata/config.yaml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# default configuration
2-
spanmetrics/default:
2+
span_metrics/default:
33

44
# default configuration with explicit buckets histogram
5-
spanmetrics/default_explicit_histogram:
5+
span_metrics/default_explicit_histogram:
66
histogram:
77
explicit:
88

99
# configuration with all possible parameters
10-
spanmetrics/full:
10+
span_metrics/full:
1111
histogram:
1212
unit: "s"
1313
explicit:
@@ -40,56 +40,56 @@ spanmetrics/full:
4040
metrics_flush_interval: 30s
4141

4242
# default configuration with exponential buckets histogram
43-
spanmetrics/exponential_histogram:
43+
span_metrics/exponential_histogram:
4444
histogram:
4545
exponential:
4646
max_size: 10
4747

4848
# invalid histogram configuration
49-
spanmetrics/exponential_and_explicit_histogram:
49+
span_metrics/exponential_and_explicit_histogram:
5050
histogram:
5151
exponential:
5252
max_size: 10
5353
explicit:
5454
buckets: [ 10ms, 100ms, 250ms ]
5555

56-
spanmetrics/invalid_histogram_unit:
56+
span_metrics/invalid_histogram_unit:
5757
histogram:
5858
unit: "h"
5959

60-
spanmetrics/invalid_metrics_expiration:
60+
span_metrics/invalid_metrics_expiration:
6161
metrics_expiration: -20s
6262

6363
# exemplars enabled
64-
spanmetrics/exemplars_enabled:
64+
span_metrics/exemplars_enabled:
6565
exemplars:
6666
enabled: true
6767

6868
# exemplars enabled with max per datapoint configured
69-
spanmetrics/exemplars_enabled_with_max_per_datapoint:
69+
span_metrics/exemplars_enabled_with_max_per_datapoint:
7070
exemplars:
7171
enabled: true
7272
max_per_data_point: 10
7373

7474
# resource metrics key attributes filter
75-
spanmetrics/resource_metrics_key_attributes:
75+
span_metrics/resource_metrics_key_attributes:
7676
resource_metrics_key_attributes:
7777
- service.name
7878
- telemetry.sdk.language
7979
- telemetry.sdk.name
8080

81-
spanmetrics/custom_delta_timestamp_cache_size:
81+
span_metrics/custom_delta_timestamp_cache_size:
8282
aggregation_temporality: "AGGREGATION_TEMPORALITY_DELTA"
8383
metric_timestamp_cache_size: 123
8484

85-
spanmetrics/invalid_delta_timestamp_cache_size:
85+
span_metrics/invalid_delta_timestamp_cache_size:
8686
aggregation_temporality: "AGGREGATION_TEMPORALITY_DELTA"
8787
metric_timestamp_cache_size: 0
8888

89-
spanmetrics/default_delta_timestamp_cache_size:
89+
span_metrics/default_delta_timestamp_cache_size:
9090
aggregation_temporality: "AGGREGATION_TEMPORALITY_DELTA"
9191

92-
spanmetrics/separate_calls_and_duration_dimensions:
92+
span_metrics/separate_calls_and_duration_dimensions:
9393
histogram:
9494
dimensions:
9595
- name: http.status_code

reports/distributions/contrib.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ components:
1313
- routing
1414
- servicegraph
1515
- signal_to_metrics
16-
- spanmetrics
16+
- span_metrics
1717
- sum
1818
exporter:
1919
- alibabacloud_logservice

0 commit comments

Comments
 (0)