Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/last9/openapm-ruby
APM For Ruby using Open Source Tools
https://github.com/last9/openapm-ruby
apm grafana monitoring open-source prometheus rails ruby
Last synced: about 2 months ago
JSON representation
APM For Ruby using Open Source Tools
- Host: GitHub
- URL: https://github.com/last9/openapm-ruby
- Owner: last9
- License: apache-2.0
- Created: 2023-08-24T12:44:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-27T03:17:01.000Z (over 1 year ago)
- Last Synced: 2024-09-22T21:40:41.547Z (3 months ago)
- Topics: apm, grafana, monitoring, open-source, prometheus, rails, ruby
- Language: Ruby
- Homepage:
- Size: 22.5 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Openapm
APM for Rack based Ruby applications using Prometheus and Grafana.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'openapm'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install openapm
## Usage
### Rack application
```ruby
# config.ru
require 'rack'
require 'openapm/middleware'
use Rack::Deflater
use Openapm::Middleware
```
### Rails application
``` ruby
# config/initializers/openapm.rb
unless Rails.env.test?
require 'openapm/middleware'
Rails.application.middleware.unshift Openapm::Middleware
end
```
This will start emitting the RED metrics for HTTP requests on `/metrics` path which can be scraped by a Prometheus.
### Supported labels
1. `path` - HTTP request path, removes id and uuid from the request path.
2. `method` - HTTP method
3. `status` - HTTP status code. Eg. 404
4. `environment` - Rack or Rails enviornment set in the enviornment.
5. `program` - Application name, defaults to `web-application`. Can be customized by setting `Openapm.default_labels` hash.
### Additional labels
You can set additional labels by setting `Openapm.default_labels`
``` ruby
Openapm.default_labels = { service: 'web-service', stack: 'rails', team: 'platform' }
```
These labels will be added to each metric time series by default as static values.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/prathamesh-sonpatki/openapm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0).
## Code of Conduct
Everyone interacting in the Openapm project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/last9/openapm/blob/master/CODE_OF_CONDUCT.md).