nri-flex

README

New Relic Flex

Flex is an application-agnostic, all-in-one New Relic integration 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, start the Infrastructure agent, and data starts pouring into New Relic.

Flex can take any input using data source APIs, process it through functions, and send metric samples to New Relic as if they came from an integration:

For a quick introduction on Flex, read our blog post. You can also have a look at the 200+ example integrations!

• Requirements
• Installation
• Getting started
• Example integrations
• Development
• Documentation
• Support
• License

Compatibility and requirements

Flex requires a New Relic Infrastructure Pro subscription or trial and is compatible with the following operating systems:

• Linux
• Windows (Experimental)

For more information on compatible distros and versions, see the Infrastructure agent compatibility page.

Installation

Flex comes bundled with the New Relic Infrastructure agent. To install the Infrastructure agent, see Install, configure, and manage Infrastructure.

Getting started

The Flex step-by-step tutorial is a great starting point.

Example integrations

All examples are located in /examples.

Note that some examples may use features that are experimental (not officially supported) or deprecated.

Development

While developing your own Flex integrations, you can use Flex without the New Relic Infrastructure agent for debugging. For more information, see Development.

Documentation

• Flex documentation - Main page
• Configure Flex
• Data sources / APIS
• Data transformation functions
• Experimental functions

Flex Manager

Use the Flex manager in New Relic One to visualize Flex data and manage the Flex integration.

Support

Need help? See our troubleshooting page. You can find more detailed documentation on the New Relic docs site.

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

Community

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 / Enhancement Requests

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.

License

The project is released under version 2.0 of the Apache license.