Skip to content
This repository has been archived by the owner on Jul 1, 2022. It is now read-only.

Latest commit

 

History

History
111 lines (72 loc) · 5.07 KB

README.md

File metadata and controls

111 lines (72 loc) · 5.07 KB
Raw

Archived header

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.

Build Status

Archival Notice

As of June 30 2022 we are archiving the C-SDK project. Please explore the option to use OpenTelemetry as an alternative to send C++ telemetry data to New Relic. For more details, see our Explorers Hub announcement.

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

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

The C SDK project is read-only and available for cloning only. We encourage you to experiment with it in your fork however please keep in mind that there is neither a maintainer team nor support.

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.

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.

Resources