OpenTelemetry Ruby

The Ruby OpenTelemetry client.

Contributing

We'd love your help! Use tags good first issue and help wanted to get started with the project.

The Ruby special interest group (SIG) meets regularly. See the OpenTelemetry community page repo for information on this and other language SIGs.

Developer Setup

1. Install Docker and Docker Compose for your operating system
2. Get the latest code for the project
3. Build the opentelemetry/opentelemetry-ruby image
   • docker-compose build
   • This makes the image available locally
4. API:
   1. Install dependencies
      • docker-compose run api bundle install
   2. Run the tests
      • docker-compose run api bundle exec rake test
5. SDK:
   1. Install dependencies
      • docker-compose run sdk bundle install
   2. Run the tests for the sdk
      • docker-compose run sdk bundle exec rake test

Docker Services

We use Docker Compose to configure and build services used in development and testing. See docker-compose.yml for specific configuration details.

The services provided are:

• app - main container environment scoped to the /app directory. Used primarily to build and tag the opentelemetry/opentelemetry-ruby:latest image.
• api - convenience environment scoped to the api gem in the /app/api directory.
• sdk - convenience environment scoped to the sdk gem in the /app/sdk directory.

Release Schedule

OpenTelemetry Ruby is under active development. Our goal is to release an alpha version of the library at the end of September 2019. This release isn't guaranteed to conform to a specific version of the specification, and future releases will not attempt to maintain backwards compatibility with the alpha release.

Component	Version	Target Date
Tracing API	Alpha	September 30 2019
Tracing SDK	Alpha	September 30 2019
Metrics API	Alpha	Unknown
Metrics SDK	Alpha	Unknown
Jaeger Trace Exporter	Alpha	Unknown
Prometheus Metrics Exporter	Alpha	Unknown
OpenTracing Bridge	Alpha	Unknown
OpenCensus Bridge	Alpha	Unknown

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For help or feedback on this project, join us on gitter.

License

Apache 2.0 - See LICENSE for more information.