New Relic guided install overview

If you haven't already, sign up for a free New Relic account so you can instrument your systems and send telemetry data to New Relic. Our guided install creates a customized CLI command for your environment that downloads and installs the New Relic CLI and the infrastructure agent.

Ready to get started? Click the Guided install button. Or, if your account reports data through our EU data center, click EU Guided install.

Guided install

EU Guided install

Our infrastructure agent discovers the applications and infrastructure and log sources running in your environment, and recommends which ones should be instrumented. The install automates the configuration and deployment of each system you choose to instrument.

Why it matters

With our guided install, you can instrument your applications and infrastructure and start seeing your data in New Relic in minutes.

The guided install uses our command line interface (CLI), the infrastructure agent for your host environment, and a library of installation recipes to instrument your applications and infrastructure for you. That means less toil for you.

Because our instrumentation recipes are open source, you can modify existing recipes, or build new ones, to suit your needs.

Some technical detail

The New Relic guided install uses open source installation recipes to instrument on-host integrations. These recipes include installation and setup commands, information about logs, and metadata related to what’s being installed. They're collected in a YAML file for each type of system and have all of the installation details necessary to install the infrastructure agent for a specific integration.

Important

On Windows, our guided install only supports Microsoft SQL Server, logs, and the infrastructure agent.

All other integrations are only supported on Linux.

On-host integration (OHI) recipes

The guided install automates the discovery, configuration, and installation of OHIs. However, there may be times when you want to instrument them one-by-one using the CLI install command.

To install any individual on-host integration, run this command:

curl -Ls https://raw.githubusercontent.com/newrelic/newrelic-cli/master/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=API_KEY NEW_RELIC_ACCOUNT_ID=ACCOUNT_ID /usr/local/bin/newrelic install -n INTEGRATION-FLAG

For example:

curl -Ls https://raw.githubusercontent.com/newrelic/newrelic-cli/master/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=<API_KEY> NEW_RELIC_ACCOUNT_ID=<ACCOUNT_ID> /usr/local/bin/newrelic install -n apache-open-source-integration

The table lists the integrations supported by the guided install CLI command. The specific on-host integration commands are provided for your reference.

Our open source integrations send performance metrics and inventory data from your servers and applications to the New Relic platform. You can view pre-built dashboards of your metric data, create alert policies, and create your own custom queries and charts.

Integration	Command
Apache	newrelic install -n apache-open-source-integration
Cassandra	newrelic install -n cassandra-open-source-integration
Couchbase	newrelic install -n couchbase-open-source-integration
ElasticSearch	newrelic install -n elasticsearch-open-source-integration
HAProxy	newrelic install -n haproxy-open-source-integration
HashiCorp Consul	newrelic install -n hashicorp-consul-open-source-integration
Memcached	newrelic install -n memcached-open-source-integration
Microsoft SQL Server (Windows only)	newrelic install -n mssql-server-integration-installer
MongoDB	newrelic install -n mongodb-open-source-integration
MySQL	newrelic install -n mysql-open-source-integration
Nagios	newrelic install -n nagios-open-source-integration
Nginx	newrelic install -n nginx-open-source-integration
PostgreSQL	newrelic install -n postgres-open-source-integration
RabbitMQ	newrelic install -n rabbitmq-open-source-integration
Redis	newrelic install -n redis-open-source-integration
Varnish Cache	newrelic install -n varnish-cache-open-source-integration

Troubleshoot common problems

As we identify areas where the guided install fails, we'll document them here and provide some troubleshooting guidance.

To monitor MySQL health data, you need a valid username and password with specific permissions.

These commands will create a user and grant the required permissions:

Create a user newrelic@localhost with a specific password.

sudo mysql -e "CREATE USER 'newrelic'@'localhost' IDENTIFIED BY 'YOUR_SELECTED_PASSWORD';"

Give replication privileges to newrelic@localhost with a maximum of 5 connections.

sudo mysql -e "GRANT REPLICATION CLIENT ON *.* TO 'newrelic'@'localhost' WITH MAX_USER_CONNECTIONS 5;"

Give select privileges to newrelic@localhost with a maximum of 5 connections.

sudo mysql -e "GRANT SELECT ON *.* TO 'newrelic'@'localhost' WITH MAX_USER_CONNECTIONS 5;"

Once done, your next guided install attempt should work.

To monitor your NGINX server, you'll need to configure a valid status URL.

status_url: The URL set up to provide the metrics using the status module. If the default value of 127.0.0.1 is incorrect, substitute the address/FQDN/URL for your system. Example:

status_url: http://127.0.0.1/status

You can read more about the status_url in these NGINX docs:

For NGINX Open Source: HTTP stub status module
For NGINX Plus: HTTP status module and HTTP API module

There are different ways to set status_url, depending on how NGINX was installed:

If enabled via Kubernetes: See Monitor services running on Kubernetes.
If enabled via Amazon ECS: See Monitor services running on ECS.
If installed on-host: Edit the config in the integration's YAML config file, nginx-config.yml.

Why it matters

Some technical detail

Important

On-host integration (OHI) recipes

Troubleshoot common problems

MySQL: Incorrect user permissions

NGINX: No status URL