Skip to content

docs(spanmetrics): Fix feature gate name in README#43626

Merged
codeboten merged 2 commits into
open-telemetry:mainfrom
liamfd:fix-spanmetrics-feature-gate-docs
Oct 17, 2025
Merged

docs(spanmetrics): Fix feature gate name in README#43626
codeboten merged 2 commits into
open-telemetry:mainfrom
liamfd:fix-spanmetrics-feature-gate-docs

Conversation

@liamfd
Copy link
Copy Markdown
Contributor

@liamfd liamfd commented Oct 17, 2025

Hello! It looks like #41865 introduced a new feature flag and associated docs. The docs list it as connector.spanmetrics.includeServiceInstanceID, but I believe it's actually connector.spanmetrics.includeCollectorInstanceID. Looks like it might've changed due to feedback in the PR

Passing connector.spanmetrics.includeServiceInstanceID resulted in the following error for me:

"Error: invalid argument "connector.spanmetrics.includeServiceInstanceID" for "--feature-gates" flag: no such feature gate "connector.spanmetrics.includeServiceInstanceID". valid gates: [awsemf.nodimrollupdefault clickhouse.json cloudfoundry.resourceAttributes.allow confighttp.framedSnappy confmap.enableMergeAppendOption connector.datadogconnector.NativeIngest connector.servicegraph.legacyLatencyMetricNames connector.servicegraph.legacyLatencyUnitMs connector.servicegraph.virtualNode connector.spanmetrics.excludeResourceMetrics connector.spanmetrics.includeCollectorInstanceID connector.spanmetrics.legacyMetricNames connector.spanmetrics.useSecondAsDefaultMetricsUnit datadog.EnableOperationAndResourceNameV2 datadog.EnableReceiveResourceSpansV2 exporter.PersistRequestContext exporter.awsxray.skiptimestampvalidation exporter.datadogexporter.DisableAPMStats exporter.datadogexporter.InferIntervalForDeltaMetrics exporter.datadogexporter.TraceExportUseCustomHTTPClient exporter.datadogexporter.UseLogsAgentExporter exporter.datadogexporter.metricexportnativeclient exporter.datadogexporter.metricexportserializerclient exporter.datadogexporter.metricremappingdisabled exporter.googlecloud.CustomMonitoredResources exporter.googlemanagedprometheus.intToDouble exporter.kafkaexporter.UseFranzGo exporter.prometheusexporter.DisableAddMetricSuffixes exporter.prometheusremotewritexporter.EnableMultipleWorkers exporter.prometheusremotewritexporter.RetryOn429 exporter.prometheusremotewritexporter.enableSendingRW2 exporter.xray.allowDot extension.jaegerremotesampling.replaceThriftWithProto extension.sumologic.updateCollectorMetadata filelog.allowFileDeletion filelog.allowHeaderMetadataParsing filelog.decompressFingerprint filelog.mtimeSortType filter.filterlog.useOTTLBridge filter.filtermetric.useOTTLBridge filter.filterspan.useOTTLBridge hostmetrics.process.bootTimeCache k8sattr.fieldExtractConfigRegex.disallow k8sattr.labelsAnnotationsSingular.allow logs.assignKeys logs.jsonParserArray metricsgeneration.MatchAttributes otelcol.printInitialConfig parser.uri.ecscompliant pdata.enableRefCounting pdata.useCustomProtoEncoding pdata.useProtoPooling pkg.translator.prometheus.NormalizeName pkg.translator.prometheus.PermissiveLabelSanitization postgresqlreceiver.preciselagmetrics processor.resourcedetection.propagateerrors processor.resourcedetection.removeGCPFaasID processor.tailsamplingprocessor.disableinvertdecisions processor.tailsamplingprocessor.metricstatcountspanssampled processor.tailsamplingprocessor.recordpolicy processor.transform.ConvertBetweenSumAndGaugeMetricContext receiver.azureeventhubreceiver.UseAzeventhubs receiver.datadogreceiver.Enable128BitTraceID receiver.hostmetricsreceiver.UseLinuxMemAvailable receiver.jaeger.DisableRemoteSampling receiver.kafkametricsreceiver.UseFranzGo receiver.kafkareceiver.UseFranzGo receiver.mongodb.removeDatabaseAttr receiver.postgresql.connectionPool receiver.postgresql.separateSchemaAttr receiver.prometheusreceiver.EnableCreatedTimestampZeroIngestion receiver.prometheusreceiver.EnableNativeHistograms receiver.prometheusreceiver.RemoveLegacyResourceAttributes receiver.prometheusreceiver.RemoveStartTimeAdjustment receiver.prometheusreceiver.UseCollectorStartTimeFallback receiver.prometheusreceiver.UseCreatedMetric receiver.sqlserver.RemoveServerResourceAttribute receiver.vcenter.resourcePoolMemoryUsageAttribute receiverhelper.newReceiverMetrics service.AllowNoPipelines service.noopTracerProvider service.profilesSupport stanza.synchronousLogEmitter telemetry.UseLocalHostAsDefaultMetricsAddress telemetry.disableHighCardinalityMetrics telemetry.newPipelineTelemetry transform.flatten.logs]"

