Forge Home

newrelic_installer

Puppet module for installing New Relic integrations

1,225 downloads

213 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.5.0 (latest)
  • 0.4.3
  • 0.4.0
  • 0.3.0
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Jun 27th 2023
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.21.0 < 8.0.0
  • , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'newrelic-newrelic_installer', '0.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add newrelic-newrelic_installer
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install newrelic-newrelic_installer --version 0.5.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

newrelic/newrelic_installer — version 0.5.0 Jun 27th 2023

New Relic Puppet module

newrelic-newrelic_installer is a Puppet module that will help you scale your New Relic Observability efforts. It uses the New Relic CLI and New Relic Open Installation repository to achieve this.

Currently, we have included Linux and Windows support for New Relic's Infrastructure and Logs integrations, with more agents and integrations following in the near future.

Note: Installing specific versions of an agent is not supported, this role will always install latest released version of a New Relic agent.

Installation

Puppet Forge

puppet module install newrelic-newrelic_installer

View more installation options on PuppetForge

Manual

sudo puppet module install ~/newrelic-newrelic_installer-0.1.0.tar.gz
Notice: Preparing to install into /etc/puppetlabs/code/environments/production/modules ...
Notice: Downloading from https://forgeapi.puppet.com ...
Notice: Installing -- do not interrupt ...
/etc/puppetlabs/code/environments/production/modules
└─┬ newrelic-newrelic_installer (v0.1.0)
  ├── lwf-remote_file (v1.1.3)
  └── puppetlabs-powershell (v5.2.0)

Getting Started

To use this module, you'll need to instantiate the ::install class, specifying an instrumentation target and some New Relic account-specific details. For example:

# /etc/puppetlabs/code/environments/<YOUR_ENVIRONMENT>/manifests/site.pp
class { 'newrelic_installer::install':
          targets               => ["infrastructure", "logs", "php", "dotnet"],
          environment_variables => {
            "NEW_RELIC_API_KEY"          => "<YOUR-NR-API-KEY>",
            "NEW_RELIC_ACCOUNT_ID"       => <YOUR-NR-ACCOUNT-ID>,
            "NEW_RELIC_REGION"           => "<US|EU>",
            "NEW_RELIC_APPLICATION_NAME" => "<YOUR-PHP-APPLICATION-NAME>"
          }
}

Parameters

targets [String]

Specifies target to be instrumented with New Relic Supported values include:

  • 'infrastructure' - New Relic Infrastructure Agent
  • 'logs' - Logs integration for New Relic Infrastructure Agent. *requires 'infrastructure'
  • 'php' - New Relic PHP APM Agent
  • 'dotnet' - New Relic .Net APM Agent
  • 'nodejs' - New Relic Node APM Agent

environment_variables Hash

Hash of environment variables to set prior to execution.

  • NEW_RELIC_API_KEY: your New Relic API key *required
  • NEW_RELIC_ACCOUNT_ID: your New Relic account id *required
  • NEW_RELIC_REGION: your New Relic account's region (US or EU). Defaults to US if not specified
  • NEW_RELIC_APPLICATION_NAME: used by 'php'. This config option sets the application name that data is reported under in APM. Defaults to 'PHP Application' if not specified.

verbosity String (optional)

Specifies command output verbosity Supported values include

  • debug
  • trace

tags Hash (optional)

Hash of tags associated with entities instrumented with New Relic. Examples:

  • {'key-name' => 'value', 'foo' => 'bar'}

proxy String (optional)

Sets the proxy server the agent should use. Examples:

  • https://myproxy.foo.com:8080
  • http://10.10.254.254

install_timeout_seconds Integer (optional)

Sets the timeout in seconds for New Relic installations. Default is 600

Support

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:

Contribute

We encourage your contributions to improve the newrelic_installer Puppet module! Keep in mind that 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 (which is required if your contribution is on behalf of a company), 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.

If you would like to contribute to this project, review these guidelines.

License

This project is licensed under the Apache 2.0 License.