Skip to content

Commit ea52fa6

Browse files
liamfdcodeboten
andauthored
docs(spanmetrics): Fix feature gate name in README (open-telemetry#43626)
<!--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. #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 <[email protected]>
1 parent 80ec02f commit ea52fa6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

connector/spanmetricsconnector/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ across all spans:
6262
- `status.code`
6363
- `collector.instance.id`
6464

65-
The `collector.instance.id` dimension is intended to add a unique UUID to all metrics, ensuring that the spanmetrics connector
65+
The `collector.instance.id` dimension is intended to add a unique UUID to all metrics, ensuring that the spanmetrics connector
6666
does not violate the **Single Writer Principle** when spanmetrics is used in a multi-deployment model.
67-
Currently, `collector.instance.id` must be manually enabled via the feature gate: `connector.spanmetrics.includeServiceInstanceID`.
67+
Currently, `collector.instance.id` must be manually enabled via the feature gate: `connector.spanmetrics.includeCollectorInstanceID`.
6868
More detail, please see [Known Limitation: the Single Writer Principle](#known-limitation-the-single-writer-principle)
6969

7070
## Span to Metrics processor to Span to metrics connector
@@ -283,7 +283,7 @@ connectors:
283283
- telemetry.sdk.language
284284
- telemetry.sdk.name
285285
```
286-
* Manually enable the feature gate: `connector.spanmetrics.includeServiceInstanceID` to produce uniquely identified metrics.
286+
* Manually enable the feature gate: `connector.spanmetrics.includeCollectorInstanceID` to produce uniquely identified metrics.
287287
* For exporters like Prometheus, which rely on the single writer assumption, use a dedicated pipeline with a single `spanmetricsconnector` instance
288288
289289
More context is available in [GitHub issue #21101](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21101).

0 commit comments

Comments
 (0)