So here I just fix the name in the docs.

Description

n/a

Link to tracking issue

n/a

Testing

I copy pasted the flag name string from the doc change into my dockerfile and made sure it ran (no typos).

Documentation

Just updating connector/spanmetricsconnector/README.md as described above.


Thanks for the feature!

Update feature gate name from includeServiceInstanceID to
includeCollectorInstanceID.
@liamfd liamfd requested a review from a team as a code owner October 17, 2025 15:14
@liamfd liamfd requested a review from braydonk October 17, 2025 15:14
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla Bot commented Oct 17, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: codeboten / name: Alex Boten (db3eb60)
  • ✅ login: liamfd / name: Liam Doran (5b2c3be)

@github-actions github-actions Bot added the first-time contributor PRs made by new contributors label Oct 17, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Welcome, contributor! Thank you for your contribution to opentelemetry-collector-contrib.

Important reminders:

A maintainer will review your pull request soon. Thank you for helping make OpenTelemetry better!

@songy23 songy23 added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Oct 17, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Welcome, contributor! Thank you for your contribution to opentelemetry-collector-contrib.

Important reminders:

A maintainer will review your pull request soon. Thank you for helping make OpenTelemetry better!

Copy link
Copy Markdown
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @liamfd!

@codeboten codeboten merged commit ea52fa6 into open-telemetry:main Oct 17, 2025
161 checks passed
@github-actions github-actions Bot added this to the next release milestone Oct 17, 2025
@otelbot
Copy link
Copy Markdown
Contributor

otelbot Bot commented Oct 17, 2025

Thank you for your contribution @liamfd! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey. If you are getting started contributing, you can also join the CNCF Slack channel #opentelemetry-new-contributors to ask for guidance and get help.

@liamfd liamfd deleted the fix-spanmetrics-feature-gate-docs branch October 18, 2025 13:24
ChrsMark pushed a commit to ChrsMark/opentelemetry-collector-contrib that referenced this pull request Oct 20, 2025
)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->

Hello! It looks like
open-telemetry#41865
introduced a new feature flag and associated docs. The docs list it as
`connector.spanmetrics.includeServiceInstanceID`, but I believe it's
actually `connector.spanmetrics.includeCollectorInstanceID`. Looks like
it might've changed due to feedback in the PR

Passing `connector.spanmetrics.includeServiceInstanceID` resulted in the
following error for me:

