Skip to content

Commit

Permalink
Clarify non-default SDK name
Browse files Browse the repository at this point in the history
  • Loading branch information
arminru committed Feb 28, 2020
1 parent 884b7dd commit 2b59403
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions specification/data-resource-semantic-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,16 +63,17 @@ service.name = Shop.shoppingcart

**Description:** The SDK used to produce telemetry data.

In OpenTelemetry, this is the OpenTelemetry SDK implementation being used.
If the default SDK provided by the OpenTelemetry project is used, `telemetry.sdk.name` MUST
be set to `opentelemetry-sdk`.
If another SDK, like a fork or a vendor-provided SDK is used, `telemetry.sdk.name` MUST be set
to the fully-qualified class or module name of that SDK's main entry point, depending on the language.
This value should be stable across different versions of an implementation.
If the default OpenTelemetry SDK provided by the OpenTelemetry project is used,
`telemetry.sdk.name` MUST be set to `opentelemetry-sdk`.
If another SDK, like a fork or a vendor-provided implementation, is used, `telemetry.sdk.name`
MUST be set to the fully-qualified class or module name of that SDK's main entry point
or another suitable identifier depending on the language.
The identifier `opentelemetry-sdk` is reserved and MUST NOT be used in this case.
The identifier SHOULD be stable across different versions of an implementation.

| Attribute | Description | Example | Required? |
|---|---|---|---|
| telemetry.sdk.name | The name of the telemetry SDK. | `opentelemetry-sdk` | No |
| telemetry.sdk.name | The name of the telemetry SDK as defined above. | `opentelemetry-sdk` | No |
| telemetry.sdk.language | The language of the telemetry SDK.<br/> One of the following values MUST be used, if one applies: "cpp", "dotnet", "erlang", "go", "java", "nodejs", "php", "python", "ruby", "webjs" | `java` | No |
| telemetry.sdk.version | The version string of the telemetry SDK as defined in [Version Attributes](#version-attributes). | `semver:1.2.3` | No |

Expand Down

0 comments on commit 2b59403

Please sign in to comment.