leocavalcante / newrelic-telemetry-sdk

v0.1.1 2021-02-18 12:54 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• ext-zlib: *
• ramsey/uuid: ^4.1

Requires (Dev)

• mockery/mockery: ^1.4
• pestphp/pest: ^0.3.12
• phpunit/phpunit: ^9.4
• swoole/ide-helper: ^4.6
• vimeo/psalm: ^4.1

Apache-2.0

• leocavalcante

Published on Packagist.org on 2021-02-18 12:55 UTC

README

Unofficial PHP library for sending telemetry data to New Relic.

Status	API	Description
✅	Trace API	Used to send distributed tracing data to New Relic (New Relic's format).
✅	Metric API	Used to send metric data to New Relic.
✅	Event API	Is one way to report custom events to New Relic.
-	Log API	Not planned.

• ⚠️ Heavily under development, but open-sourced seeking for contributions.
• It is not an agent wrapper, it calls the New Relic Ingest APIs.

Usage

Example

Sending a Gauge metric.

use NewRelic\Adapter;
use NewRelic\Metric;

$metric_api = new Metric\API(new Adapter\Curl(getenv('NR_API_KEY')));
$metric_api->setCommonAttrs(['service.name' => 'PHP-SDK']);
$metric_api->send(new Metric\Gauge('memory.heap', 2.3));

$response = $metric_api->commit();

if ($response->isOk()) {
    echo sprintf("Request ID: %s\n", $response->getId());
} else {
    echo sprintf("Metric send error: %s\n", $response->getMessage());
}

Companion resources

• New Relic data dictionary
• Ingest APIs
• OpenTelemetry Spec

Tips

• Make sure you are including service.instance.id when reporting your traces and/or metrics.

Why

Main reasons includes:

• Too many segfaults with the regular agent.
• Even for simple use cases the regular agent doesn't play well with Swoole. This small snippet is enough to throw a segfault:

  Co\run(static function () {
    go(static function () {
      (new Co\Http\Client('swoole.co.uk'))->get('/');
    });
  });

• There are other SDKs for other languages, this is an unofficial PHP version.
• Could be used to build a New Relic exporter for the upcoming OpenTelemetry PHP library.