-
Notifications
You must be signed in to change notification settings - Fork 183
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[chore] Move telemetry sdk to the registry (#873)
- Loading branch information
1 parent
7a4a7d7
commit 1d592b4
Showing
9 changed files
with
147 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| ---> | ||
|
|
||
| # Telemetry SDK | ||
|
|
||
| ## Telemetry SDK Attributes | ||
|
|
||
| <!-- semconv registry.telemetry(omit_requirement_level) --> | ||
| | Attribute | Type | Description | Examples | Stability | | ||
| |---|---|---|---|---| | ||
| | `telemetry.sdk.language` | string | The language of the telemetry SDK. | `cpp` |  | | ||
| | `telemetry.sdk.name` | string | The name of the telemetry SDK as defined above. [1] | `opentelemetry` |  | | ||
| | `telemetry.sdk.version` | string | The version string of the telemetry SDK. | `1.2.3` |  | | ||
| | `telemetry.distro.name` | string | The name of the auto instrumentation agent or distribution, if used. [2] | `parts-unlimited-java` |  | | ||
| | `telemetry.distro.version` | string | The version string of the auto instrumentation agent or distribution, if used. | `1.2.3` |  | | ||
|
|
||
| **[1]:** The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. | ||
| If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the | ||
| `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point | ||
| or another suitable identifier depending on the language. | ||
| The identifier `opentelemetry` is reserved and MUST NOT be used in this case. | ||
| All custom identifiers SHOULD be stable across different versions of an implementation. | ||
|
|
||
| **[2]:** Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to | ||
| a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. | ||
|
|
||
| `telemetry.sdk.language` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | ||
|
|
||
| | Value | Description | Stability | | ||
| |---|---|---| | ||
| | `cpp` | cpp |  | | ||
| | `dotnet` | dotnet |  | | ||
| | `erlang` | erlang |  | | ||
| | `go` | go |  | | ||
| | `java` | java |  | | ||
| | `nodejs` | nodejs |  | | ||
| | `php` | php |  | | ||
| | `python` | python |  | | ||
| | `ruby` | ruby |  | | ||
| | `rust` | rust |  | | ||
| | `swift` | swift |  | | ||
| | `webjs` | webjs |  | | ||
| <!-- endsemconv --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| groups: | ||
| - id: registry.telemetry | ||
| prefix: telemetry | ||
| type: attribute_group | ||
| brief: > | ||
| This document defines attributes for telemetry SDK. | ||
| attributes: | ||
| - id: sdk.name | ||
| type: string | ||
| stability: stable | ||
| requirement_level: required | ||
| brief: > | ||
| The name of the telemetry SDK as defined above. | ||
| note: | | ||
| The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. | ||
| If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the | ||
| `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point | ||
| or another suitable identifier depending on the language. | ||
| The identifier `opentelemetry` is reserved and MUST NOT be used in this case. | ||
| All custom identifiers SHOULD be stable across different versions of an implementation. | ||
| examples: ["opentelemetry"] | ||
| - id: sdk.language | ||
| type: | ||
| allow_custom_values: true | ||
| members: | ||
| - id: cpp | ||
| value: "cpp" | ||
| stability: stable | ||
| - id: dotnet | ||
| value: "dotnet" | ||
| stability: stable | ||
| - id: erlang | ||
| value: "erlang" | ||
| stability: stable | ||
| - id: go | ||
| value: "go" | ||
| stability: stable | ||
| - id: java | ||
| value: "java" | ||
| stability: stable | ||
| - id: nodejs | ||
| value: "nodejs" | ||
| stability: stable | ||
| - id: php | ||
| value: "php" | ||
| stability: stable | ||
| - id: python | ||
| value: "python" | ||
| stability: stable | ||
| - id: ruby | ||
| value: "ruby" | ||
| stability: stable | ||
| - id: rust | ||
| value: "rust" | ||
| stability: stable | ||
| - id: swift | ||
| value: "swift" | ||
| stability: stable | ||
| - id: webjs | ||
| value: "webjs" | ||
| stability: stable | ||
| stability: stable | ||
| requirement_level: required | ||
| brief: > | ||
| The language of the telemetry SDK. | ||
| - id: sdk.version | ||
| type: string | ||
| stability: stable | ||
| requirement_level: required | ||
| brief: > | ||
| The version string of the telemetry SDK. | ||
| examples: ["1.2.3"] | ||
| - id: distro.name | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The name of the auto instrumentation agent or distribution, if used. | ||
| note: | | ||
| Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to | ||
| a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. | ||
| examples: ["parts-unlimited-java"] | ||
| - id: distro.version | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The version string of the auto instrumentation agent or distribution, if used. | ||
| examples: ["1.2.3"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,12 @@ | ||
| groups: | ||
| - id: telemetry | ||
| prefix: telemetry | ||
| type: resource | ||
| brief: > | ||
| The telemetry SDK used to capture data recorded by the instrumentation libraries. | ||
| attributes: | ||
| - id: sdk.name | ||
| type: string | ||
| stability: stable | ||
| - ref: telemetry.sdk.name | ||
| requirement_level: required | ||
| brief: > | ||
| The name of the telemetry SDK as defined above. | ||
| note: | | ||
| The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. | ||
| If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the | ||
| `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point | ||
| or another suitable identifier depending on the language. | ||
| The identifier `opentelemetry` is reserved and MUST NOT be used in this case. | ||
| All custom identifiers SHOULD be stable across different versions of an implementation. | ||
| examples: ["opentelemetry"] | ||
| - id: sdk.language | ||
| type: | ||
| allow_custom_values: true | ||
| members: | ||
| - id: cpp | ||
| value: "cpp" | ||
| stability: stable | ||
| - id: dotnet | ||
| value: "dotnet" | ||
| stability: stable | ||
| - id: erlang | ||
| value: "erlang" | ||
| stability: stable | ||
| - id: go | ||
| value: "go" | ||
| stability: stable | ||
| - id: java | ||
| value: "java" | ||
| stability: stable | ||
| - id: nodejs | ||
| value: "nodejs" | ||
| stability: stable | ||
| - id: php | ||
| value: "php" | ||
| stability: stable | ||
| - id: python | ||
| value: "python" | ||
| stability: stable | ||
| - id: ruby | ||
| value: "ruby" | ||
| stability: stable | ||
| - id: rust | ||
| value: "rust" | ||
| stability: stable | ||
| - id: swift | ||
| value: "swift" | ||
| stability: stable | ||
| - id: webjs | ||
| value: "webjs" | ||
| stability: stable | ||
| stability: stable | ||
| - ref: telemetry.sdk.language | ||
| requirement_level: required | ||
| brief: > | ||
| The language of the telemetry SDK. | ||
| - id: sdk.version | ||
| type: string | ||
| stability: stable | ||
| - ref: telemetry.sdk.version | ||
| requirement_level: required | ||
| brief: > | ||
| The version string of the telemetry SDK. | ||
| examples: ["1.2.3"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,10 @@ | ||
| groups: | ||
| - id: telemetry_experimental | ||
| prefix: telemetry | ||
| type: resource | ||
| brief: > | ||
| The telemetry SDK used to capture data recorded by the instrumentation libraries. | ||
| attributes: | ||
| - id: distro.name | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The name of the auto instrumentation agent or distribution, if used. | ||
| note: | | ||
| Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to | ||
| a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. | ||
| examples: ["parts-unlimited-java"] | ||
| - id: distro.version | ||
| type: string | ||
| stability: experimental | ||
| brief: > | ||
| The version string of the auto instrumentation agent or distribution, if used. | ||
| examples: ["1.2.3"] | ||
| - ref: telemetry.distro.name | ||
| requirement_level: recommended | ||
| - ref: telemetry.distro.version | ||
| requirement_level: recommended |