New Relic integration - Universal Discovery (nri-universal-discovery)

Universal Discovery allows you to dynamically or manually define discovery items for Infrastructure Integrations. This discovery mechanism is particularly useful for agentless instrumentation and data collection, view the documentation for further information.

---

Create discovery options from the following sources:

• NRQL
• Entity Search
• Discovery File

---

Documentation

System Requirements

• A single Linux VM/Host/Machine to deploy too.
• New Relic Infrastructure Agent 1.15.0 or above (bundles Flex 1.3.9).
• Flex 1.3.9 or above.
• There are no strict requirements on the target remote machines or endpoints to collect from, other then having remote/network access.

Getting started

• Installing Universal Discovery
• Universal Discovery configuration options
• Testing returned discoveries
• Notes:
  • When using Flex and defining a remote command with FLEX_CMD_PREPEND place a space at the very end so that the command is not squashed next to any following parameter or subsequent command, view example.
  • With a Flex config, you do not need to supply the entire integrations config structure it should appear like this example.
• Examples
  • vSphere/vCenter Agentless Remote Execution
  • SSH Agentless Remote Execution
    • Agentless EBPF
    • AWS EC2 Agentless Remote Execution
  • Windows Remote Execution with winexe
    • Agentless Typeperf Metrics
    • Agentless WMI/WMIC/GWMI Metrics
  • Discovery File Format
  • Decorator File Format
  • Applying Metadata
• Defining multiple integrations for a single discovery
• Optimizing discovery performance
• Securing credentials
• Configure multiple discovery integrations
• Manually updating Flex
• Troubleshooting

---

Installation

Download the latest nri-universal-discovery package from the releases section and run the installer.

Example commands:

# extract the package
tar -xvf nri-universal-discovery-<version>.tar.gz

# enter the directory
cd nri-universal-discovery-<version>

# run the installer
sudo ./install_linux-x86_64.sh

The binary should now be available in the below location:

/var/db/newrelic-infra/nri-universal-discovery

---

Building

Setup

make setup

Linux

make build-linux

Windows

make build-windows

---

Testing

cargo test
or
make test

---

Support

New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub. We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

Contributing

We encourage your contributions to improve nri-universal-discovery! Keep in mind 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, required if your contribution is on behalf of a company, please drop us an email at opensource@newrelic.com.

A note about vulnerabilities

As noted in our 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.

License

nri-universal-discovery is licensed under the Apache 2.0 License.