{"id":13747694,"url":"https://github.com/newrelic/newrelic-ruby-agent","last_synced_at":"2026-04-06T03:36:19.319Z","repository":{"id":37081730,"uuid":"70148","full_name":"newrelic/newrelic-ruby-agent","owner":"newrelic","description":"New Relic RPM Ruby Agent","archived":false,"fork":false,"pushed_at":"2025-05-06T19:17:05.000Z","size":40078,"stargazers_count":1199,"open_issues_count":148,"forks_count":604,"subscribers_count":45,"default_branch":"dev","last_synced_at":"2025-05-06T20:26:53.932Z","etag":null,"topics":["agent","apm-agent","hacktoberfest","ruby"],"latest_commit_sha":null,"homepage":"https://docs.newrelic.com/docs/apm/agents/ruby-agent/getting-started/introduction-new-relic-ruby/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/newrelic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2008-10-31T16:13:01.000Z","updated_at":"2025-05-06T19:17:05.000Z","dependencies_parsed_at":"2024-02-02T02:31:02.346Z","dependency_job_id":"f96d1f08-344e-4fdd-bfd5-1602c833e2d7","html_url":"https://github.com/newrelic/newrelic-ruby-agent","commit_stats":{"total_commits":16374,"total_committers":286,"mean_commits":57.25174825174825,"dds":0.8814584096738732,"last_synced_commit":"4e1d3e81a8d573fe5f3847b6e177dcd206e7599f"},"previous_names":["newrelic/rpm"],"tags_count":536,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic%2Fnewrelic-ruby-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic%2Fnewrelic-ruby-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic%2Fnewrelic-ruby-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/newrelic%2Fnewrelic-ruby-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/newrelic","download_url":"https://codeload.github.com/newrelic/newrelic-ruby-agent/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252841366,"owners_count":21812465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","apm-agent","hacktoberfest","ruby"],"created_at":"2024-08-03T06:01:38.178Z","updated_at":"2026-04-06T03:36:19.313Z","avatar_url":"https://github.com/newrelic.png","language":"Ruby","readme":"\u003ca href=\"https://opensource.newrelic.com/oss-category/#community-plus\"\u003e\u003cpicture\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png\"\u003e\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png\"\u003e\u003cimg alt=\"New Relic Open Source community plus project banner.\" src=\"https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png\"\u003e\u003c/picture\u003e\u003c/a\u003e\n\n# New Relic Ruby agent\n\nThe New Relic Ruby agent monitors your applications to help you\n[identify and solve performance issues](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#monitor-performance).\nYou can also extend the agent's performance monitoring to\n[collect and analyze business data](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby#business-data)\nto help you improve the customer experience and make data-driven business decisions.\n\nThe New Relic Ruby agent is dual-purposed as either a Gem or a Rails plugin,\nhosted on [GitHub](https://github.com/newrelic/newrelic-ruby-agent).\n\nThis code is actively maintained by New Relic engineering teams and delivered here in GitHub. See below for troubleshooting and defect reporting instructions.\n\n[![Gem Version](https://badge.fury.io/rb/newrelic_rpm.svg)](https://badge.fury.io/rb/newrelic_rpm)\n\n## Supported environments\n\nAn up-to-date list of Ruby versions and frameworks for the latest agent\ncan be found on [our docs site](https://docs.newrelic.com/docs/ruby/supported-frameworks).\n\nYou can also monitor non-web applications. Refer to the \"Other\nEnvironments\" section below.\n\n## Installing and using\n\nThe latest released gem for the Ruby agent can be found at [RubyGems.org](https://rubygems.org/gems/newrelic_rpm)\n\n### Quick start\n\n#### With Bundler\n\nFor using with Bundler, add the Ruby agent to your project's Gemfile.\n\n```ruby\ngem 'newrelic_rpm'\n```\n\nand run `bundle install` to activate the new gem.\n\n#### Without Bundler\n\nIf you are not using Bundler, install the gem with:\n\n```bash\ngem install newrelic_rpm\n```\n\nand then require the New Relic Ruby agent in your Ruby start-up sequence:\n\n```ruby\nrequire 'newrelic_rpm'\n```\n\n#### Other environments\n\nAssuming you have installed the agent per above, you may also need to tell the Ruby agent to start for some frameworks and non-framework environments. To do so, add the following to your Ruby start-up sequence start the agent:\n\n```ruby\nNewRelic::Agent.manual_start\n```\n\n### Complete install instructions\n\nFor complete documentation on installing the New Relic Ruby agent, see the following links:\n\n* [Introduction](https://docs.newrelic.com/docs/agents/ruby-agent/getting-started/introduction-new-relic-ruby)\n* [Install the New Relic Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent). See also these docs that cover specific install scenarios:\n  * [Rails plugin installation](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-installation-rails-plugin)\n  * [AWS Lambda](https://docs.newrelic.com/docs/serverless-function-monitoring/aws-lambda-monitoring/instrument-lambda-function/instrument-your-own/)\n  * [GAE Flexible Environment](https://docs.newrelic.com/docs/agents/ruby-agent/installation/install-new-relic-ruby-agent-gae-flexible-environment)\n  * [Pure Rack apps](https://docs.newrelic.com/docs/ruby/rack-middlewares)\n  * [Ruby agent and Heroku](https://docs.newrelic.com/docs/agents/ruby-agent/installation/ruby-agent-heroku)\n  * [Background jobs](https://docs.newrelic.com/docs/agents/ruby-agent/background-jobs/monitor-ruby-background-processes)\n* [Configure the agent](https://docs.newrelic.com/docs/agents/ruby-agent/configuration/ruby-agent-configuration)\n* [Update the agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/update-ruby-agent)\n* [Uninstall the Ruby agent](https://docs.newrelic.com/docs/agents/ruby-agent/installation/uninstall-ruby-agent)\n\n## Support\n\nShould you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.\n\nThis [troubleshooting guide](https://docs.newrelic.com/docs/apm/agents/ruby-agent/troubleshooting/no-data-appears-ruby/) walks you through common troubleshooting steps.\n\nNew Relic offers NRDiag, [a client-side diagnostic utility](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/troubleshooting/new-relic-diagnostics) that automatically detects common problems with New Relic agents. If NRDiag detects a problem, it suggests troubleshooting steps. NRDiag can also automatically attach troubleshooting data to a New Relic Support ticket.\n\nIf the issue has been confirmed as a bug or is a Feature request, please file a GitHub issue.\n\n**Support channels**\n\n* [New Relic Documentation](https://docs.newrelic.com/docs/agents/ruby-agent): Comprehensive guidance for using our platform\n* [New Relic Support](https://support.newrelic.com): The best place to engage in troubleshooting questions\n* [New Relic University](https://learn.newrelic.com/): A range of online training for New Relic users of every level\n* [New Relic Technical Support](https://support.newrelic.com/) 24/7/365 ticketed support. Read more about our [Technical Support Offerings](https://docs.newrelic.com/docs/licenses/license-information/general-usage-licenses/support-plan).\n\n## Privacy\n\nAt New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.\n\nWe define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address, and email address.\n\nPlease review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy) for more information.\n\n## Contributing\n\nWe encourage contributions to improve the New Relic Ruby agent! Keep in mind when you submit your pull request, you'll need to sign the Contributor License Agreement (CLA) via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.\nIf you have any questions, or to execute our corporate CLA (required if your contribution is on behalf of a company), please drop us an email at opensource@newrelic.com.\n\n**A note about vulnerabilities**\n\nAs noted in our [security policy](https://github.com/newrelic/newrelic-ruby-agent/security/policy), New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.\n\nIf you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through [our bug bounty program](https://docs.newrelic.com/docs/security/security-privacy/information-security/report-security-vulnerabilities/).\n\nIf you would like to contribute to this project, please review [these guidelines](https://github.com/newrelic/newrelic-ruby-agent/blob/main/CONTRIBUTING.md).\n\nTo [all contributors](https://github.com/newrelic/newrelic-ruby-agent/graphs/contributors), we thank you!  Without your contribution, this project would not be what it is today.  We also host a community project page dedicated to\nthe [New Relic Ruby agent](https://opensource.newrelic.com/projects/newrelic/newrelic-ruby-agent).\n\n## License\n\nAs of version 6.12 (released July 16, 2020), the New Relic Ruby agent is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for a copy of the license. For older agent versions, check the LICENSE file included with the source code.\n\nThe New Relic Ruby agent may use source code from third-party libraries. When used, these libraries will be outlined in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).\n\n## Thank you\n\nWe always look forward to connecting with the community. We welcome [contributions](https://github.com/newrelic/newrelic-ruby-agent#contributing) to our source code and suggestions for improvements, and would love to hear about what you like and want to see in the future.\n\nVisit our [project board](https://github.com/orgs/newrelic/projects/84/) to see what's upcoming in a future release, what we're currently working on, and what we're planning next.\n\nThank you,\n\nNew Relic Ruby agent team\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewrelic%2Fnewrelic-ruby-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnewrelic%2Fnewrelic-ruby-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnewrelic%2Fnewrelic-ruby-agent/lists"}