Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elastic/apm-agent-ruby

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/elastic/apm-agent-ruby
Owner: elastic
License: apache-2.0
Created: 2017-11-01T13:21:05.000Z (almost 7 years ago)
Default Branch: main
Last Pushed: 2024-08-05T12:52:39.000Z (about 1 month ago)
Last Synced: 2024-08-05T14:20:05.161Z (about 1 month ago)
Language: Ruby
Homepage: https://www.elastic.co/solutions/apm
Size: 2.48 MB
Stars: 167
Watchers: 239
Forks: 131
Open Issues: 101
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.asciidoc
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: docs/supported-technologies.asciidoc

Awesome Lists containing this project

README

# elastic-apm

## Elastic APM agent for Ruby

[![ci](https://github.com/elastic/apm-agent-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/elastic/apm-agent-ruby/actions/workflows/ci.yml) [![Gem](https://img.shields.io/gem/v/elastic-apm.svg)](https://rubygems.org/gems/elastic-apm)

The official Rubygem for [Elastic][] [APM][].

💡 We'd love to get feedback and information about your setup – please answer this [☑ short survey](https://goo.gl/forms/LQktvn4rkLWBNSWy1).

---

## Documentation

[Full documentation at elastic.co](https://www.elastic.co/guide/en/apm/agent/ruby/current/index.html).

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

---

## Getting help

If you find a bug, please [report an issue](https://github.com/elastic/apm-agent-ruby/issues).
For any other assistance, please open or add to a topic on the [APM discuss forum](https://discuss.elastic.co/c/apm).

## Development

A Docker based setup is provided for development.

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

```sh
$ bin/dev
```

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

```sh
$ 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:

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

To see all options:

```sh
$ bin/dev -h
```

## License

Apache 2.0

[Elastic]: https://elastic.co
[APM]: https://www.elastic.co/guide/en/apm/server/index.html