• English
  • Log inStart now

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

Our guided install discovers the applications, 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.

Did this doc help with your installation?

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.

CLI flags

Customize and debug your installation with CLI flags. Use the "assume yes" flag -y for automated installation with sensible defaults, change the verbosity of the output with --debug or --trace, add tags, or use custom install recipes. You can find a full list of available options in our open source repo on GitHub.

Some technical details

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 are written in YAML format for each type of system to be instrumented and have all of the installation details necessary to install the infrastructure agent for a specific integration. Additional information is available in our open source repo on GitHub.

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, you would use a command similar to the following, which specifies the type of integration you want to install. This is the syntax for Linux:

curl -Ls https://download.newrelic.com/install/newrelic-cli/scripts/install.sh | bash && sudo NEW_RELIC_API_KEY=INSERT_YOUR_API_KEY NEW_RELIC_ACCOUNT_ID=INSERT_YOUR_ACCOUNT_ID NEW_RELIC_REGION=INSERT_YOUR_REGION /usr/local/bin/newrelic install -n INSERT_THE_INTEGRATION_NAME

For example, to install the Apache integration:

curl -Ls https://download.newrelic.com/install/newrelic-cli/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

This is the syntax for Windows:

[Net.ServicePointManager]::SecurityProtocol = 'tls12, tls'; (New-Object System.Net.WebClient).DownloadFile("https://download.newrelic.com/install/newrelic-cli/scripts/install.ps1", "$env:TEMP\install.ps1"); & PowerShell.exe -ExecutionPolicy Bypass -File $env:TEMP\install.ps1; $env:NEW_RELIC_API_KEY='INSERT_YOUR_API_KEY'; $env:NEW_RELIC_ACCOUNT_ID='INSERT_YOUR_ACCOUNT_ID'; $env:NEW_RELIC_REGION='INSERT_YOUR_REGION'; & 'C:\Program Files\New Relic\New Relic CLI\newrelic.exe' install

Important

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

All other integrations are only supported on Linux.

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.

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

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.

Copyright © 2023 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.