Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[exporters/signalfx] breaking change: do not convert periods to underscores in dimension keys #2456

Merged
merged 1 commit into from
Feb 24, 2021

Conversation

mstumpfx
Copy link

@mstumpfx mstumpfx commented Feb 24, 2021

Description: breaking change: This PR introduces a
breaking change for current users upon upgrading, unless
explicitly setting the nonalphanumeric_dimension_chars config
option on the signalfx exporter.

This PR changes the config option nonalphanumeric_dimension_chars
default from _- to _-..

The resulting behavior change is dimensions keys with periods in them
will no longer be converted to underscores. For example, if the
dimension k8s.pod.uid was currently sent, the exporter would
automatically convert this to k8s_pod-uid. This change will allow
k8s.pod.uid to be sent as is.

Why? The SignalFx backend now allows periods in dimension keys,
and much of our content will rely on this.
Existing users who do not wish to break MTSs and keep current
functionality can set nonalphanumeric_dimension_chars to _-.

@mstumpfx mstumpfx requested a review from a team February 24, 2021 18:36
@codecov
Copy link

codecov bot commented Feb 24, 2021

Codecov Report

Merging #2456 (1dbb2ca) into main (768426b) will decrease coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2456      +/-   ##
==========================================
- Coverage   90.93%   90.91%   -0.02%     
==========================================
  Files         411      411              
  Lines       20467    20467              
==========================================
- Hits        18611    18608       -3     
- Misses       1395     1397       +2     
- Partials      461      462       +1     
Flag Coverage Δ
integration 69.28% <ø> (+0.06%) ⬆️
unit 89.76% <100.00%> (-0.02%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
exporter/signalfxexporter/factory.go 82.75% <100.00%> (ø)
receiver/k8sclusterreceiver/watcher.go 95.29% <0.00%> (-2.36%) ⬇️
processor/groupbytraceprocessor/event.go 95.96% <0.00%> (-0.81%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 768426b...1dbb2ca. Read the comment docs.

…scores in dimension keys

**Description:** **breaking change**: This PR introduces a
breaking change for current users upon upgrading, unless
explicitly setting the `nonalphanumeric_dimension_chars` config
option on the signalfx exporter.

This PR changes the config option `nonalphanumeric_dimension_chars`
default from `_-` to `_-.`.

The resulting behavior change is dimensions keys with periods in them
will no longer be converted to underscores. For example, if the
dimension `k8s.pod.uid` was currently sent, the exporter would
automatically convert this to `k8s_pod-uid`. This change will allow
`k8s.pod.uid` to be sent as is.

Why? The SignalFx backend now allows periods in dimension keys,
and much of our content will rely on this.
Existing users who do not wish to break MTSs and keep current
functionality can set `nonalphanumeric_dimension_chars` to `_-`.
@bogdandrutu bogdandrutu merged commit b1cb781 into open-telemetry:main Feb 24, 2021
@mstumpfx mstumpfx deleted the default-dims-chars branch February 24, 2021 21:03
This was referenced Mar 15, 2021
pmatyjasek-sumo referenced this pull request in pmatyjasek-sumo/opentelemetry-collector-contrib Apr 28, 2021
…scores in dimension keys (#2456)

**Description:** **breaking change**: This PR introduces a
breaking change for current users upon upgrading, unless
explicitly setting the `nonalphanumeric_dimension_chars` config
option on the signalfx exporter.

This PR changes the config option `nonalphanumeric_dimension_chars`
default from `_-` to `_-.`.

The resulting behavior change is dimensions keys with periods in them
will no longer be converted to underscores. For example, if the
dimension `k8s.pod.uid` was currently sent, the exporter would
automatically convert this to `k8s_pod-uid`. This change will allow
`k8s.pod.uid` to be sent as is.

Why? The SignalFx backend now allows periods in dimension keys,
and much of our content will rely on this.
Existing users who do not wish to break MTSs and keep current
functionality can set `nonalphanumeric_dimension_chars` to `_-`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants