Should OpenTelemetry SDKs automatically generate a process.runtime.description resource attribute?

Recommendation

The OpenTelemetry Specification should mandate the automatic generation of the process.runtime.description resource attribute. While currently optional, mandating this attribute ensures consistent runtime identification across polyglot environments, allowing backend observability tools to filter and group telemetry by specific runtime versions without requiring manual configuration for every service.

Implementation Framework

To avoid the current inconsistency where some SDKs provide detailed versions and others provide generic names, the following standards should be applied:

• Value Format: SDKs should follow a <runtime-name> <version> pattern (e.g., OpenJDK 17.0.12 or Node.js 20.10.0). This provides a human-readable string that remains machine-parsable.
• Precedence: User-defined attributes must take precedence. If a user provides a process.runtime.description via environment variables (such as OTEL_RESOURCE_ATTRIBUTES), the SDK must not overwrite it.
• Opt-out Mechanism: SDKs should provide a configuration flag to disable automatic runtime detection for environments with extreme security constraints or overhead sensitivities.

Analysis of Trade-offs

The primary concern with mandating this attribute is the potential for breaking changes in existing SDKs that currently omit it. However, since this is an addition of data rather than a modification of existing fields, the impact is primarily on the backend storage (cardinality increase) rather than the application logic.

The overhead of retrieving the runtime description during SDK initialization is negligible, as this information is typically available in the process environment or via a single system call at startup.

Verification Steps

To verify the current behavior of an SDK before and after implementing these changes, use a console exporter to inspect the Resource object:

# Example: Checking for the attribute in a Java environment via environment variables
export OTEL_TRACES_EXPORTER=console
java -jar your-app.jar

Verify that the output contains a Resource block with process.runtime.description populated according to the <name> <version> format.

Missing Diagnostic Detail

To finalize the format specification, it is necessary to know if there are specific backend requirements for semantic versioning (SemVer) within the description string, or if a free-form string is sufficient for all target collectors.