Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove semver: prefix from instrumentation version #3798

Merged
merged 8 commits into from
May 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

- Add the new `go.opentelemetry.io/contrib/instrgen` package to provide auto-generated source code instrumentation. (#3068, #3108)

### Changed
9bany marked this conversation as resolved.
Show resolved Hide resolved

- Remove `semver:` prefix from instrumentation version. (#3681, #3798)

### Deprecated

- `SemVersion` functions in instrumentation packages are deprecated, use `Version` instead. (#3681, #3798)

## [1.16.1/0.41.1/0.10.1] - 2023-05-02

### Added
Expand Down
4 changes: 3 additions & 1 deletion detectors/aws/ec2/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
pellared marked this conversation as resolved.
Show resolved Hide resolved
func SemVersion() string {
return "semver:" + Version()
return Version()
}
4 changes: 3 additions & 1 deletion detectors/aws/ecs/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
4 changes: 3 additions & 1 deletion detectors/aws/eks/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
4 changes: 3 additions & 1 deletion detectors/gcp/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func newConfig(opts ...Option) config {

cfg.Tracer = cfg.TracerProvider.Tracer(
defaultTracerName,
trace.WithInstrumentationVersion(SemVersion()),
trace.WithInstrumentationVersion(Version()),
)

return cfg
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func TestNewConfig(t *testing.T) {
},
expected: config{
TracerProvider: tp,
Tracer: tp.Tracer(defaultTracerName, trace.WithInstrumentationVersion(SemVersion())),
Tracer: tp.Tracer(defaultTracerName, trace.WithInstrumentationVersion(Version())),
Propagators: otel.GetTextMapPropagator(),
},
},
Expand All @@ -70,7 +70,7 @@ func TestNewConfig(t *testing.T) {
},
expected: config{
TracerProvider: otel.GetTracerProvider(),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(SemVersion())),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(Version())),
Propagators: otel.GetTextMapPropagator(),
},
},
Expand All @@ -81,7 +81,7 @@ func TestNewConfig(t *testing.T) {
},
expected: config{
TracerProvider: otel.GetTracerProvider(),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(SemVersion())),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(Version())),
Propagators: prop,
},
},
Expand All @@ -92,7 +92,7 @@ func TestNewConfig(t *testing.T) {
},
expected: config{
TracerProvider: otel.GetTracerProvider(),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(SemVersion())),
Tracer: otel.GetTracerProvider().Tracer(defaultTracerName, trace.WithInstrumentationVersion(Version())),
Propagators: otel.GetTextMapPropagator(),
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func newInstrumentor(opts ...Option) instrumentor {
}

return instrumentor{configuration: cfg,
tracer: cfg.TracerProvider.Tracer(tracerName, trace.WithInstrumentationVersion(SemVersion())),
tracer: cfg.TracerProvider.Tracer(tracerName, trace.WithInstrumentationVersion(Version())),
resAttrs: []attribute.KeyValue{}}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ var (
attribute.String("faas.version", "$LATEST"),
attribute.String("faas.instance", "2023/01/01/[$LATEST]5d1edb9e525d486696cf01a3503487bc"),
attribute.Int("faas.max_memory", 128)),
InstrumentationLibrary: instrumentation.Library{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.SemVersion()},
InstrumentationLibrary: instrumentation.Library{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.Version()},
}
)

Expand Down Expand Up @@ -343,7 +343,7 @@ var (
attribute.String("faas.version", "$LATEST"),
attribute.String("faas.instance", "2023/01/01/[$LATEST]5d1edb9e525d486696cf01a3503487bc"),
attribute.Int("faas.max_memory", 128)),
InstrumentationLibrary: instrumentation.Library{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.SemVersion()},
InstrumentationLibrary: instrumentation.Library{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.Version()},
}
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ var (
})

