Add `OTEL_SERVICE_NAME` environment variable #1677

iNikem · 2021-05-07T10:32:35Z

Closes #709

Changes

Add OTEL_SERVICE_NAME environment variable to SDK configuration

Closes #709

arminru

@SergeyKanzhelev You seemed to have a strong opinion on #709, so please take a look at this proposal.

specification/sdk-environment-variables.md

arminru · 2021-05-07T13:09:21Z

specification/sdk-environment-variables.md

@@ -32,6 +32,7 @@ For example, the value `12000` indicates 12000 milliseconds, i.e., 12 seconds.
 | Name                     | Description                                       | Default                           | Notes                               |
 | ------------------------ | ------------------------------------------------- | --------------------------------- | ----------------------------------- |
 | OTEL_RESOURCE_ATTRIBUTES | Key-value pairs to be used as resource attributes |                                   | See [Resource SDK](./resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. |
+| OTEL_SERVICE_NAME        | Sets the value of the [`service.name`](./resource/semantic_conventions/README.md#service) resource attribute | | If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES` then `OTEL_SERVICE_NAME` takes precedence. |


Should we also add OTEL_SERVICE_VERSION or add a note that service.version can be set via OTEL_RESOURCE_ATTRIBUTES?

I usually prefer to keep PR scope small, if possible. This PR solves one specific issue. I am happy to file a follow-up one, if you feel this is needed :)

That's reasonable. If we add it, it would ideally be in the same spec version, however, so SDK maintainers/implementers can tackle this tightly coupled feature at once. The next release is scheduled for early June, so we should be good here, as the follow-up should be as uncontroversial as this PR.

Same as #1677 (comment): I don't think the service version is used often enough to warrant it's own attribute. We did receive user requests for service.name AFAIK, but not for any others.

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

specification/sdk-environment-variables.md

SergeyKanzhelev

I am ok with the suggestion, but before merging, let's clarify whether environment variable should take precedence over the value set in code.

Spec PR: open-telemetry/opentelemetry-specification#1677

bogdandrutu · 2021-05-10T22:16:01Z

CHANGELOG.md

@@ -23,6 +23,8 @@ release.

 ### SDK Configuration

+- Add `OTEL_SERVICE_NAME` environment variable. ([#1677](https://github.com/open-telemetry/opentelemetry-specification/pull/1677))


I would add NAMESPACE and INSTANCE as well. Service name should not be treated special than the others.

I usually prefer to keep PR scope small, if possible. This PR solves one specific issue. I am happy to file a follow-up one, if you feel this is needed :)

I have never heard of anyone using namespace (but maybe it just works so well that there are no questions?). instance.id has is currently IMHO too vaguely defined to be useful, as discussed in #1034. So the service name is IMHO definitely the most useful one.

(If exporter specs are updated to include service.namespace in their reported service, which maybe they should, then adding a special envvar for service.namespace might make sense)

If exporter specs are updated to include service.namespace in their reported service, which maybe they should, then adding a special envvar for service.namespace might make sense

I think the "service name" as defined right now is unique within a namespace, and the fact that Jaeger/Zipkin don't have this concept made us use just "service name" which is wrong.

@Oberon00 I agree that exporters that only have a "service name" concept should use actually "{service.namespace}/{service.name}" as the name.

https://github.com/open-telemetry/opentelemetry-specification/blob/d001d5d25ea11a28bd4c4ec2652e2db1a41fc064/specification/trace/sdk_exporters/zipkin.md#:~:text=note%2C%20the%20attribute%20service.namespace%20must%20not%20be%20used%20for%20the%20zipkin%20service%20name%20and%20should%20be%20sent%20as%20a%20zipkin%20tag.

Note, the attribute service.namespace MUST NOT be used for the Zipkin service name and should be sent as a Zipkin tag.

https://github.com/open-telemetry/opentelemetry-specification/blob/b46bcab5fb709381f1fd52096a19541370c7d1b3/specification/resource/semantic_conventions/README.md#:~:text=Note,same%20string

Note: service.namespace and service.name are not intended to be concatenated for the purpose of forming a single globally unique name for the service. For example the following 2 sets of attributes actually describe 2 different services (despite the fact that the concatenation would result in the same string):

We can change that, but it was intentionally not suppose to be concatenated to avoid the need to parse the namespace out of the name

I do understand that, and I've just added an open question to my PR. I think in case of one value string like Jaeger/Zipkin we have to guarantee the uniqueness somehow, otherwise we will have conflicts. For example 2 service names named "kafka" run by 2 teams/namespaces "a" and "b" will be seen as same service by these backends.

happy to change that. Given that namespace is empty in many cases now it is not such a breaking change

Does this discussion/related PR block this PR from merging?

bogdandrutu

Question that is not answer:

Why service name is treated differently than any other resource attribute?

Spec PR: open-telemetry/opentelemetry-specification#1677

iNikem · 2021-05-11T11:56:41Z

Question that is not answer:

Why service name is treated differently than any other resource attribute?

It is the only de-facto "required" resource attribute
The majority of vendors already have similar variable (Add OTEL_SERVICE_NAME env variable #709 (comment)), so this is what end-users already expect
This PR does not preclude any other PR which adds support for other resource attributes.

iNikem · 2021-05-11T14:33:32Z

Question that is not answer:
Why service name is treated differently than any other resource attribute?

It is the only de-facto "required" resource attribute

The majority of vendors already have similar variable (#709 (comment)), so this is what end-users already expect

This PR does not preclude any other PR which adds support for other resource attributes.

Based on #1677 (comment) I will submit the PR about OTEL_SERVICE_VERSION after this one is merged.

iNikem · 2021-05-14T07:58:03Z

@bogdandrutu as discussed during spec SIG meeting, I tried to stress the significance of this specific attribute. Please check my changes in README.md

Oberon00 · 2021-05-14T08:04:45Z

CHANGELOG.md

@@ -23,6 +23,8 @@ release.

 ### SDK Configuration

+- Add `OTEL_SERVICE_NAME` environment variable. ([#1677](https://github.com/open-telemetry/opentelemetry-specification/pull/1677))


I have never heard of anyone using namespace (but maybe it just works so well that there are no questions?). instance.id has is currently IMHO too vaguely defined to be useful, as discussed in #1034. So the service name is IMHO definitely the most useful one.

specification/resource/semantic_conventions/README.md

carlosalberto · 2021-05-17T14:20:07Z

Ping @bogdandrutu

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

carlosalberto · 2021-05-20T12:24:13Z

@bogdandrutu ;)

Personally still believe we should not make this special but I would let the majority decide, I would not block but disagree with the change

iNikem · 2021-05-23T07:18:07Z

@open-telemetry/technical-committee Anybody feeling confident enough to merge this?

carlosalberto · 2021-05-24T13:52:23Z

@bogdandrutu Thanks for going on with the compromise, really appreciated. Merging (we will see in the long run how things unfold! ;) )

iNikem added 2 commits May 7, 2021 10:57

Add OTEL_SERVICE_NAME environment variable

22cc59f

Closes #709

Add changelog

987e435

iNikem requested review from a team as code owners May 7, 2021 10:32

github-actions bot assigned arminru May 7, 2021

Update PR link in changelog

1e47163

iNikem mentioned this pull request May 7, 2021

Ease process for setting service.name signalfx/gdi-specification#78

Closed

pellared approved these changes May 7, 2021

View reviewed changes

arminru reviewed May 7, 2021

View reviewed changes

specification/sdk-environment-variables.md Outdated Show resolved Hide resolved

specification/sdk-environment-variables.md Outdated Show resolved Hide resolved

specification/sdk-environment-variables.md Outdated Show resolved Hide resolved

iNikem added 2 commits May 7, 2021 15:46

Polish text

df4cddc

Polishing text

239dc6d

arminru reviewed May 7, 2021

View reviewed changes

arminru requested a review from SergeyKanzhelev May 7, 2021 13:10

owais approved these changes May 7, 2021

View reviewed changes

Update specification/sdk-environment-variables.md

6c9278c

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

jkwatson approved these changes May 7, 2021

View reviewed changes

MrAlias approved these changes May 7, 2021

View reviewed changes

tigrannajaryan approved these changes May 7, 2021

View reviewed changes

SergeyKanzhelev reviewed May 7, 2021

View reviewed changes

specification/sdk-environment-variables.md Show resolved Hide resolved

SergeyKanzhelev suggested changes May 7, 2021

View reviewed changes

SergeyKanzhelev approved these changes May 7, 2021

View reviewed changes

yurishkuro approved these changes May 7, 2021

View reviewed changes

owais added a commit to owais/opentelemetry-python that referenced this pull request May 7, 2021

Add support for OTEL_SERVICE_NAME env var.

a4f9f02

Spec PR: open-telemetry/opentelemetry-specification#1677

owais mentioned this pull request May 7, 2021

Add support for OTEL_SERVICE_NAME env var. open-telemetry/opentelemetry-python#1829

Merged

11 tasks

owais added a commit to owais/opentelemetry-python that referenced this pull request May 7, 2021

Add support for OTEL_SERVICE_NAME env var.

0c8e0b7

Spec PR: open-telemetry/opentelemetry-specification#1677

owais added a commit to owais/opentelemetry-python that referenced this pull request May 7, 2021

Add support for OTEL_SERVICE_NAME env var.

c409212

Spec PR: open-telemetry/opentelemetry-specification#1677

anuraaga approved these changes May 8, 2021

View reviewed changes

owais added a commit to owais/opentelemetry-python that referenced this pull request May 10, 2021

Add support for OTEL_SERVICE_NAME env var.

c31bd4b

Spec PR: open-telemetry/opentelemetry-specification#1677

owais added a commit to owais/opentelemetry-python that referenced this pull request May 10, 2021

Add support for OTEL_SERVICE_NAME env var.

7e8ea37

Spec PR: open-telemetry/opentelemetry-specification#1677

codeboten pushed a commit to open-telemetry/opentelemetry-python that referenced this pull request May 10, 2021

Add support for OTEL_SERVICE_NAME env var. (#1829)

f7358e9

Spec PR: open-telemetry/opentelemetry-specification#1677

bogdandrutu reviewed May 10, 2021

View reviewed changes

bogdandrutu previously requested changes May 10, 2021

View reviewed changes

owais added a commit to owais/opentelemetry-python that referenced this pull request May 11, 2021

Add support for OTEL_SERVICE_NAME env var. (open-telemetry#1829)

a557c28

Spec PR: open-telemetry/opentelemetry-specification#1677

iNikem added 2 commits May 14, 2021 10:55

More clearly say that service.name is a special attribute

0d91482

Merge remote-tracking branch 'origin/iNikem-patch-1' into iNikem-patch-1

cb734a9

Oberon00 approved these changes May 14, 2021

View reviewed changes

iNikem requested a review from bogdandrutu May 17, 2021 08:01

arminru reviewed May 17, 2021

View reviewed changes

specification/resource/semantic_conventions/README.md Outdated Show resolved Hide resolved

bogdandrutu mentioned this pull request May 18, 2021

Use service.namespace in Jager's service name if present #1710

Closed

Update specification/resource/semantic_conventions/README.md

dda6729

Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>

trask approved these changes May 20, 2021

View reviewed changes

Merge remote-tracking branch 'upstream/main' into iNikem-patch-1

9169d40

Merge branch 'main' into iNikem-patch-1

058d606

carlosalberto merged commit ccbfdd9 into main May 24, 2021

carlosalberto deleted the iNikem-patch-1 branch May 24, 2021 13:54

iNikem mentioned this pull request May 24, 2021

Add support for OTEL_SERVICE_NAME open-telemetry/opentelemetry-java#3249

Closed

jtescher mentioned this pull request May 24, 2021

Expand support for OTEL_SERVICE_NAME open-telemetry/opentelemetry-rust#558

Closed

evantorrie mentioned this pull request Jun 3, 2021

Enable Resource service.name detection from OTEL_SERVICE_NAME environment variable open-telemetry/opentelemetry-go#1968

Closed

fbogsany mentioned this pull request Jun 8, 2021

fix: support OTEL_SERVICE_NAME env var open-telemetry/opentelemetry-ruby#806

Merged

breedx-splk mentioned this pull request Jul 13, 2021

Support OTEL_SERVICE_NAME signalfx/splunk-otel-java#353

Merged

breedx-splk mentioned this pull request Aug 23, 2021

Changelog, metrics manual instrumentation docs, and 1.3.0 pre-release changes signalfx/splunk-otel-java#421

Merged

ssheng mentioned this pull request May 2, 2023

feat: Observability enhancement in tracing and logging bentoml/BentoML#3818

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `OTEL_SERVICE_NAME` environment variable #1677

Add `OTEL_SERVICE_NAME` environment variable #1677

iNikem commented May 7, 2021

arminru left a comment

arminru May 7, 2021

iNikem May 7, 2021

arminru May 11, 2021

Oberon00 May 14, 2021

SergeyKanzhelev left a comment

bogdandrutu May 10, 2021

iNikem May 11, 2021

Oberon00 May 14, 2021

Oberon00 May 14, 2021

bogdandrutu May 18, 2021 •

edited

Loading

SergeyKanzhelev May 18, 2021

SergeyKanzhelev May 18, 2021

bogdandrutu May 18, 2021

SergeyKanzhelev May 18, 2021

iNikem May 18, 2021

bogdandrutu left a comment

iNikem commented May 11, 2021

iNikem commented May 11, 2021

iNikem commented May 14, 2021

Oberon00 May 14, 2021

carlosalberto commented May 17, 2021

carlosalberto commented May 20, 2021

iNikem commented May 23, 2021

carlosalberto commented May 24, 2021

		@@ -23,6 +23,8 @@ release.

		### SDK Configuration

		- Add `OTEL_SERVICE_NAME` environment variable. ([#1677](https://github.com/open-telemetry/opentelemetry-specification/pull/1677))

Add OTEL_SERVICE_NAME environment variable #1677

Add OTEL_SERVICE_NAME environment variable #1677

Conversation

iNikem commented May 7, 2021

Changes

arminru left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SergeyKanzhelev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bogdandrutu May 18, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bogdandrutu left a comment

Choose a reason for hiding this comment

iNikem commented May 11, 2021

iNikem commented May 11, 2021

iNikem commented May 14, 2021

Choose a reason for hiding this comment

carlosalberto commented May 17, 2021

carlosalberto commented May 20, 2021

iNikem commented May 23, 2021

carlosalberto commented May 24, 2021

Add `OTEL_SERVICE_NAME` environment variable #1677

Add `OTEL_SERVICE_NAME` environment variable #1677

bogdandrutu May 18, 2021 •

edited

Loading