History

Rui Liu bfb1a64906 Fix container.id issue in some crio scenarios (#11382 )		2024-05-20 12:41:03 +03:00
..
src	Fix container.id issue in some crio scenarios (#11382 )	2024-05-20 12:41:03 +03:00
README.md	add host.id resource provider (#10627 )	2024-03-12 16:01:41 -07:00
build.gradle.kts	Semconv 1.21 (#9408 )	2023-09-13 19:20:23 +00: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

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

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

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

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

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

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.