expectedSpans = v1trace.ScopeSpans{
Scope: &v1common.InstrumentationScope{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.SemVersion()},
Scope: &v1common.InstrumentationScope{Name: "go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda", Version: otellambda.Version()},
Spans: []*v1trace.Span{{
TraceId: []byte{0x57, 0x59, 0xe9, 0x88, 0xbd, 0x86, 0x2e, 0x3f, 0xe1, 0xbe, 0x46, 0xa9, 0x94, 0x27, 0x27, 0x93},
SpanId: nil,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ func AppendMiddlewares(apiOptions *[]func(*middleware.Stack) error, opts ...Opti
}

m := otelMiddlewares{tracer: cfg.TracerProvider.Tracer(tracerName,
trace.WithInstrumentationVersion(SemVersion())),
trace.WithInstrumentationVersion(Version())),
propagator: cfg.TextMapPropagator,
attributeSetter: cfg.AttributeSetter}
*apiOptions = append(*apiOptions, m.initializeMiddlewareBefore, m.initializeMiddlewareAfter, m.finalizeMiddleware, m.deserializeMiddleware)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func NewClientWithTracing(client *memcache.Client, opts ...Option) *Client {
client,
cfg.tracerProvider.Tracer(
tracerName,
oteltrace.WithInstrumentationVersion(SemVersion()),
oteltrace.WithInstrumentationVersion(Version()),
),
context.Background(),
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func OTelFilter(service string, opts ...Option) restful.FilterFunction {
}
tracer := cfg.TracerProvider.Tracer(
tracerName,
oteltrace.WithInstrumentationVersion(SemVersion()),
oteltrace.WithInstrumentationVersion(Version()),
)
if cfg.Propagators == nil {
cfg.Propagators = otel.GetTextMapPropagator()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func Middleware(service string, opts ...Option) gin.HandlerFunc {
}
tracer := cfg.TracerProvider.Tracer(
tracerName,
oteltrace.WithInstrumentationVersion(SemVersion()),
oteltrace.WithInstrumentationVersion(Version()),
)
if cfg.Propagators == nil {
cfg.Propagators = otel.GetTextMapPropagator()
Expand Down Expand Up @@ -118,7 +118,7 @@ func HTML(c *gin.Context, code int, name string, obj interface{}) {
if !ok {
tracer = otel.GetTracerProvider().Tracer(
tracerName,
oteltrace.WithInstrumentationVersion(SemVersion()),
oteltrace.WithInstrumentationVersion(Version()),
)
}
savedContext := c.Request.Context()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func EndpointMiddleware(options ...Option) endpoint.Middleware {

tracer := cfg.TracerProvider.Tracer(
tracerName,
trace.WithInstrumentationVersion(SemVersion()),
trace.WithInstrumentationVersion(Version()),
)

return func(next endpoint.Endpoint) endpoint.Endpoint {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func NewSessionWithTracing(ctx context.Context, cluster *gocql.ClusterConfig, op
instruments := newInstruments(cfg.meterProvider)
tracer := cfg.tracerProvider.Tracer(
internal.InstrumentationName,
trace.WithInstrumentationVersion(SemVersion()),
trace.WithInstrumentationVersion(Version()),
)
cluster.QueryObserver = &OTelQueryObserver{
enabled: cfg.instrumentQuery,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ type instruments struct {
func newInstruments(p metric.MeterProvider) *instruments {
meter := p.Meter(
internal.InstrumentationName,
metric.WithInstrumentationVersion(SemVersion()),
metric.WithInstrumentationVersion(Version()),
)
instruments := &instruments{}
var err error
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ func getCluster() *gocql.ClusterConfig {
func assertScope(t *testing.T, sm metricdata.ScopeMetrics) {
assert.Equal(t, instrumentation.Scope{
Name: "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql",
Version: otelgocql.SemVersion(),
Version: otelgocql.Version(),
}, sm.Scope)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ func Version() string {
}

// SemVersion is the semantic version to be supplied to tracer/meter creation.
//
// Deprecated: Use [Version] instead.
func SemVersion() string {
return "semver:" + Version()
return Version()
}
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func Middleware(service string, opts ...Option) mux.MiddlewareFunc {
}
tracer := cfg.TracerProvider.Tracer(
tracerName,
trace.WithInstrumentationVersion(SemVersion()),
trace.WithInstrumentationVersion(Version()),
)
if cfg.Propagators == nil {
cfg.Propagators = otel.GetTextMapPropagator()
Expand Down
Loading