Skip to content

Commit

Permalink
Clarify telemetry library resource attributes (#494)
Browse files Browse the repository at this point in the history
* Clarify telemetry library resource attributes

* Fix typo

Co-Authored-By: Wolfgang Ziegler <[email protected]>

* Clarify non-default SDK name

* `opentelemetry-sdk` -> `opentelemetry`

* Refine description

* Clarify responsibilities

Co-authored-by: Wolfgang Ziegler <[email protected]>
  • Loading branch information
arminru and z1c0 authored Mar 24, 2020
1 parent 4ab7c2f commit a6a6481
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions specification/data-resource-semantic-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document defines standard attributes for resources. These attributes are ty
[OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md).

* [Service](#service)
* [Library](#library)
* [Telemetry SDK](#telemetry-sdk)
* [Compute Unit](#compute-unit)
* [Container](#container)
* [Deployment Service](#deployment-service)
Expand Down Expand Up @@ -57,17 +57,26 @@ namespace = Company
service.name = Shop.shoppingcart
```

## Library
## Telemetry SDK

**type:** `library`
**type:** `telemetry.sdk`

**Description:** Telemetry library information.
**Description:** The telemetry SDK used to capture data recorded by the instrumentation libraries.

The default OpenTelemetry SDK provided by the OpenTelemetry project MUST set `telemetry.sdk.name`
to the value `opentelemetry`.

If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the attribute
`telemetry.sdk.name` 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.
The identifier SHOULD be stable across different versions of an implementation.

| Attribute | Description | Example | Required? |
|---|---|---|---|
| library.name | The name of the telemetry library. | `opentelemetry` | No |
| library.language | The language of telemetry library and of the code instrumented with it. <br/> The following spelling SHOULD be used for language strings: "cpp", "dotnet", "erlang", "go", "java", "nodejs", "php", "python", "ruby", "webjs" | `java` | No |
| library.version | The version string of the library as defined in [Version Attributes](#version-attributes). | `semver:1.2.3` | No |
| telemetry.sdk.name | The name of the telemetry SDK as defined above. | `opentelemetry` | 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 |

## Compute Unit

Expand Down

0 comments on commit a6a6481

Please sign in to comment.