Skip to content

Commit cdf67dd

Browse files
Aneurysm9MrAlias
Aneurysm9
and
MrAlias
authored
Update semantic conventions to v1.4.0, move to versioned package (open-telemetry#1987)
* Update semantic conventions to v1.4.0, move to versioned package Signed-off-by: Anthony J Mirabella <[email protected]> * precommit wants explicit import path renaming for semconv/v1.4.0 Signed-off-by: Anthony J Mirabella <[email protected]> * Fix semconv import path in stdout exporter example Signed-off-by: Anthony J Mirabella <[email protected]> Co-authored-by: Tyler Yahn <[email protected]>
1 parent 4883cb1 commit cdf67dd

31 files changed

+140
-33
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
8080
- Rename `NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/trace/zipkin` package. (#1985)
8181
- Rename `NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
8282
- Rename `NewUnstartedExporter` to `NewUnstarted` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
83+
- The `go.opentelemetry.io/otel/semconv` package has been moved to `go.opentelemetry.io/otel/semconv/v1.4.0` to allow for multiple [telemetry schema](https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md) versions to be used concurrently. (#1987)
8384

8485
### Deprecated
8586

‎RELEASING.md

+13
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ go run generator.go -i /path/to/specification/repo/semantic_conventions/trace
2020
Using default values for all options other than `input` will result in using the `template.j2` template to
2121
generate `resource.go` and `trace.go` in `/path/to/otelgo/repo/semconv/<version>`.
2222

23+
There are several ancillary files that are not generated and should be copied into the new package from the
24+
prior package, with updates made as appropriate to canonical import path statements and constant values.
25+
These files include:
26+
27+
* doc.go
28+
* exception.go
29+
* http(_test)?.go
30+
* schema.go
31+
32+
Uses of the previous schema version in this repository should be updated to use the newly generated version.
33+
No tooling for this exists at present, so use find/replace in your editor of choice or craft a `grep | sed`
34+
pipeline if you like living on the edge.
35+
2336
## Pre-Release
2437

2538
Update go.mod for submodules to depend on the new release which will happen in the next step.

‎bridge/opentracing/internal/mock.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323

2424
"go.opentelemetry.io/otel/attribute"
2525
"go.opentelemetry.io/otel/codes"
26-
"go.opentelemetry.io/otel/semconv"
26+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2727
"go.opentelemetry.io/otel/trace"
2828

2929
"go.opentelemetry.io/otel/bridge/opentracing/migration"

‎example/jaeger/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727
"go.opentelemetry.io/otel/exporters/trace/jaeger"
2828
"go.opentelemetry.io/otel/sdk/resource"
2929
tracesdk "go.opentelemetry.io/otel/sdk/trace"
30-
"go.opentelemetry.io/otel/semconv"
30+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3131
)
3232

3333
const (

‎example/otel-collector/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ import (
3737
"go.opentelemetry.io/otel/sdk/metric/selector/simple"
3838
"go.opentelemetry.io/otel/sdk/resource"
3939
sdktrace "go.opentelemetry.io/otel/sdk/trace"
40-
"go.opentelemetry.io/otel/semconv"
40+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
4141
"go.opentelemetry.io/otel/trace"
4242
)
4343

‎example/zipkin/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727
"go.opentelemetry.io/otel/exporters/trace/zipkin"
2828
"go.opentelemetry.io/otel/sdk/resource"
2929
sdktrace "go.opentelemetry.io/otel/sdk/trace"
30-
"go.opentelemetry.io/otel/semconv"
30+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3131
"go.opentelemetry.io/otel/trace"
3232
)
3333

‎exporters/stdout/example_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828
"go.opentelemetry.io/otel/sdk/metric/selector/simple"
2929
"go.opentelemetry.io/otel/sdk/resource"
3030
sdktrace "go.opentelemetry.io/otel/sdk/trace"
31-
"go.opentelemetry.io/otel/semconv"
31+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3232
"go.opentelemetry.io/otel/trace"
3333
)
3434

‎exporters/trace/jaeger/jaeger.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
gen "go.opentelemetry.io/otel/exporters/trace/jaeger/internal/gen-go/jaeger"
2727
"go.opentelemetry.io/otel/sdk/resource"
2828
sdktrace "go.opentelemetry.io/otel/sdk/trace"
29-
"go.opentelemetry.io/otel/semconv"
29+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3030
"go.opentelemetry.io/otel/trace"
3131
)
3232

‎exporters/trace/jaeger/jaeger_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import (
3535
"go.opentelemetry.io/otel/sdk/resource"
3636
sdktrace "go.opentelemetry.io/otel/sdk/trace"
3737
"go.opentelemetry.io/otel/sdk/trace/tracetest"
38-
"go.opentelemetry.io/otel/semconv"
38+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3939
"go.opentelemetry.io/otel/trace"
4040
)
4141

‎exporters/trace/zipkin/model.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424
"go.opentelemetry.io/otel/attribute"
2525
"go.opentelemetry.io/otel/codes"
2626
"go.opentelemetry.io/otel/sdk/resource"
27-
"go.opentelemetry.io/otel/semconv"
27+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2828
"go.opentelemetry.io/otel/trace"
2929

3030
zkmodel "github.com/openzipkin/zipkin-go/model"

‎exporters/trace/zipkin/model_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import (
3232
"go.opentelemetry.io/otel/sdk/resource"
3333
tracesdk "go.opentelemetry.io/otel/sdk/trace"
3434
"go.opentelemetry.io/otel/sdk/trace/tracetest"
35-
"go.opentelemetry.io/otel/semconv"
35+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3636
"go.opentelemetry.io/otel/trace"
3737
)
3838

‎exporters/trace/zipkin/zipkin_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import (
3434
"go.opentelemetry.io/otel/sdk/resource"
3535
sdktrace "go.opentelemetry.io/otel/sdk/trace"
3636
"go.opentelemetry.io/otel/sdk/trace/tracetest"
37-
"go.opentelemetry.io/otel/semconv"
37+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3838
"go.opentelemetry.io/otel/trace"
3939
)
4040

‎oteltest/span.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222

2323
"go.opentelemetry.io/otel/attribute"
2424
"go.opentelemetry.io/otel/codes"
25-
"go.opentelemetry.io/otel/semconv"
25+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2626
"go.opentelemetry.io/otel/trace"
2727
)
2828

‎oteltest/span_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727
ottest "go.opentelemetry.io/otel/internal/internaltest"
2828
"go.opentelemetry.io/otel/internal/matchers"
2929
"go.opentelemetry.io/otel/oteltest"
30-
"go.opentelemetry.io/otel/semconv"
30+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3131
"go.opentelemetry.io/otel/trace"
3232
)
3333

‎sdk/resource/auto_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
"github.com/stretchr/testify/assert"
2424

2525
"go.opentelemetry.io/otel/sdk/resource"
26-
"go.opentelemetry.io/otel/semconv"
26+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2727
)
2828

2929
func TestDetect(t *testing.T) {

‎sdk/resource/builtin.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222

2323
"go.opentelemetry.io/otel"
2424
"go.opentelemetry.io/otel/attribute"
25-
"go.opentelemetry.io/otel/semconv"
25+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2626
)
2727

2828
type (

‎sdk/resource/env.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
"strings"
2222

2323
"go.opentelemetry.io/otel/attribute"
24-
"go.opentelemetry.io/otel/semconv"
24+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2525
)
2626

2727
const (

‎sdk/resource/env_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import (
2424

2525
"go.opentelemetry.io/otel/attribute"
2626
ottest "go.opentelemetry.io/otel/internal/internaltest"
27-
"go.opentelemetry.io/otel/semconv"
27+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2828
)
2929

3030
func TestDetectOnePair(t *testing.T) {

‎sdk/resource/os.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
"context"
1919
"strings"
2020

21-
"go.opentelemetry.io/otel/semconv"
21+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2222
)
2323

2424
type osTypeDetector struct{}

‎sdk/resource/process.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import (
2222
"path/filepath"
2323
"runtime"
2424

25-
"go.opentelemetry.io/otel/semconv"
25+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2626
)
2727

2828
type pidProvider func() int

‎sdk/resource/resource_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import (
3131
"go.opentelemetry.io/otel/attribute"
3232
ottest "go.opentelemetry.io/otel/internal/internaltest"
3333
"go.opentelemetry.io/otel/sdk/resource"
34-
"go.opentelemetry.io/otel/semconv"
34+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3535
)
3636

3737
var (

‎sdk/trace/span.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323

2424
"go.opentelemetry.io/otel/attribute"
2525
"go.opentelemetry.io/otel/codes"
26-
"go.opentelemetry.io/otel/semconv"
26+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
2727
"go.opentelemetry.io/otel/trace"
2828

2929
"go.opentelemetry.io/otel/sdk/instrumentation"

‎sdk/trace/trace_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import (
3030
"go.opentelemetry.io/otel/attribute"
3131
"go.opentelemetry.io/otel/codes"
3232
"go.opentelemetry.io/otel/oteltest"
33-
"go.opentelemetry.io/otel/semconv"
33+
semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
3434
"go.opentelemetry.io/otel/trace"
3535

3636
"github.com/google/go-cmp/cmp"

‎semconv/doc.go ‎semconv/v1.4.0/doc.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@
1919
// the evolving OpenTelemetry specification and user feedback.
2020
//
2121
// OpenTelemetry semantic conventions are agreed standardized naming
22-
// patterns for OpenTelemetry things. This package aims to be the
23-
// centralized place to interact with these conventions.
24-
package semconv // import "go.opentelemetry.io/otel/semconv"
22+
// patterns for OpenTelemetry things. This package represents the conventions
23+
// as of the v1.4.0 version of the OpenTelemetry specification.
24+
package semconv // import "go.opentelemetry.io/otel/semconv/v1.4.0"

‎semconv/exception.go ‎semconv/v1.4.0/exception.go

File renamed without changes.

‎semconv/http.go ‎semconv/v1.4.0/http.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
package semconv // import "go.opentelemetry.io/otel/semconv"
15+
package semconv // import "go.opentelemetry.io/otel/semconv/v1.4.0"
1616

1717
import (
1818
"fmt"

‎semconv/http_test.go ‎semconv/v1.4.0/http_test.go

File renamed without changes.

‎semconv/resource.go ‎semconv/v1.4.0/resource.go

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

‎semconv/schema.go ‎semconv/v1.4.0/schema.go

+3-5
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515
package semconv
1616

1717
// SchemaURL is the schema URL that matches the version of the semantic conventions
18-
// that this package defines. This package defines semantic conventions for spec
19-
// v1.3.0 which was released before the concept of schemas was introduce, thus the
20-
// schema URL is empty. Semconv packages starting from v1.4.0 must declare non-empty
21-
// schema URL in the form https://opentelemetry.io/schemas/<version>
22-
const SchemaURL = ""
18+
// that this package defines. Semconv packages starting from v1.4.0 must declare
19+
// non-empty schema URL in the form https://opentelemetry.io/schemas/<version>
20+
const SchemaURL = "https://opentelemetry.io/schemas/v1.4.0"

‎semconv/trace.go ‎semconv/v1.4.0/trace.go

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

‎website_docs/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ span.SetAttributes(myKey.String("a value"))
6060

6161
### Semantic Attributes
6262

63-
Semantic Attributes are attributes that are defined by the OpenTelemetry Specification in order to provide a shared set of attribute keys across multiple languages, frameworks, and runtimes for common concepts like HTTP methods, status codes, user agents, and more. These attributes are available in the `go.opentelemetry.io/otel/semconv` package.
63+
Semantic Attributes are attributes that are defined by the OpenTelemetry Specification in order to provide a shared set of attribute keys across multiple languages, frameworks, and runtimes for common concepts like HTTP methods, status codes, user agents, and more. These attributes are available in the `go.opentelemetry.io/otel/semconv/v1.4.0` package.
6464

6565
Tracing semantic conventions can be found [in this document](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions)
6666

0 commit comments

Comments
 (0)