Skip to content

Commit

Permalink
[processor/resourcedetection] Add feature gate to change stepping to …
Browse files Browse the repository at this point in the history
…string

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
  • Loading branch information
ChrsMark committed Feb 12, 2024
1 parent 22e0ce0 commit bc37ccc
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 6 deletions.
28 changes: 28 additions & 0 deletions .chloggen/fix_cpu_stepping_type.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: processor/resourcedetection

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add `processor.resourcedetection.hostCPUSteppingAsString` feature gate to change the type of `host.cpu.stepping` from `int` to `string`.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [31136]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
This feature gate will graduate to beta in the next release.
# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []

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.

Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,10 @@ func (rb *ResourceBuilder) SetHostCPUModelIDAsInt(val int64) {
rb.res.Attributes().PutInt("host.cpu.model.id", val)
}
}

// SetHostCPUSteppingAsInt sets provided value as "host.cpu.stepping" attribute as int.
func (rb *ResourceBuilder) SetHostCPUSteppingAsInt(val int64) {
if rb.config.HostCPUModelID.Enabled {
rb.res.Attributes().PutInt("host.cpu.stepping", val)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ resource_attributes:
enabled: false
host.cpu.stepping:
description: The host.cpu.stepping
type: int
type: string
enabled: false
host.cpu.cache.l2.size:
description: The host.cpu.cache.l2.size
Expand Down
19 changes: 18 additions & 1 deletion processor/resourcedetectionprocessor/internal/system/system.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ var (
featuregate.WithRegisterFromVersion("v0.89.0"),
featuregate.WithRegisterReferenceURL("https://github.com/open-telemetry/semantic-conventions/issues/495"),
)
hostCPUSteppingAsStringID = "processor.resourcedetection.hostCPUSteppingAsString"
hostCPUSteppingAsStringFeatureGate = featuregate.GlobalRegistry().MustRegister(
hostCPUSteppingAsStringID,
featuregate.StageAlpha,
featuregate.WithRegisterDescription("Change type of host.cpu.stepping to string."),
featuregate.WithRegisterFromVersion("v0.95.0"),
featuregate.WithRegisterReferenceURL("https://github.com/open-telemetry/semantic-conventions/issues/664"),
)
)

const (
Expand Down Expand Up @@ -232,7 +240,16 @@ func setHostCPUInfo(d *Detector, cpuInfo cpu.InfoStat) error {
}

d.rb.SetHostCPUModelName(cpuInfo.ModelName)
d.rb.SetHostCPUStepping(int64(cpuInfo.Stepping))
if hostCPUSteppingAsStringFeatureGate.IsEnabled() {
d.rb.SetHostCPUStepping(fmt.Sprintf("%d", cpuInfo.Stepping))
} else {
// https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/31136
d.logger.Info("This attribute will change from int to string. Switch now using the feature gate.",
zap.String("attribute", "host.cpu.stepping"),
zap.String("feature gate", hostCPUSteppingAsStringID),
)
d.rb.SetHostCPUSteppingAsInt(int64(cpuInfo.Stepping))
}
d.rb.SetHostCPUCacheL2Size(int64(cpuInfo.CacheSize))
return nil
}

0 comments on commit bc37ccc

Please sign in to comment.