Sha256: e27d1d5ebce00ede8eafc4d1a2ece83ff6d7b292160411e9b4576dcfb86ddf63
Contents?: true
Size: 1.73 KB
Versions: 15
Compression:
Stored size: 1.73 KB
Contents
# PlainApm for Ruby
[PlainAPM][plainapm] monitors your Rails application and helps you
understand changes in its performance.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'plain_apm'
```
And then execute:
bundle install
Or install it yourself as:
gem install plain_apm
### Ractor and TracePoint issues on Ruby 3.0
PlainAPM extension to track object allocation on a per-thread basis is
built on top of Ruby's TracePoint API.
However, Rubies 3.0, 3.1, 3.2 and 3.3 as of January 2024 contain bugs
which, when Tracepoints are used in together with Ractors, can cause
crashes or inconsistent tracing results.
Build process for the native extension contains checks for presence of
these bugs and disables object allocation tracing accordingly.
If you are sure your app is not using Ractors, you can override this by
installing plain_apm with --enable-object-tracing-override flag:
gem install plain_apm -- --enable-object-tracing-override
When using bundler, you can configure it to pass this flag to gem
install by running:
bundle config set --global build.plain_apm --enable-object-tracing-override
See also:
- https://bugs.ruby-lang.org/issues/18464
- https://bugs.ruby-lang.org/issues/19112
## Usage
To be able to use the gem, collect, and view your app's performance
metrics, request an APP key on [plainapm web site][plainapm] and follow
the installation instructions.
## Contributing
Bug reports and pull requests are welcome on [GitHub][github-issues].
Alternatively, feel free to send questions, suggestions, and feedback
to [PlainAPM support][support-email].
[plainapm]: https://plainapm.com
[support-email]: mailto:support@plainapm.com
[github-issues]: https://github.com/plainapm/plainapm-ruby/issues
Version data entries
15 entries across 15 versions & 1 rubygems