Skip to content

Commit 7638bb2

Browse files
authored
[mdatagen] export ScopeName in internal/metadata package (#10845)
This can be used by components that need to set their scope name manually. Will save component owners from having to store a variable, which may diverge from the scope name used by the component for emitting its own telemetry. There are about a dozen components in contrib that could use this today. Alternatively, I could just update the scope name strings in the components manually. --------- Signed-off-by: Alex Boten <[email protected]>
1 parent ecbe02e commit 7638bb2

File tree

10 files changed

+65
-20
lines changed

10 files changed

+65
-20
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
7+
component: mdatagen
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: export ScopeName in internal/metadata package
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [10845]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext: This can be used by components that need to set their scope name manually. Will save component owners from having to store a variable, which may diverge from the scope name used by the component for emitting its own telemetry.
19+
20+
# Optional: The change log or logs in which this entry should be included.
21+
# e.g. '[user]' or '[user, api]'
22+
# Include 'user' if the change is relevant to end users.
23+
# Include 'api' if there is a change to a library API.
24+
# Default: '[user]'
25+
change_logs: []

cmd/mdatagen/internal/samplereceiver/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/main_test.go

+8-4
Original file line numberDiff line numberDiff line change
@@ -546,12 +546,14 @@ import (
546546
"go.opentelemetry.io/collector/config/configtelemetry"
547547
)
548548
549+
const ScopeName = ""
550+
549551
func Meter(settings component.TelemetrySettings) metric.Meter {
550-
return settings.MeterProvider.Meter("")
552+
return settings.MeterProvider.Meter(ScopeName)
551553
}
552554
553555
func Tracer(settings component.TelemetrySettings) trace.Tracer {
554-
return settings.TracerProvider.Tracer("")
556+
return settings.TracerProvider.Tracer(ScopeName)
555557
}
556558
`,
557559
},
@@ -580,12 +582,14 @@ import (
580582
"go.opentelemetry.io/collector/config/configtelemetry"
581583
)
582584
585+
const ScopeName = ""
586+
583587
func Meter(settings component.TelemetrySettings) metric.Meter {
584-
return settings.MeterProvider.Meter("")
588+
return settings.MeterProvider.Meter(ScopeName)
585589
}
586590
587591
func Tracer(settings component.TelemetrySettings) trace.Tracer {
588-
return settings.TracerProvider.Tracer("")
592+
return settings.TracerProvider.Tracer(ScopeName)
589593
}
590594
`,
591595
},

cmd/mdatagen/templates/telemetry.go.tmpl

+4-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@ import (
1616
"go.opentelemetry.io/collector/config/configtelemetry"
1717
)
1818

19+
const ScopeName = "{{ .ScopeName }}"
20+
1921
func Meter(settings component.TelemetrySettings) metric.Meter {
20-
return settings.MeterProvider.Meter("{{ .ScopeName }}")
22+
return settings.MeterProvider.Meter(ScopeName)
2123
}
2224

2325
func Tracer(settings component.TelemetrySettings) trace.Tracer {
24-
return settings.TracerProvider.Tracer("{{ .ScopeName }}")
26+
return settings.TracerProvider.Tracer(ScopeName)
2527
}
2628
{{- if .Telemetry.Metrics }}
2729

exporter/exporterhelper/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

processor/batchprocessor/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

processor/processorhelper/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

receiver/receiverhelper/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

receiver/scraperhelper/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

service/internal/metadata/generated_telemetry.go

+4-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)