New Relic Telemetry SDK
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-sdkIf that fails, download the library from its GitHub page and install it using:
$ python setup.py installReporting 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_INSERT_KEY
import os
import time
from newrelic_telemetry_sdk import GaugeMetric, CountMetric, SummaryMetric, MetricClient
metric_client = MetricClient(os.environ["NEW_RELIC_INSERT_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_INSERT_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_INSERT_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_INSERT_KEY
import os
from newrelic_telemetry_sdk import Log, LogClient
log = Log("Hello World!")
log_client = LogClient(os.environ["NEW_RELIC_INSERT_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_INSERT_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_INSERT_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.