New Relic Integrations SDK

Report custom data from your hosts. Extend New Relic Infrastructure with the same SDK used by our developers.

New Relic Infrastructure includes numerous integrations with cloud technologies as well as on-host tools like Apache and Kubernetes. But if you want to instrument a technology that’s not available out of the box, Infrastructure includes an integration SDK for building your own on-host infrastructure reporting.

You can use the SDK to generate three types of data—metric, event, and inventory—that target a specific entity.

Metric

Metric data captures numeric data.

Here’s an example metric payload:

{
	"name": "com.myorganization.redis",
	"protocol_version": "2",
	"integration_version": "0.1.0",
	"data": [
		{
			"metrics": [
				{
					"event_type": "MyorgRedisSample",
					"some-data": 1000
				}
			],
			"inventory": {},
			"events": []
		}
	]
}

Event

Event data captures one-off system events.

Here’s an example event payload:

{
	"name": "com.myorganization.redis",
	"protocol_version": "2",
	"integration_version": "0.1.0",
	"data": [
		{
			"metrics": [],
			"inventory": {},
			"events": [
				{
					"summary": "Redis Server recently started",
					"category": "notifications"
				}
			]
		}
	]
}

Inventory

Inventory data tracks the current state of your environment.

Here’s an example inventory payload:

{
	"name": "com.myorganization.redis",
	"protocol_version": "2",
	"integration_version": "0.1.0",
	"data": [
		{
			"metrics": [],
			"inventory": {
				"dbfilename": {
					"value": "dump.rdb"
				}
			},
			"events": []
		}
	]
}

Learn more and start building

Group 7 Created with Sketch.

Documentation

To get started building your integration, see our docs.

Group 9 Created with Sketch.

NRU Tutorials

Check out the latest tutorial on the Infrastructure SDK: Building a Custom Integration with Infrastructure.

Group 8 Created with Sketch.

Community Forum

Connect with other developers in the New Relic Explorers Hub.

GitHub

For examples of integrations and other technologies, see our GitHub repo.