From f982bdb99ce7d1a8cc2e38eef7efaa2678737040 Mon Sep 17 00:00:00 2001 From: Mikel Blanchard Date: Thu, 22 Aug 2024 10:27:33 -0700 Subject: [PATCH] Code review. --- docs/attributes-registry/service.md | 6 +++--- docs/resource/README.md | 6 +++--- model/registry/service.yaml | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/attributes-registry/service.md b/docs/attributes-registry/service.md index 254b399841..0645820190 100644 --- a/docs/attributes-registry/service.md +++ b/docs/attributes-registry/service.md @@ -48,9 +48,9 @@ port. **[3]:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace. -**[4]:** When possible, service detector component MAY use -language/platform-specific capabilities to determine application -version and populate `service.version` automatically. +**[4]:** When possible, SDKs MAY use language/platform-specific capabilities to +determine application version and populate `service.version` +automatically. If `service.version` is provided explicitly it MUST take priority over the version determined automatically. diff --git a/docs/resource/README.md b/docs/resource/README.md index 9bef313158..b4028ebbe3 100644 --- a/docs/resource/README.md +++ b/docs/resource/README.md @@ -93,9 +93,9 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet **[1]:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. -**[2]:** When possible, service detector component MAY use -language/platform-specific capabilities to determine application -version and populate `service.version` automatically. +**[2]:** When possible, SDKs MAY use language/platform-specific capabilities to +determine application version and populate `service.version` +automatically. If `service.version` is provided explicitly it MUST take priority over the version determined automatically. diff --git a/model/registry/service.yaml b/model/registry/service.yaml index da4342b0c0..ee558fdb3e 100644 --- a/model/registry/service.yaml +++ b/model/registry/service.yaml @@ -21,9 +21,9 @@ groups: brief: > The version string of the service API or implementation. The format is not defined by these conventions. note: | - When possible, service detector component MAY use - language/platform-specific capabilities to determine application - version and populate `service.version` automatically. + When possible, SDKs MAY use language/platform-specific capabilities to + determine application version and populate `service.version` + automatically. If `service.version` is provided explicitly it MUST take priority over the version determined automatically.