> "Error: invalid argument
"connector.spanmetrics.includeServiceInstanceID" for "--feature-gates"
flag: no such feature gate
"connector.spanmetrics.includeServiceInstanceID". valid gates:
[awsemf.nodimrollupdefault clickhouse.json
cloudfoundry.resourceAttributes.allow confighttp.framedSnappy
confmap.enableMergeAppendOption connector.datadogconnector.NativeIngest
connector.servicegraph.legacyLatencyMetricNames
connector.servicegraph.legacyLatencyUnitMs
connector.servicegraph.virtualNode
connector.spanmetrics.excludeResourceMetrics
connector.spanmetrics.includeCollectorInstanceID
connector.spanmetrics.legacyMetricNames
connector.spanmetrics.useSecondAsDefaultMetricsUnit
datadog.EnableOperationAndResourceNameV2
datadog.EnableReceiveResourceSpansV2 exporter.PersistRequestContext
exporter.awsxray.skiptimestampvalidation
exporter.datadogexporter.DisableAPMStats
exporter.datadogexporter.InferIntervalForDeltaMetrics
exporter.datadogexporter.TraceExportUseCustomHTTPClient
exporter.datadogexporter.UseLogsAgentExporter
exporter.datadogexporter.metricexportnativeclient
exporter.datadogexporter.metricexportserializerclient
exporter.datadogexporter.metricremappingdisabled
exporter.googlecloud.CustomMonitoredResources
exporter.googlemanagedprometheus.intToDouble
exporter.kafkaexporter.UseFranzGo
exporter.prometheusexporter.DisableAddMetricSuffixes
exporter.prometheusremotewritexporter.EnableMultipleWorkers
exporter.prometheusremotewritexporter.RetryOn429
exporter.prometheusremotewritexporter.enableSendingRW2
exporter.xray.allowDot
extension.jaegerremotesampling.replaceThriftWithProto
extension.sumologic.updateCollectorMetadata filelog.allowFileDeletion
filelog.allowHeaderMetadataParsing filelog.decompressFingerprint
filelog.mtimeSortType filter.filterlog.useOTTLBridge
filter.filtermetric.useOTTLBridge filter.filterspan.useOTTLBridge
hostmetrics.process.bootTimeCache
k8sattr.fieldExtractConfigRegex.disallow
k8sattr.labelsAnnotationsSingular.allow logs.assignKeys
logs.jsonParserArray metricsgeneration.MatchAttributes
otelcol.printInitialConfig parser.uri.ecscompliant
pdata.enableRefCounting pdata.useCustomProtoEncoding
pdata.useProtoPooling pkg.translator.prometheus.NormalizeName
pkg.translator.prometheus.PermissiveLabelSanitization
postgresqlreceiver.preciselagmetrics
processor.resourcedetection.propagateerrors
processor.resourcedetection.removeGCPFaasID
processor.tailsamplingprocessor.disableinvertdecisions
processor.tailsamplingprocessor.metricstatcountspanssampled
processor.tailsamplingprocessor.recordpolicy
processor.transform.ConvertBetweenSumAndGaugeMetricContext
receiver.azureeventhubreceiver.UseAzeventhubs
receiver.datadogreceiver.Enable128BitTraceID
receiver.hostmetricsreceiver.UseLinuxMemAvailable
receiver.jaeger.DisableRemoteSampling
receiver.kafkametricsreceiver.UseFranzGo
receiver.kafkareceiver.UseFranzGo receiver.mongodb.removeDatabaseAttr
receiver.postgresql.connectionPool
receiver.postgresql.separateSchemaAttr
receiver.prometheusreceiver.EnableCreatedTimestampZeroIngestion
receiver.prometheusreceiver.EnableNativeHistograms
receiver.prometheusreceiver.RemoveLegacyResourceAttributes
receiver.prometheusreceiver.RemoveStartTimeAdjustment
receiver.prometheusreceiver.UseCollectorStartTimeFallback
receiver.prometheusreceiver.UseCreatedMetric
receiver.sqlserver.RemoveServerResourceAttribute
receiver.vcenter.resourcePoolMemoryUsageAttribute
receiverhelper.newReceiverMetrics service.AllowNoPipelines
service.noopTracerProvider service.profilesSupport
stanza.synchronousLogEmitter
telemetry.UseLocalHostAsDefaultMetricsAddress
telemetry.disableHighCardinalityMetrics telemetry.newPipelineTelemetry
transform.flatten.logs]"

So here I just fix the name in the docs.

#### Description

<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
n/a

#### Link to tracking issue
n/a

<!--Describe what testing was performed and which tests were added.-->
#### Testing

I copy pasted the flag name string from the doc change into my
dockerfile and made sure it ran (no typos).

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

Just updating `connector/spanmetricsconnector/README.md` as described
above.

----

Thanks for the feature!

Co-authored-by: Alex Boten <223565+codeboten@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

connector/spanmetrics first-time contributor PRs made by new contributors Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants