https://github.com/newrelic/nri-flex
An application-agnostic, all-in-one New Relic integration integration
https://github.com/newrelic/nri-flex
api flex infrastructure ingest insights integration jmx nrlabs
Last synced: 29 days ago
JSON representation
An application-agnostic, all-in-one New Relic integration integration
- Host: GitHub
- URL: https://github.com/newrelic/nri-flex
- Owner: newrelic
- License: apache-2.0
- Created: 2019-03-04T19:14:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-01-29T19:31:18.000Z (about 1 month ago)
- Last Synced: 2026-01-30T07:54:40.207Z (about 1 month ago)
- Topics: api, flex, infrastructure, ingest, insights, integration, jmx, nrlabs
- Language: Go
- Homepage: https://docs.newrelic.com/docs/introduction-new-relics-flex-integration
- Size: 9.29 MB
- Stars: 121
- Watchers: 32
- Forks: 125
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/newrelic/nri-flex?branch=master)
# New Relic Flex
Flex is an application-agnostic, all-in-one [New Relic integration](https://docs.newrelic.com/docs/integrations) with which you can instrument any app that exposes metrics over a standard protocol (HTTP, file, shell) in a standard format (for example, JSON or plain text): you create a [config file](/docs/basics/configure.md), start the Infrastructure agent, and data starts pouring into New Relic.
Flex can take any input using [data source APIs](/docs/apis/README.md), process it through [functions](/docs/basics/functions.md), and send metric samples to New Relic as if they came from an integration.
For a quick introduction on Flex, [read our blog post](https://blog.newrelic.com/product-news/how-to-use-new-relic-flex/). You can also have a look at the [200+ example integrations](#example-integrations)!
## What you need
Flex requires a [New Relic account](https://docs.newrelic.com/docs/accounts/accounts-billing/account-setup/create-your-new-relic-account) and is compatible with the following operating systems/platforms:
- Linux
- Windows
- Kubernetes
For more information on compatible distros and versions, see the [Infrastructure agent compatibility page](https://docs.newrelic.com/docs/infrastructure/new-relic-infrastructure/getting-started/compatibility-requirements-new-relic-infrastructure).
## Installation
Flex comes bundled with the New Relic infrastructure agent. To install the infrastructure agent, see [Install the infrastructure agent](https://docs.newrelic.com/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent-new-relic).
If you're using Kubernetes, see [Configure Flex in Kubernetes](https://github.com/newrelic/nri-flex/blob/master/docs/basics/k8s_configure.md).
## Getting started
The [Flex step-by-step tutorial](./docs/basic-tutorial.md) is a great starting point.
### Example integrations
All examples are located in [/examples](https://github.com/newrelic/nri-flex/tree/master/examples).
> Note that some examples may use features that are [experimental](https://github.com/newrelic/nri-flex/tree/master/docs/experimental) (not officially supported) or [deprecated](https://github.com/newrelic/nri-flex/tree/master/docs/experimental).
### Documentation
- [Flex usage documentation](docs/README.md)
- [How to configure Flex](/docs/basics/configure.md)
- [Flex under Kubernetes](/docs/basics/k8s_configure.md)
- [Integration with Pixie](/examples/pixieExample/README.md)
- [Data sources / APIS](/docs/apis/README.md)
- [Data transformation functions](docs/basics/functions.md)
- [Experimental functions](docs/experimental/functions.md)
## Development
While developing your own Flex integrations, you can use Flex without the New Relic Infrastructure agent for debugging. For more information, see [Development](/docs/development.md).
## Support
Should you need assistance with New Relic products, you are in good hands with several support diagnostic tools and support channels.
If the issue has been confirmed as a bug or is a feature request, file a GitHub issue.
**Support Channels**
* Use the [Flex manager](https://github.com/newrelic/nr1-flex-manager) in New Relic One to visualize Flex data and manage the Flex integration.
* [New Relic Community](https://forum.newrelic.com/): The best place to engage in troubleshooting questions
* [New Relic Developer](https://developer.newrelic.com/): Resources for building a custom observability applications
* [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).
## Privacy
At 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.
We 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.
For more information, review [New Relic’s General Data Privacy Notice](https://newrelic.com/termsandconditions/privacy).
## Contribute
We encourage your contributions to improve this project! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.
If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at opensource@newrelic.com.
**A note about vulnerabilities**
As noted in our [security policy](../../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.
If 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 [HackerOne](https://hackerone.com/newrelic).
If you would like to contribute to this project, review [these guidelines](./CONTRIBUTING.md).
To all contributors, we thank you! Without your contribution, this project would not be what it is today.
## License
nri-flex is licensed under the [Apache 2.0](http://apache.org/licenses/LICENSE-2.0.txt) License.