The opentelemetry-semantic_conventions gem provides auto-generated constants that represent the OpenTelemetry Semantic Conventions.
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.
The opentelemetry-semantic_conventions gem provides auto-generated constants that represent the OpenTelemetry Semantic Conventions. They may be referenced in instrumentation or end-user code in place of hard-coding the names of the conventions. Because they are generated from the YAML models in the specification, they are kept up-to-date for you.
Install the gem using:
gem install opentelemetry-semantic_conventionsOr, if you use Bundler, include opentelemetry-semantic_conventions in your Gemfile.
require 'opentelemetry/semantic_conventions'
# Use the constants however you feel necessary, eg:
puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::CODE_LINENO}"Bump the version number in the Rakefile, and then run rake generate.
The opentelemetry-semantic_conventions 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 in GitHub Discussions 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.
The opentelemetry-semantic_conventions gem is distributed under the Apache 2.0 license. See LICENSE for more information.