Skip to main content

New Relic Telemetry SDK

Project description

header

New Relic Telemetry SDK

ci coverage docs ruff

newrelic-telemetry-sdk-python provides a Python library for sending data into New Relic using the Python urllib3 library.

See dimensional metrics, events, logs, and spans/traces in New Relic, without having to use an agent!

Installing newrelic_telemetry_sdk

To start, the newrelic-telemetry-sdk package must be installed. To install through pip:

$ pip install newrelic-telemetry-sdk

If that fails, download the library from its GitHub page and install it using:

$ python setup.py install

Reporting your first metric

There are 3 different types of metrics:

  • GaugeMetric

  • CountMetric

  • SummaryMetric

Metric descriptions

Metric type

Interval required

Description

Example

Gauge

No

A single value at a single point in time.

Room Temperature.

Count

Yes

Track the total number of occurrences of an event.

Number of errors that have occurred.

Summary

Yes

Track count, sum, min, and max values over time.

The summarized duration of 100 HTTP requests.

Example

The example code assumes you’ve set the following environment variables:

  • NEW_RELIC_LICENSE_KEY

import os
import time
from newrelic_telemetry_sdk import GaugeMetric, CountMetric, SummaryMetric, MetricClient

metric_client = MetricClient(os.environ["NEW_RELIC_LICENSE_KEY"])

temperature = GaugeMetric("temperature", 78.6, {"units": "Farenheit"})

# Record that there have been 5 errors in the last 2 seconds
errors = CountMetric(name="errors", value=5, interval_ms=2000)

# Record a summary of 10 response times over the last 2 seconds
summary = SummaryMetric(
    "responses", count=10, min=0.2, max=0.5, sum=4.7, interval_ms=2000
)

batch = [temperature, errors, summary]
response = metric_client.send_batch(batch)
response.raise_for_status()
print("Sent metrics successfully!")

Reporting your first event

Events represent a record of something that has occurred on a system being monitored. The example code assumes you’ve set the following environment variables:

  • NEW_RELIC_LICENSE_KEY

import os
import time
from newrelic_telemetry_sdk import Event, EventClient

# Record that a rate limit has been applied to an endpoint for an account
event = Event(
    "RateLimit", {"path": "/v1/endpoint", "accountId": 1000, "rejectRatio": 0.1}
)

event_client = EventClient(os.environ["NEW_RELIC_LICENSE_KEY"])
response = event_client.send(event)
response.raise_for_status()
print("Event sent successfully!")

Reporting your first log message

Log messages are generated by applications, usually via the Python logging module. These messages are used to audit and diagnose issues with an operating application. The example code assumes you’ve set the following environment variables:

  • NEW_RELIC_LICENSE_KEY

import os

from newrelic_telemetry_sdk import Log, LogClient

log = Log("Hello World!")

log_client = LogClient(os.environ["NEW_RELIC_LICENSE_KEY"])
response = log_client.send(log)
response.raise_for_status()
print("Log sent successfully!")

Reporting your first span

Spans provide an easy way to time components of your code. The example code assumes you’ve set the following environment variables:

  • NEW_RELIC_LICENSE_KEY

import os
import time
from newrelic_telemetry_sdk import Span, SpanClient

with Span(name="sleep") as span:
    time.sleep(0.5)

span_client = SpanClient(os.environ["NEW_RELIC_LICENSE_KEY"])
response = span_client.send(span)
response.raise_for_status()
print("Span sleep sent successfully!")

Find and use data

Tips on how to find and query your data in New Relic:

For general querying information, see:

Limitations

The New Relic Telemetry APIs are rate limited. Please reference the documentation for New Relic Metrics API and New Relic Trace API requirements and limits on the specifics of the rate limits.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newrelic_telemetry_sdk-0.8.0.tar.gz (43.5 kB view details)

Uploaded Source

Built Distribution

newrelic_telemetry_sdk-0.8.0-py3-none-any.whl (24.2 kB view details)

Uploaded Python 3

File details

Details for the file newrelic_telemetry_sdk-0.8.0.tar.gz.

File metadata

  • Download URL: newrelic_telemetry_sdk-0.8.0.tar.gz
  • Upload date:
  • Size: 43.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for newrelic_telemetry_sdk-0.8.0.tar.gz
Algorithm Hash digest
SHA256 ec418d942ae2368db60563a62d76b16a665379fa579710ee77921969c2cde2a5
MD5 b6f71f5bfb4ebe82191c6b2e259be0a4
BLAKE2b-256 f91dc8847e0e111712418d2831e6211a71779d551f18b6b951e101e674e16136

See more details on using hashes here.

Provenance

The following attestation bundles were made for newrelic_telemetry_sdk-0.8.0.tar.gz:

Publisher: deploy.yml on newrelic/newrelic-telemetry-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file newrelic_telemetry_sdk-0.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for newrelic_telemetry_sdk-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 88cb7597f6e256422ae335b6eb9bab378ca5a0910f46835cb8fcef592dd0b19b
MD5 31a589494910d29cd2cab9e9c7ba0135
BLAKE2b-256 784f1be8acba2b1da28d98b2de306ff5055b665ee091048aa26a067b7d93618c

See more details on using hashes here.

Provenance

The following attestation bundles were made for newrelic_telemetry_sdk-0.8.0-py3-none-any.whl:

Publisher: deploy.yml on newrelic/newrelic-telemetry-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page