OpenTelemetry::Resource::Detector::Container

The opentelemetry-resource-detector-container gem provides a container resource detector for OpenTelemetry.

What is OpenTelemetry?

OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.

OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.

How does this gem fit in?

The opentelemetry-resource-detector-container gem provides a means of retrieving a resource for supported environments following the resource semantic conventions.

How do I get started?

Install the gem using:

gem install opentelemetry-sdk
gem install opentelemetry-resource-detector-container

Or, if you use Bundler, include opentelemetry-sdk and opentelemetry-resource-detector-container in your Gemfile.

require 'opentelemetry/sdk'
require 'opentelemetry/resource/detector'

OpenTelemetry::SDK.configure do |c|
  c.resource = OpenTelemetry::Resource::Detector::Container.detect
end

This will populate the container.id resource attribute for processes running on containers. Further enrichment might be performed using the Kubernetes Attributes Processor in the OpenTelemetry Collector.

How can I get involved?

The opentelemetry-resource-detector-container gem source is on GitHub, along with related gems.

The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our GitHub Discussions, Slack Channel or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.

License

The opentelemetry-resource-detector-container gem is distributed under the Apache 2.0 license. See LICENSE for more information.