Skip to content

Commit 4ca0f18

Browse files
authored
update semconv dependency to otelgo's semconv package (#12991)
This updates the calls to the collector's internal semconv package with otelgo's instead. The main difference is how the keys can be used, they will need to be cast as strings where they key name is needed, otherwise it's not a huge change. This would allow us to stop producing our own semconv package once contrib is moved as well. Related to #10346, #11828, #11807 --------- Signed-off-by: Alex Boten <[email protected]>
1 parent 5800834 commit 4ca0f18

File tree

22 files changed

+85
-75
lines changed

22 files changed

+85
-75
lines changed
Lines changed: 25 additions & 0 deletions
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: service
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: "Replace `go.opentelemetry.io/collector/semconv` usage with `go.opentelemetry.io/otel/semconv`"
11+
12+
# One or more tracking issues or pull requests related to the change
13+
issues: [12991]
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:
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/builder/internal/builder/main_test.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,6 @@ var replaceModules = []string{
109109
"/receiver/receivertest",
110110
"/receiver/receiverhelper",
111111
"/receiver/xreceiver",
112-
"/semconv",
113112
"/service",
114113
"/service/hostcapabilities",
115114
}

cmd/mdatagen/go.mod

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ require (
2323
go.opentelemetry.io/collector/receiver/receivertest v0.125.0
2424
go.opentelemetry.io/collector/scraper v0.125.0
2525
go.opentelemetry.io/collector/scraper/scrapertest v0.125.0
26-
go.opentelemetry.io/collector/semconv v0.125.0
26+
go.opentelemetry.io/otel v1.35.0
2727
go.opentelemetry.io/otel/metric v1.35.0
2828
go.opentelemetry.io/otel/sdk/metric v1.35.0
2929
go.opentelemetry.io/otel/trace v1.35.0
@@ -66,7 +66,6 @@ require (
6666
go.opentelemetry.io/collector/processor/xprocessor v0.125.0 // indirect
6767
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0 // indirect
6868
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
69-
go.opentelemetry.io/otel v1.35.0 // indirect
7069
go.opentelemetry.io/otel/log v0.11.0 // indirect
7170
go.opentelemetry.io/otel/sdk v1.35.0 // indirect
7271
go.uber.org/multierr v1.11.0 // indirect
@@ -95,8 +94,6 @@ replace go.opentelemetry.io/collector/pdata/testdata => ../../pdata/testdata
9594

9695
replace go.opentelemetry.io/collector/receiver => ../../receiver
9796

98-
replace go.opentelemetry.io/collector/semconv => ../../semconv
99-
10097
replace go.opentelemetry.io/collector/consumer => ../../consumer
10198

10299
replace go.opentelemetry.io/collector/receiver/receivertest => ../../receiver/receivertest

cmd/mdatagen/internal/sampleconnector/internal/metadata/generated_metrics.go

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplescraper/internal/metadata/generated_logs.go

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/samplescraper/internal/metadata/generated_metrics.go

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cmd/mdatagen/internal/templates/logs.go.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"go.opentelemetry.io/collector/{{ .Status.Class }}"
1111
{{- end }}
1212
{{- if .SemConvVersion }}
13-
conventions "go.opentelemetry.io/collector/semconv/v{{ .SemConvVersion }}"
13+
conventions "go.opentelemetry.io/otel/semconv/v{{ .SemConvVersion }}"
1414
{{- end }}
1515
)
1616

cmd/mdatagen/internal/templates/metrics.go.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"go.opentelemetry.io/collector/{{ .Status.Class }}"
1717
{{- end }}
1818
{{- if .SemConvVersion }}
19-
conventions "go.opentelemetry.io/collector/semconv/v{{ .SemConvVersion }}"
19+
conventions "go.opentelemetry.io/otel/semconv/v{{ .SemConvVersion }}"
2020
{{- end }}
2121
{{ if .ResourceAttributes -}}
2222
"go.opentelemetry.io/collector/filter"

cmd/otelcorecol/builder-config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,5 @@ replaces:
110110
- go.opentelemetry.io/collector/receiver/otlpreceiver => ../../receiver/otlpreceiver
111111
- go.opentelemetry.io/collector/receiver/receivertest => ../../receiver/receivertest
112112
- go.opentelemetry.io/collector/receiver/xreceiver => ../../receiver/xreceiver
113-
- go.opentelemetry.io/collector/semconv => ../../semconv
114113
- go.opentelemetry.io/collector/service => ../../service
115114
- go.opentelemetry.io/collector/service/hostcapabilities => ../../service/hostcapabilities

cmd/otelcorecol/go.mod

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,6 @@ require (
131131
go.opentelemetry.io/collector/receiver/receiverhelper v0.125.0 // indirect
132132
go.opentelemetry.io/collector/receiver/receivertest v0.125.0 // indirect
133133
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0 // indirect
134-
go.opentelemetry.io/collector/semconv v0.125.0 // indirect
135134
go.opentelemetry.io/collector/service v0.125.0 // indirect
136135
go.opentelemetry.io/collector/service/hostcapabilities v0.125.0 // indirect
137136
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
@@ -320,8 +319,6 @@ replace go.opentelemetry.io/collector/receiver/receivertest => ../../receiver/re
320319

321320
replace go.opentelemetry.io/collector/receiver/xreceiver => ../../receiver/xreceiver
322321

323-
replace go.opentelemetry.io/collector/semconv => ../../semconv
324-
325322
replace go.opentelemetry.io/collector/service => ../../service
326323

327324
replace go.opentelemetry.io/collector/service/hostcapabilities => ../../service/hostcapabilities

internal/e2e/go.mod

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ require (
108108
go.opentelemetry.io/collector/processor/xprocessor v0.125.0 // indirect
109109
go.opentelemetry.io/collector/receiver/receiverhelper v0.125.0 // indirect
110110
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0 // indirect
111-
go.opentelemetry.io/collector/semconv v0.125.0 // indirect
112111
go.opentelemetry.io/collector/service/hostcapabilities v0.125.0 // indirect
113112
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
114113
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
@@ -214,8 +213,6 @@ replace go.opentelemetry.io/collector/connector => ../../connector
214213

215214
replace go.opentelemetry.io/collector/connector/connectortest => ../../connector/connectortest
216215

217-
replace go.opentelemetry.io/collector/semconv => ../../semconv
218-
219216
replace go.opentelemetry.io/collector/processor => ../../processor
220217

221218
replace go.opentelemetry.io/collector/extension/zpagesextension => ../../extension/zpagesextension

otelcol/go.mod

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ require (
9090
go.opentelemetry.io/collector/pipeline/xpipeline v0.125.0 // indirect
9191
go.opentelemetry.io/collector/processor/xprocessor v0.125.0 // indirect
9292
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0 // indirect
93-
go.opentelemetry.io/collector/semconv v0.125.0 // indirect
9493
go.opentelemetry.io/collector/service/hostcapabilities v0.125.0 // indirect
9594
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
9695
go.opentelemetry.io/contrib/propagators/b3 v1.35.0 // indirect
@@ -158,8 +157,6 @@ replace go.opentelemetry.io/collector/processor => ../processor
158157

159158
replace go.opentelemetry.io/collector/consumer => ../consumer
160159

161-
replace go.opentelemetry.io/collector/semconv => ../semconv
162-
163160
replace go.opentelemetry.io/collector/receiver => ../receiver
164161

165162
replace go.opentelemetry.io/collector/featuregate => ../featuregate

otelcol/otelcoltest/go.mod

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ require (
8686
go.opentelemetry.io/collector/processor/xprocessor v0.125.0 // indirect
8787
go.opentelemetry.io/collector/receiver v1.31.0 // indirect
8888
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0 // indirect
89-
go.opentelemetry.io/collector/semconv v0.125.0 // indirect
9089
go.opentelemetry.io/collector/service/hostcapabilities v0.125.0 // indirect
9190
go.opentelemetry.io/contrib/bridges/otelzap v0.10.0 // indirect
9291
go.opentelemetry.io/contrib/otelconf v0.15.0 // indirect
@@ -163,8 +162,6 @@ replace go.opentelemetry.io/collector/extension => ../../extension
163162

164163
replace go.opentelemetry.io/collector/exporter => ../../exporter
165164

166-
replace go.opentelemetry.io/collector/semconv => ../../semconv
167-
168165
replace go.opentelemetry.io/collector/consumer/xconsumer => ../../consumer/xconsumer
169166

170167
replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/consumertest

service/go.mod

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ require (
4444
go.opentelemetry.io/collector/receiver v1.31.0
4545
go.opentelemetry.io/collector/receiver/receivertest v0.125.0
4646
go.opentelemetry.io/collector/receiver/xreceiver v0.125.0
47-
go.opentelemetry.io/collector/semconv v0.125.0
4847
go.opentelemetry.io/collector/service/hostcapabilities v0.125.0
4948
go.opentelemetry.io/contrib/otelconf v0.15.0
5049
go.opentelemetry.io/contrib/propagators/b3 v1.35.0
@@ -179,8 +178,6 @@ replace go.opentelemetry.io/collector/processor/processortest => ../processor/pr
179178

180179
replace go.opentelemetry.io/collector/consumer => ../consumer
181180

182-
replace go.opentelemetry.io/collector/semconv => ../semconv
183-
184181
replace go.opentelemetry.io/collector/service/hostcapabilities => ./hostcapabilities
185182

186183
replace go.opentelemetry.io/collector/receiver => ../receiver

service/hostcapabilities/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ replace (
8080
go.opentelemetry.io/collector/receiver => ../../receiver
8181
go.opentelemetry.io/collector/receiver/receivertest => ../../receiver/receivertest
8282
go.opentelemetry.io/collector/receiver/xreceiver => ../../receiver/xreceiver
83-
go.opentelemetry.io/collector/semconv => ../../semconv
83+
8484
go.opentelemetry.io/collector/service => ..
8585
)
8686

service/internal/resource/config.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import (
77
"github.com/google/uuid"
88
"go.opentelemetry.io/otel/attribute"
99
"go.opentelemetry.io/otel/sdk/resource"
10+
semconv "go.opentelemetry.io/otel/semconv/v1.18.0"
1011

1112
"go.opentelemetry.io/collector/component"
12-
semconv "go.opentelemetry.io/collector/semconv/v1.18.0"
1313
)
1414

1515
// New resource from telemetry configuration.
@@ -23,22 +23,22 @@ func New(buildInfo component.BuildInfo, resourceCfg map[string]*string) *resourc
2323
}
2424
}
2525

26-
if _, ok := resourceCfg[semconv.AttributeServiceName]; !ok {
26+
if _, ok := resourceCfg[string(semconv.ServiceNameKey)]; !ok {
2727
// AttributeServiceName is not specified in the config. Use the default service name.
28-
telAttrs = append(telAttrs, attribute.String(semconv.AttributeServiceName, buildInfo.Command))
28+
telAttrs = append(telAttrs, semconv.ServiceNameKey.String(buildInfo.Command))
2929
}
3030

31-
if _, ok := resourceCfg[semconv.AttributeServiceInstanceID]; !ok {
31+
if _, ok := resourceCfg[string(semconv.ServiceInstanceIDKey)]; !ok {
3232
// AttributeServiceInstanceID is not specified in the config. Auto-generate one.
3333
instanceUUID, _ := uuid.NewRandom()
3434
instanceID := instanceUUID.String()
35-
telAttrs = append(telAttrs, attribute.String(semconv.AttributeServiceInstanceID, instanceID))
35+
telAttrs = append(telAttrs, semconv.ServiceInstanceIDKey.String(instanceID))
3636
}
3737

38-
if _, ok := resourceCfg[semconv.AttributeServiceVersion]; !ok {
38+
if _, ok := resourceCfg[string(semconv.ServiceVersionKey)]; !ok {
3939
// AttributeServiceVersion is not specified in the config. Use the actual
4040
// build version.
41-
telAttrs = append(telAttrs, attribute.String(semconv.AttributeServiceVersion, buildInfo.Version))
41+
telAttrs = append(telAttrs, semconv.ServiceVersionKey.String(buildInfo.Version))
4242
}
4343
return resource.NewWithAttributes(semconv.SchemaURL, telAttrs...)
4444
}

service/internal/resource/config_test.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import (
1010
"github.com/stretchr/testify/assert"
1111
"github.com/stretchr/testify/require"
1212
sdkresource "go.opentelemetry.io/otel/sdk/resource"
13+
semconv "go.opentelemetry.io/otel/semconv/v1.18.0"
1314

1415
"go.opentelemetry.io/collector/component"
1516
"go.opentelemetry.io/collector/pdata/pcommon"
16-
semconv "go.opentelemetry.io/collector/semconv/v1.18.0"
1717
)
1818

1919
const (
@@ -125,21 +125,21 @@ func TestBuildResource(t *testing.T) {
125125
res := pdataFromSdk(otelRes)
126126

127127
assert.Equal(t, 3, res.Attributes().Len())
128-
value, ok := res.Attributes().Get(semconv.AttributeServiceName)
128+
value, ok := res.Attributes().Get("service.name")
129129
assert.True(t, ok)
130130
assert.Equal(t, buildInfo.Command, value.AsString())
131-
value, ok = res.Attributes().Get(semconv.AttributeServiceVersion)
131+
value, ok = res.Attributes().Get("service.version")
132132
assert.True(t, ok)
133133
assert.Equal(t, buildInfo.Version, value.AsString())
134134

135-
_, ok = res.Attributes().Get(semconv.AttributeServiceInstanceID)
135+
_, ok = res.Attributes().Get("service.instance.id")
136136
assert.True(t, ok)
137137

138138
// Check override by nil
139139
resMap = map[string]*string{
140-
semconv.AttributeServiceName: nil,
141-
semconv.AttributeServiceVersion: nil,
142-
semconv.AttributeServiceInstanceID: nil,
140+
string(semconv.ServiceNameKey): nil,
141+
string(semconv.ServiceVersionKey): nil,
142+
string(semconv.ServiceInstanceIDKey): nil,
143143
}
144144
otelRes = New(buildInfo, resMap)
145145
res = pdataFromSdk(otelRes)
@@ -150,21 +150,21 @@ func TestBuildResource(t *testing.T) {
150150
// Check override values
151151
strPtr := func(v string) *string { return &v }
152152
resMap = map[string]*string{
153-
semconv.AttributeServiceName: strPtr("a"),
154-
semconv.AttributeServiceVersion: strPtr("b"),
155-
semconv.AttributeServiceInstanceID: strPtr("c"),
153+
string(semconv.ServiceNameKey): strPtr("a"),
154+
string(semconv.ServiceVersionKey): strPtr("b"),
155+
string(semconv.ServiceInstanceIDKey): strPtr("c"),
156156
}
157157
otelRes = New(buildInfo, resMap)
158158
res = pdataFromSdk(otelRes)
159159

160160
assert.Equal(t, 3, res.Attributes().Len())
161-
value, ok = res.Attributes().Get(semconv.AttributeServiceName)
161+
value, ok = res.Attributes().Get("service.name")
162162
assert.True(t, ok)
163163
assert.Equal(t, "a", value.AsString())
164-
value, ok = res.Attributes().Get(semconv.AttributeServiceVersion)
164+
value, ok = res.Attributes().Get("service.version")
165165
assert.True(t, ok)
166166
assert.Equal(t, "b", value.AsString())
167-
value, ok = res.Attributes().Get(semconv.AttributeServiceInstanceID)
167+
value, ok = res.Attributes().Get("service.instance.id")
168168
assert.True(t, ok)
169169
assert.Equal(t, "c", value.AsString())
170170
}

0 commit comments

Comments
 (0)