New Relic C SDK

This is the New Relic C SDK! If your application does not use other New Relic APM agent languages, you can use the C SDK to take advantage of New Relic's monitoring capabilities and features to instrument a wide range of applications.

Installation

Requirements

The C SDK works on 64-bit Linux operating systems with:

• gcc 4.8 or higher
• glibc 2.17 or higher
• Kernel version 2.6.26 or higher
• libpcre 8.20 or higher
• libpthread

Running unit tests requires cmake 2.8 or higher.

Compiling the New Relic daemon requires Go 1.7 or higher.

Building

If your system meets the requirements, building the C SDK and daemon should be as simple as:

make

This will create two files in this directory:

• libnewrelic.a: the static C SDK library, ready to link against.
• newrelic-daemon: the daemon binary, ready to run.

You can start the daemon in the foreground with:

./newrelic-daemon -f --logfile stdout --loglevel debug

Alternatively, you can use the C SDK daemon image on Dockerhub to run the daemon.

Then you can invoke your instrumented application. Your application, which makes C SDK API calls, reports data to the daemon over a socket; in turn, the daemon reports the data to New Relic.

For more information on installation and configuration of the C SDK for different environments, see Install and configure.

Testing

To compile and run the unit tests:

make run_tests

Or, just to compile them:

make tests

Support

Should you need assistance with New Relic products, you are in good hands with several support channels.

If the issue has been confirmed as a bug or is a feature request, file a GitHub issue.

Support Channels

• New Relic Documentation: Comprehensive guidance for using our platform
• New Relic C SDK documentation on GitHub
• New Relic C SDK Guide
• New Relic C SDK distributed tracing example
• New Relic Community: The best place to engage in troubleshooting questions
• New Relic Developer: Resources for building a custom observability applications
• New Relic University: A range of online training for New Relic users of every level
• Use your preferred search engine to find other New Relic resources.

Privacy

At New Relic we take your privacy and the security of your information seriously, and are committed to protecting your information. We must emphasize the importance of not sharing personal data in public forums, and ask all users to scrub logs and diagnostic information for sensitive information, whether personal, proprietary, or otherwise.

We define “Personal Data” as any information relating to an identified or identifiable individual, including, for example, your name, phone number, post code or zip code, Device ID, IP address and email address.

For more information, review New Relic’s General Data Privacy Notice.

Contribute

We encourage your contributions to improve the C SDK! Keep in mind 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, required if your contribution is on behalf of a company, please drop us an email at [email protected].

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.

To all contributors, we thank you! Without your contribution, this project would not be what it is today. We also host a community project page dedicated to New Relic C SDK.

License

The New Relic C SDK is licensed under the Apache 2.0 License.

The C SDK also uses source code from third party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third party notices document.