opencensus-ext-newrelic

New Relic OpenCensus Exporter


Keywords
monitoring, newrelic, opencensus, python, telemetry
License
Apache-2.0
Install
pip install opencensus-ext-newrelic==0.2.1

Documentation

header

New Relic OpenCensus exporter

ci coverage docs black

The opencensus-ext-newrelic package provides Python exporters to plug into OpenCensus! Both spans and metrics may be exported using these exporters!

Requirements

OpenCensus-Python version 0.7.x is required to use the exporters.

Using the trace exporter

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

  • NEW_RELIC_INSERT_KEY
import os
import time
from opencensus.trace.tracer import Tracer
from opencensus.trace import samplers
from opencensus_ext_newrelic import NewRelicTraceExporter

newrelic = NewRelicTraceExporter(
    insert_key=os.environ["NEW_RELIC_INSERT_KEY"], service_name="Example Service"
)

tracer = Tracer(exporter=newrelic, sampler=samplers.AlwaysOnSampler())

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

# Send all data and stop the exporter
newrelic.stop()

Using the stats exporter

Metrics are an excellent way to expose aggregated information about your application. The stats exporter allows metrics to be exported from opencensus to New Relic.

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

  • NEW_RELIC_INSERT_KEY
import os
import time
from opencensus.stats import aggregation as aggregation_module
from opencensus.stats import measure as measure_module
from opencensus.stats import stats as stats_module
from opencensus.stats import view as view_module
from opencensus_ext_newrelic import NewRelicStatsExporter

# The stats recorder
stats = stats_module.stats
view_manager = stats.view_manager
stats_recorder = stats.stats_recorder
newrelic = NewRelicStatsExporter(
    os.environ["NEW_RELIC_INSERT_KEY"], service_name="Example Service"
)
view_manager.register_exporter(newrelic)

# Create the measures and views
# The latency in milliseconds
m_latency_ms = measure_module.MeasureFloat(
    "task_latency", "The task latency in milliseconds", "ms"
)

latency_view = view_module.View(
    "task_latency_latest",
    "The latest task latency",
    [],
    m_latency_ms,
    aggregation_module.LastValueAggregation(),
)

view_manager.register_view(latency_view)
mmap = stats_recorder.new_measurement_map()

# Record a metric
mmap.measure_float_put(m_latency_ms, 50)
mmap.record()

# Send all data and stop the exporter
newrelic.stop()

Find and use data

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

For general querying information, see: