New Relic Infrastructure Integrations builder

You can use this command-line tool to create and scaffold a new integration in Golang for New Relic Integration Agent.

This version uses the protocol version 1, so it only supports local entity.

If you need support for remote entities use the last builder version, which comes bundled with protocol version 2.

Getting started

Prerequisites

Before starting to write Go code, we suggest taking a look at Golang's documentation to setup the environment and familiarize yourself with Golang language.

It is required to install the Vendor Tool for Go, which is used for managing dependencies. The project that you will create must be within a $GOPATH/src, otherwise the Vendor Tool won't work properly.

Installation

To install the command-line tool, use go get:

$ go get gopkg.in/newrelic/nr-integrations-builder.v1

After this step, the binary of nr-integrations-builder should be installed in $GOPATH/bin or $GOBIN if this last one is set. In a common Golang workspace, it's recommended having $GOPATH/bin included in your $PATH. That way, you would have nr-integrations-builder available globally.

Usage

At this moment, there is only one command available: init. This is an example of the usage:

$ nr-integrations-builder init mysql

You can check the available options for this command using the --help option:

$ nr-integrations-builder init --help

Usage with options:

$ nr-integrations-builder init \
  --company-name "your-company-name" \
  --company-prefix "ycp" \
  --destination-path "$GOPATH/src/custom-integrations/" \
  mysql

Contributing Code

We welcome code contributions (in the form of pull requests) from our user community. Before submitting a pull request please review these guidelines.

Following these helps us efficiently review and incorporate your contribution and avoid breaking your code with future changes to the agent.

Support

You can find more detailed documentation on our website, and specifically in the Infrastructure category.

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.

Find a bug? Contact us via support.newrelic.com, or email [email protected].

New Relic, Inc.