opentelemetry-java-instrume.../instrumentation/resources/library
Jay DeLuca 5e5be42d05
Reduce flakyness of Resource tests (#12252)
2024-09-16 09:01:09 -07:00
..
src Reduce flakyness of Resource tests (#12252) 2024-09-16 09:01:09 -07:00
README.md Add declarative config support for resource providers (#12144) 2024-09-12 08:19:55 -07:00
build.gradle.kts Reduce flakyness of Resource tests (#12252) 2024-09-16 09:01:09 -07:00

README.md

OpenTelemetry Resource Providers

This package includes some standard ResourceProviders for filling in attributes related to common environments. Currently, the resources provide the following semantic conventions:

Populated attributes

Container

Provider: io.opentelemetry.instrumentation.resources.ContainerResource

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/container.md

Included in declarative config.

Implemented attributes:

  • container.id

Host

Provider: io.opentelemetry.instrumentation.resources.HostResource

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/host.md

Included in declarative config.

Implemented attributes:

  • host.name
  • host.arch

Provider: io.opentelemetry.instrumentation.resources.HostIdResourceProvider

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/host.md

Included in declarative config.

Implemented attributes:

  • host.id

Operating System

Provider: io.opentelemetry.instrumentation.resources.OsResource

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/os.md

Included in declarative config.

Implemented attributes:

  • os.type
  • os.description

Process

Implementation: io.opentelemetry.instrumentation.resources.ProcessResource

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/process.md#process

Included in declarative config.

Implemented attributes:

  • process.pid
  • process.executable.path (note, we assume the java binary is located in the bin subfolder of JAVA_HOME)
  • process.command_line (note this includes all system properties and arguments when running)

Java Runtime

Implementation: io.opentelemetry.instrumentation.resources.ProcessRuntimeResource

Specification: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/resource/process.md#process-runtimes

Included in declarative config.

Implemented attributes:

  • process.runtime.name
  • process.runtime.version
  • process.runtime.description

Platforms

This package currently does not run on Android. It has been verified on OpenJDK and should work on other server JVM distributions but if you find any issues please let us know.