Compatibility and requirements for Infrastructure Integrations SDK

Before using the New Relic Infrastructure integrations SDK to create a custom on-host integration, make sure your system meets these requirements.

Infrastructure version

To use the infrastructure Integrations SDK v4, you must have the Infrastructure agent version 1.13.0 or higher.

To use SDK v3, you must have agent version 1.0.888 or higher.

For Infrastructure agent version information and options for installation and updates, see the Infrastructure release notes.

For notes on SDK versions and changes, see the change log.

Operating systems

Integrations built with the SDK can be compiled for either Linux or Windows operating systems.

Data and file specifications

Infrastructure on-host integrations can be created with any programming language, as long as they adhere to the data and file specifications.

Infrastructure agent version	Details
1.13.0 or higher	Changes to integration protocol (v4), including support to dynamically register entities in NR1 and send dimensional metrics. New metric types. See SDK v4 release notes.
1.0.888 or higher	Changes to JSON format, including support for multiple entities. The new JSON format is referred to as protocol `2` (described in JSON output documentation and also used in the definition file). Uses newer set of Go language build tools (referenced as GoSDK v3).
1.0.726 (for Linux); 1.0.775 (for Windows)	Uses JSON protocol `1` (described in JSON output documentation and also used in the definition file). Uses older set of Go language build tools (referenced as GoSDK v2).

Infrastructure agent version

Details

1.13.0 or higher

Changes to integration protocol (v4), including support to dynamically register entities in NR1 and send dimensional metrics.
New metric types. See SDK v4 release notes.

1.0.888 or higher

Changes to JSON format, including support for multiple entities. The new JSON format is referred to as protocol 2 (described in JSON output documentation and also used in the definition file).

Uses newer set of Go language build tools (referenced as GoSDK v3).

1.0.726 (for Linux); 1.0.775 (for Windows)

Uses JSON protocol 1 (described in JSON output documentation and also used in the definition file).

Uses older set of Go language build tools (referenced as GoSDK v2).

If you've built an integration using the older Go language build tools and wish to update, see Upgrade from GoSDK v2 to v3 and Upgrade from v3 to v4.

For updating the Infrastructure agent, see Update the agent.

For more help

If you need more help, check out these support and learning resources:

Browse the Explorers Hub to get help from the community and join in discussions.
Find answers on our sites and learn how to use our support portal.
Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
Review New Relic's and and documentation.

Compatibility and requirements for Infrastructure Integrations SDK

Infrastructure version

Operating systems

Data and file specifications

.css-3u3y73{fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}.css-1bvd50p{width:1rem;height:1rem;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}For more help

For more help