Flex is an application-agnostic, all-in-one New Relic integration that allows you to collect metric data from a wide variety of services. 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): to the terminal: you create a config file, start the Infrastructure agent, and data starts pouring into New Relic.
Flex works in two steps:
- It runs any HTTP request or shell command, with or without parameters, as defined in a YAML config file.
- It generates metric samples through functions that parse and tidy up the output from the commands/requests.
See the 200+ example integrations!
Only Linux is officially supported at the moment. Stay tuned for updates!
- Requirements
- Installation
- Getting started
- Example integrations
- Development
- Documentation
- Support
- License
- Linux
- Windows (experimental support)
- New Relic Infrastructure Pro subscription or trial
Flex now comes bundled with the New Relic Infrastructure agent.
To install the Infrastructure agent, see Install, configure, and manage Infrastructure.
The Flex step-by-step tutorial is a great starting point.
All examples are located in /examples.
Note that some examples may use features that are experimental (not officially supported) or deprecated.
Use the Flex manager in New Relic One to visualize Flex data and manage the Flex integration.
If you are setting up Flex configurations, you can use Flex in isolation mode, that is, without using the New Relic Infrastructure agent. For more information, see Development.
You can find more detailed documentation on our website.
If you can't find what you're looking for there, reach out to us on our support site or our community forum and we'll be happy to help you.
Found a bug? Contact us at support.newrelic.com
New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:
https://discuss.newrelic.com/c/support-products-agents/new-relic-infrastructure
Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.
The project is released under version 2.0 of the Apache license.