From 745e0441b152c31932272cdb40081ae65037878a Mon Sep 17 00:00:00 2001 From: Craig Pastro Date: Thu, 23 Jun 2022 14:11:28 -0700 Subject: [PATCH 1/3] Move to using Instrumentation Scope --- sdk/instrumentation/library.go | 10 +--------- sdk/instrumentation/scope.go | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 sdk/instrumentation/scope.go diff --git a/sdk/instrumentation/library.go b/sdk/instrumentation/library.go index 6f0016169e3..ae8d524e70c 100644 --- a/sdk/instrumentation/library.go +++ b/sdk/instrumentation/library.go @@ -22,12 +22,4 @@ For more information see package instrumentation // import "go.opentelemetry.io/otel/sdk/instrumentation" // Library represents the instrumentation library. -type Library struct { - // Name is the name of the instrumentation library. This should be the - // Go package name of that library. - Name string - // Version is the version of the instrumentation library. - Version string - // SchemaURL of the telemetry emitted by the library. - SchemaURL string -} +type Library Scope diff --git a/sdk/instrumentation/scope.go b/sdk/instrumentation/scope.go new file mode 100644 index 00000000000..775de40e30c --- /dev/null +++ b/sdk/instrumentation/scope.go @@ -0,0 +1,33 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* +Package instrumentation provides an instrumentation scope structure to be +passed to both the OpenTelemetry Tracer and Meter components. + +For more information see +[this](https://github.com/open-telemetry/oteps/blob/main/text/0083-component.md). +*/ +package instrumentation // import "go.opentelemetry.io/otel/sdk/instrumentation" + +// Scope represents the instrumentation scope. +type Scope struct { + // Name is the name of the instrumentation scope. This should be the + // Go package name of that scope. + Name string + // Version is the version of the instrumentation scope. + Version string + // SchemaURL of the telemetry emitted by the scope. + SchemaURL string +} From d779b5b9eef41ad36306fe025bcb18452e9bbbae Mon Sep 17 00:00:00 2001 From: Craig Pastro Date: Thu, 23 Jun 2022 16:23:03 -0700 Subject: [PATCH 2/3] Use type alias, not definition --- sdk/instrumentation/library.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/instrumentation/library.go b/sdk/instrumentation/library.go index ae8d524e70c..ec6451849bf 100644 --- a/sdk/instrumentation/library.go +++ b/sdk/instrumentation/library.go @@ -22,4 +22,4 @@ For more information see package instrumentation // import "go.opentelemetry.io/otel/sdk/instrumentation" // Library represents the instrumentation library. -type Library Scope +type Library = Scope From 27b2edfc12a37f41a5728f3cad8687d375dba973 Mon Sep 17 00:00:00 2001 From: Craig Pastro Date: Fri, 24 Jun 2022 08:48:44 -0700 Subject: [PATCH 3/3] Add a changelog entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca0334fbcea..b502a1fb6b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Changed - The `crosslink` make target has been updated to use the `go.opentelemetry.io/build-tools/crosslink` package. (#2886) +- In the `go.opentelemetry.io/otel/sdk/instrumentation` package rename `Library` to `Scope` and alias `Library` as `Scope` (#2976) ### Removed