elastic-apm

Elastic APM agent for Ruby

The official Rubygem for Elastic APM.

💡 We'd love to get feedback and information about your setup – please answer this ☑ short survey.

---

Documentation

Full documentation at elastic.co.

• Set up the Agent
  • Getting started with Rails
  • Getting started with Rack
• Supported technologies
• Configuration
• Advanced Topics
  • Adding additional context
  • Custom instrumentation
• API reference
• Metrics
• OpenTracing API
• GraphQL
• Log correlation
• Performance tuning
• Troubleshooting
• Upgrading
• Release notes
  • Ruby Agent version 4.x
  • Ruby Agent version 3.x
  • Ruby Agent version 2.x
  • Ruby Agent version 1.x
  • Ruby Agent version 0.x

---

Getting help

If you find a bug, please report an issue. For any other assistance, please open or add to a topic on the APM discuss forum.

Development

A Docker based setup is provided for development.

To run all specs in the official ruby:latest image:

$ bin/dev

To pick a specific Ruby version, specify it with the -i flag:

$ bin/dev -i jruby:9.2

If the first argument is a path starting with spec/, the passed specs will be run. Otherwise any arguments passed will be run as a command inside the container:

$ bin/dev -i jruby:9.2 spec/integration/rails_spec.rb   # ✅
$ bin/dev -i some_custom_image bash                     # ✅

To see all options:

$ bin/dev -h

License

Apache 2.0