CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" data-content_root="./"> <head> <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>API Reference — newrelic-telemetry-sdk 0.6.0 documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" /> <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />  <script src="_static/jquery.js?v=5d32c60e"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> <script src="_static/documentation_options.js?v=8fa8b3e9"></script> <script src="_static/doctools.js?v=9a2dae69"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="prev" title="Proxy Support" href="proxy.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> newrelic-telemetry-sdk </a> <div class="version"> 0.6 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Usage</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="proxy.html">Proxy Support</a></li> </ul> <ul class="current"> <li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.client">New Relic HTTP Clients</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient"><code class="docutils literal notranslate">EventClient</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient.POOL_CLS"><code class="docutils literal notranslate">EventClient.POOL_CLS</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient.add_version_info"><code class="docutils literal notranslate">EventClient.add_version_info()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient.close"><code class="docutils literal notranslate">EventClient.close()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient.send"><code class="docutils literal notranslate">EventClient.send()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient.send_batch"><code class="docutils literal notranslate">EventClient.send_batch()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPError"><code class="docutils literal notranslate">HTTPError</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPError.add_note"><code class="docutils literal notranslate">HTTPError.add_note()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPError.args"><code class="docutils literal notranslate">HTTPError.args</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPError.with_traceback"><code class="docutils literal notranslate">HTTPError.with_traceback()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient"><code class="docutils literal notranslate">MetricClient</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient.POOL_CLS"><code class="docutils literal notranslate">MetricClient.POOL_CLS</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient.add_version_info"><code class="docutils literal notranslate">MetricClient.add_version_info()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient.close"><code class="docutils literal notranslate">MetricClient.close()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient.send"><code class="docutils literal notranslate">MetricClient.send()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient.send_batch"><code class="docutils literal notranslate">MetricClient.send_batch()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient"><code class="docutils literal notranslate">SpanClient</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient.POOL_CLS"><code class="docutils literal notranslate">SpanClient.POOL_CLS</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient.add_version_info"><code class="docutils literal notranslate">SpanClient.add_version_info()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient.close"><code class="docutils literal notranslate">SpanClient.close()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient.send"><code class="docutils literal notranslate">SpanClient.send()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient.send_batch"><code class="docutils literal notranslate">SpanClient.send_batch()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse"><code class="docutils literal notranslate">HTTPResponse</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse.json"><code class="docutils literal notranslate">HTTPResponse.json()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse.ok"><code class="docutils literal notranslate">HTTPResponse.ok</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse.raise_for_status"><code class="docutils literal notranslate">HTTPResponse.raise_for_status()</code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.metric">Metrics</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.metric.CountMetric"><code class="docutils literal notranslate">CountMetric</code></a></li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.metric.GaugeMetric"><code class="docutils literal notranslate">GaugeMetric</code></a></li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.metric.SummaryMetric"><code class="docutils literal notranslate">SummaryMetric</code></a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.event">Events</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.event.Event"><code class="docutils literal notranslate">Event</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.event.Event.copy"><code class="docutils literal notranslate">Event.copy()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.event.Event.event_type"><code class="docutils literal notranslate">Event.event_type</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.event.Event.timestamp_ms"><code class="docutils literal notranslate">Event.timestamp_ms</code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.log">Logs</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.log.Log"><code class="docutils literal notranslate">Log</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.log.Log.extract_record_data"><code class="docutils literal notranslate">Log.extract_record_data()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.log.Log.from_record"><code class="docutils literal notranslate">Log.from_record()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.log.NewRelicLogFormatter"><code class="docutils literal notranslate">NewRelicLogFormatter</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.log.NewRelicLogFormatter.format"><code class="docutils literal notranslate">NewRelicLogFormatter.format()</code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.span">Spans</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.span.Span"><code class="docutils literal notranslate">Span</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.span.Span.finish"><code class="docutils literal notranslate">Span.finish()</code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.metric_batch">Batches</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch"><code class="docutils literal notranslate">MetricBatch</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.create_identity"><code class="docutils literal notranslate">MetricBatch.create_identity()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.flush"><code class="docutils literal notranslate">MetricBatch.flush()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_count"><code class="docutils literal notranslate">MetricBatch.record_count()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_gauge"><code class="docutils literal notranslate">MetricBatch.record_gauge()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_summary"><code class="docutils literal notranslate">MetricBatch.record_summary()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.EventBatch"><code class="docutils literal notranslate">EventBatch</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.EventBatch.flush"><code class="docutils literal notranslate">EventBatch.flush()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.EventBatch.record"><code class="docutils literal notranslate">EventBatch.record()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.LogBatch"><code class="docutils literal notranslate">LogBatch</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.LogBatch.flush"><code class="docutils literal notranslate">LogBatch.flush()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.LogBatch.record"><code class="docutils literal notranslate">LogBatch.record()</code></a></li> </ul> </li> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.SpanBatch"><code class="docutils literal notranslate">SpanBatch</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.SpanBatch.flush"><code class="docutils literal notranslate">SpanBatch.flush()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.batch.SpanBatch.record"><code class="docutils literal notranslate">SpanBatch.record()</code></a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#module-newrelic_telemetry_sdk.harvester">Harvester</a><ul> <li class="toctree-l3"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester"><code class="docutils literal notranslate">Harvester</code></a><ul> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.getName"><code class="docutils literal notranslate">Harvester.getName()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.ident"><code class="docutils literal notranslate">Harvester.ident</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.isDaemon"><code class="docutils literal notranslate">Harvester.isDaemon()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.is_alive"><code class="docutils literal notranslate">Harvester.is_alive()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.join"><code class="docutils literal notranslate">Harvester.join()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.name"><code class="docutils literal notranslate">Harvester.name</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.native_id"><code class="docutils literal notranslate">Harvester.native_id</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.setDaemon"><code class="docutils literal notranslate">Harvester.setDaemon()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.setName"><code class="docutils literal notranslate">Harvester.setName()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.start"><code class="docutils literal notranslate">Harvester.start()</code></a></li> <li class="toctree-l4"><a class="reference internal" href="#newrelic_telemetry_sdk.harvester.Harvester.stop"><code class="docutils literal notranslate">Harvester.stop()</code></a></li> </ul> </li> </ul> </li> </ul> </li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">newrelic-telemetry-sdk</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">API Reference</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="module-newrelic_telemetry_sdk"> <h1>API Reference<a class="headerlink" href="#module-newrelic_telemetry_sdk" title="Link to this heading"></a></h1> <section id="module-newrelic_telemetry_sdk.client"> <h2>New Relic HTTP Clients<a class="headerlink" href="#module-newrelic_telemetry_sdk.client" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient"> class newrelic_telemetry_sdk.client.EventClient(license_key, host=None, port=443)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#EventClient">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient" title="Link to this definition"></a></dt> <dd>HTTP Client for interacting with the New Relic Event API This class is used to send events to the New Relic Event API over HTTP. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>license_key (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – New Relic license key</li> <li>host (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) Override the host for the event API endpoint.</li> <li>port (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) Override the port for the client. Default: 443</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import os >>> license_key = os.environ.get("NEW_RELIC_LICENSE_KEY", "") >>> event_client = EventClient(license_key) >>> response = event_client.send({}) >>> event_client.close() </pre></div> </div> <dl class="py attribute"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient.POOL_CLS"> POOL_CLS<a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient.POOL_CLS" title="Link to this definition"></a></dt> <dd>alias of <a class="reference external" href="https://urllib3.readthedocs.io/en/latest/reference/urllib3.connectionpool.html#urllib3.HTTPSConnectionPool" title="(in urllib3 v2.2.3.dev38)"><code class="xref py py-class docutils literal notranslate">HTTPSConnectionPool</code></a> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient.add_version_info"> add_version_info(product, product_version)<a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient.add_version_info" title="Link to this definition"></a></dt> <dd>Adds product and version information to a User-Agent header This method implements <a class="reference external" href="https://tools.ietf.org/html/rfc7231#section-5.5.3">https://tools.ietf.org/html/rfc7231#section-5.5.3</a> <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>product (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The product name using the SDK</li> <li>product_version (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The version string of the product in use</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient.close"> close()<a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient.close" title="Link to this definition"></a></dt> <dd>Close all open connections and disable internal connection pool. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient.send"> send(item, timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient.send" title="Link to this definition"></a></dt> <dd>Send a single item <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>item (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – The object to send</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.EventClient.send_batch"> send_batch(items, timeout=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#EventClient.send_batch">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.EventClient.send_batch" title="Link to this definition"></a></dt> <dd>Send a batch of items <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>items (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)">list</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a>) – An iterable of items to send to New Relic.</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPError"> exception newrelic_telemetry_sdk.client.HTTPError<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#HTTPError">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPError" title="Link to this definition"></a></dt> <dd>Unexpected HTTP Status <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPError.add_note"> add_note()<a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPError.add_note" title="Link to this definition"></a></dt> <dd>Exception.add_note(note) – add a note to the exception </dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPError.args"> args<a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPError.args" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPError.with_traceback"> with_traceback()<a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPError.with_traceback" title="Link to this definition"></a></dt> <dd>Exception.with_traceback(tb) – set self.__traceback__ to tb and return self. </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient"> class newrelic_telemetry_sdk.client.MetricClient(license_key, host=None, port=443)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#MetricClient">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient" title="Link to this definition"></a></dt> <dd>HTTP Client for interacting with the New Relic Metric API This class is used to send metrics to the New Relic Metric API over HTTP. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>license_key (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – New Relic license key</li> <li>host (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) Override the host for the metric API endpoint.</li> <li>port (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) Override the port for the client. Default: 443</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import os >>> license_key = os.environ.get("NEW_RELIC_LICENSE_KEY", "") >>> metric_client = MetricClient(license_key) >>> response = metric_client.send({}) >>> metric_client.close() </pre></div> </div> <dl class="py attribute"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient.POOL_CLS"> POOL_CLS<a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient.POOL_CLS" title="Link to this definition"></a></dt> <dd>alias of <a class="reference external" href="https://urllib3.readthedocs.io/en/latest/reference/urllib3.connectionpool.html#urllib3.HTTPSConnectionPool" title="(in urllib3 v2.2.3.dev38)"><code class="xref py py-class docutils literal notranslate">HTTPSConnectionPool</code></a> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient.add_version_info"> add_version_info(product, product_version)<a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient.add_version_info" title="Link to this definition"></a></dt> <dd>Adds product and version information to a User-Agent header This method implements <a class="reference external" href="https://tools.ietf.org/html/rfc7231#section-5.5.3">https://tools.ietf.org/html/rfc7231#section-5.5.3</a> <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>product (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The product name using the SDK</li> <li>product_version (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The version string of the product in use</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient.close"> close()<a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient.close" title="Link to this definition"></a></dt> <dd>Close all open connections and disable internal connection pool. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient.send"> send(item, timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient.send" title="Link to this definition"></a></dt> <dd>Send a single item <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>item (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – The object to send</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.MetricClient.send_batch"> send_batch(items, common=None, timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.client.MetricClient.send_batch" title="Link to this definition"></a></dt> <dd>Send a batch of items <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>items (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)">list</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a>) – An iterable of items to send to New Relic.</li> <li>common (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A map of attributes that will be set on each item.</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient"> class newrelic_telemetry_sdk.client.SpanClient(license_key, host=None, port=443)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#SpanClient">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient" title="Link to this definition"></a></dt> <dd>HTTP Client for interacting with the New Relic Span API This class is used to send spans to the New Relic Span API over HTTP. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>license_key (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – New Relic license key</li> <li>host (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) Override the host for the span API endpoint.</li> <li>port (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) Override the port for the client. Default: 443</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import os >>> license_key = os.environ.get("NEW_RELIC_LICENSE_KEY", "") >>> span_client = SpanClient(license_key) >>> response = span_client.send({}) >>> span_client.close() </pre></div> </div> <dl class="py attribute"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient.POOL_CLS"> POOL_CLS<a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient.POOL_CLS" title="Link to this definition"></a></dt> <dd>alias of <a class="reference external" href="https://urllib3.readthedocs.io/en/latest/reference/urllib3.connectionpool.html#urllib3.HTTPSConnectionPool" title="(in urllib3 v2.2.3.dev38)"><code class="xref py py-class docutils literal notranslate">HTTPSConnectionPool</code></a> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient.add_version_info"> add_version_info(product, product_version)<a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient.add_version_info" title="Link to this definition"></a></dt> <dd>Adds product and version information to a User-Agent header This method implements <a class="reference external" href="https://tools.ietf.org/html/rfc7231#section-5.5.3">https://tools.ietf.org/html/rfc7231#section-5.5.3</a> <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>product (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The product name using the SDK</li> <li>product_version (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The version string of the product in use</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient.close"> close()<a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient.close" title="Link to this definition"></a></dt> <dd>Close all open connections and disable internal connection pool. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient.send"> send(item, timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient.send" title="Link to this definition"></a></dt> <dd>Send a single item <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>item (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – The object to send</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.SpanClient.send_batch"> send_batch(items, common=None, timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.client.SpanClient.send_batch" title="Link to this definition"></a></dt> <dd>Send a batch of items <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>items (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)">list</a> or <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a>) – An iterable of items to send to New Relic.</li> <li>common (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A map of attributes that will be set on each item.</li> <li>timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) a timeout in seconds for sending the request</li> </ul> </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="newrelic_telemetry_sdk.client.HTTPResponse">HTTPResponse</a> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPResponse"> class newrelic_telemetry_sdk.client.HTTPResponse<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#HTTPResponse">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPResponse" title="Link to this definition"></a></dt> <dd>A wrapper for urllib3.HTTPResponse, providing additional helper methods <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPResponse.json"> json()<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#HTTPResponse.json">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPResponse.json" title="Link to this definition"></a></dt> <dd>Returns the json-encoded content of a response. <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a> </dd> </dl> </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPResponse.ok"> property ok<a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPResponse.ok" title="Link to this definition"></a></dt> <dd>Return true if status code indicates success </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.client.HTTPResponse.raise_for_status"> raise_for_status()<a class="reference internal" href="_modules/newrelic_telemetry_sdk/client.html#HTTPResponse.raise_for_status">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.client.HTTPResponse.raise_for_status" title="Link to this definition"></a></dt> <dd>Raise an exception for an unsuccessful HTTP status code <dl class="field-list simple"> <dt class="field-odd">Raises:</dt> <dd class="field-odd"><a class="reference internal" href="#newrelic_telemetry_sdk.client.HTTPError" title="newrelic_telemetry_sdk.client.HTTPError">HTTPError</a> – if response status is not successful </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.metric"> <h2>Metrics<a class="headerlink" href="#module-newrelic_telemetry_sdk.metric" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric.CountMetric"> class newrelic_telemetry_sdk.metric.CountMetric(name, value, interval_ms, tags=None, end_time_ms=<object object>)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric.html#CountMetric">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric.CountMetric" title="Link to this definition"></a></dt> <dd>Count Metric This metric is of a “count” type. The metric holds an integer indicating a count of events which have taken place. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The metric count value.</li> <li>interval_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – The interval of time in milliseconds over which the metric was recorded.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> <li>end_time_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) A unix timestamp in milliseconds representing the end time of the metric. Defaults to time.time() * 1000</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> from newrelic_telemetry_sdk import CountMetric >>> metric = CountMetric('response_code', 1, interval_ms=1, tags={'code': 200}) >>> metric.value 1 </pre></div> </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric.GaugeMetric"> class newrelic_telemetry_sdk.metric.GaugeMetric(name, value, tags=None, end_time_ms=<object object>)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric.html#GaugeMetric">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric.GaugeMetric" title="Link to this definition"></a></dt> <dd>Basic Metric type This metric is of a “gauge” type. It records values at a point in time. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The metric value.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> <li>end_time_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) A unix timestamp in milliseconds representing the end time of the metric. Defaults to time.time() * 1000</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> from newrelic_telemetry_sdk import GaugeMetric >>> metric = GaugeMetric('temperature', 20, tags={'units': 'C'}) >>> metric.value 20 </pre></div> </div> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric.SummaryMetric"> class newrelic_telemetry_sdk.metric.SummaryMetric(name, count, sum, min, max, interval_ms, tags=None, end_time_ms=<object object>)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric.html#SummaryMetric">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric.SummaryMetric" title="Link to this definition"></a></dt> <dd>Summary Metric This metric is of a “summary” type. It tracks the count, sum, min, and max values when recording values. These values can be used to compute averages and distributions over time. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>count (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – The count in the summary metric.</li> <li>sum (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The sum in the summary metric.</li> <li>min (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The minimum value in the summary metric.</li> <li>max (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The maximum value in the summary metric.</li> <li>interval_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – The interval of time in milliseconds over which the metric was recorded.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> <li>end_time_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) A unix timestamp in milliseconds representing the end time of the metric. Defaults to time.time() * 1000</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> from newrelic_telemetry_sdk import SummaryMetric >>> metric = SummaryMetric('response_time', ... count=1, sum=0.2, min=0.2, max=0.2, interval_ms=1) >>> sorted(metric.value.items()) [('count', 1), ('max', 0.2), ('min', 0.2), ('sum', 0.2)] </pre></div> </div> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.event"> <h2>Events<a class="headerlink" href="#module-newrelic_telemetry_sdk.event" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.event.Event"> class newrelic_telemetry_sdk.event.Event(event_type, tags=None, timestamp_ms=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/event.html#Event">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.event.Event" title="Link to this definition"></a></dt> <dd>An event represented in New Relic Insights <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>event_type (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The type of event to report</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this event in the New Relic UI.</li> <li>timestamp_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) A unix timestamp in milliseconds representing the timestamp in ms at which the event occurred. Defaults to time.time() * 1000</li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.event.Event.copy"> copy() → a shallow copy of D<a class="reference internal" href="_modules/newrelic_telemetry_sdk/event.html#Event.copy">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.event.Event.copy" title="Link to this definition"></a></dt> <dd></dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.event.Event.event_type"> property event_type<a class="headerlink" href="#newrelic_telemetry_sdk.event.Event.event_type" title="Link to this definition"></a></dt> <dd>Event Type </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.event.Event.timestamp_ms"> property timestamp_ms<a class="headerlink" href="#newrelic_telemetry_sdk.event.Event.timestamp_ms" title="Link to this definition"></a></dt> <dd>Event Timestamp </dd></dl> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.log"> <h2>Logs<a class="headerlink" href="#module-newrelic_telemetry_sdk.log" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.log.Log"> class newrelic_telemetry_sdk.log.Log(message, timestamp=None, **attributes)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/log.html#Log">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.log.Log" title="Link to this definition"></a></dt> <dd>A log representing a log event in the New Relic logging UI This data structure represents a single log event. These objects, when JSON serialized, can be sent to New Relic’s log api. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>message (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The log message.</li> <li>timestamp – (optional) The unix timestamp in milliseconds indicating when the log message was generated. Defaults to now.</li> <li>**attributes – Additional attribute name=value pairs provided as keyword arguments.</li> </ul> </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.log.Log.extract_record_data"> static extract_record_data(record)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/log.html#Log.extract_record_data">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.log.Log.extract_record_data" title="Link to this definition"></a></dt> <dd>Extracts data from a logging.LogRecord into a flat dictionary <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">record (<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.LogRecord" title="(in Python v3.12)">logging.LogRecord</a>) – The LogRecord from which to extract data. </dd> </dl> <div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import logging >>> record = logging.makeLogRecord({"msg": "Hello World"}) >>> result = Log.extract_record_data(record) >>> isinstance(result, dict) True >>> result["message"] 'Hello World' </pre></div> </div> <dl class="field-list simple"> <dt class="field-odd">Return type:</dt> <dd class="field-odd"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.log.Log.from_record"> classmethod from_record(record)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/log.html#Log.from_record">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.log.Log.from_record" title="Link to this definition"></a></dt> <dd>Convert a logging.LogRecord into a Log This converts a <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.LogRecord" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate">logging.LogRecord</code></a> to a New Relic <a class="reference internal" href="#newrelic_telemetry_sdk.log.Log" title="newrelic_telemetry_sdk.log.Log"><code class="xref py py-class docutils literal notranslate">Log</code></a>, extracting any dimensions/labels from the record. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">record (<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.LogRecord" title="(in Python v3.12)">logging.LogRecord</a>) – The LogRecord to convert. </dd> </dl> <div class="doctest highlight-default notranslate"><div class="highlight"><pre>>>> import logging >>> record = logging.makeLogRecord({"msg": "Hello World"}) >>> log = Log.from_record(record) >>> log["message"] 'Hello World' </pre></div> </div> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.log.NewRelicLogFormatter"> class newrelic_telemetry_sdk.log.NewRelicLogFormatter(*args, **kwargs)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/log.html#NewRelicLogFormatter">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.log.NewRelicLogFormatter" title="Link to this definition"></a></dt> <dd>New Relic Log Formatter The New Relic log formatter converts LogRecord instances to strings via the format method. The New Relic log format allows for arbitrary key/value pairs to be logged. This formatter automatically extracts all relevant information from the LogRecord (including extras) and places those key/values into a JSON object. Since the format is not configurable, all formatter constructor arguments are ignored. Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import logging >>> record = logging.makeLogRecord({}) >>> formatter = NewRelicLogFormatter() >>> result = formatter.format(record) >>> isinstance(result, str) True </pre></div> </div> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.log.NewRelicLogFormatter.format"> format(record)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/log.html#NewRelicLogFormatter.format">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.log.NewRelicLogFormatter.format" title="Link to this definition"></a></dt> <dd>Format the specified record as text <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">record (<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.LogRecord" title="(in Python v3.12)">logging.LogRecord</a>) – The LogRecord to format. </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a> </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.span"> <h2>Spans<a class="headerlink" href="#module-newrelic_telemetry_sdk.span" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.span.Span"> class newrelic_telemetry_sdk.span.Span(name, tags=None, guid=None, trace_id=None, parent_id=None, start_time_ms=None, duration_ms=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/span.html#Span">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.span.Span" title="Link to this definition"></a></dt> <dd>A span represented in the New Relic Distributed Tracing UI This data structure represents a single event with duration as part of a distributed trace. Generally, this class should be used as a context manager. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the span.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this span in the New Relic UI.</li> <li>guid (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) A random, unique identifier used to locate exactly 1 span in New Relic. This must be a unique identifier across all spans in a New Relic account.</li> <li>trace_id (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) A random identifier representing a group of spans known as a “trace”. Spans having the same trace_id are grouped into a single view.</li> <li>parent_id (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) The guid of the span that called this span.</li> <li>start_time_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) A unix timestamp in milliseconds representing the start time of the span. Defaults to time.time() * 1000</li> <li>duration_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) Total duration of the span in milliseconds.</li> </ul> </dd> </dl> Usage: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import newrelic_telemetry_sdk >>> with newrelic_telemetry_sdk.Span('span_name') as s: ... pass </pre></div> </div> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.span.Span.finish"> finish(finish_time_ms=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/span.html#Span.finish">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.span.Span.finish" title="Link to this definition"></a></dt> <dd>Record the duration on this span. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">finish_time_ms (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a>) – (optional) Timestamp in milliseconds. Defaults to time.time() * 1000 </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.metric_batch"> <h2>Batches<a class="headerlink" href="#module-newrelic_telemetry_sdk.metric_batch" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch"> class newrelic_telemetry_sdk.metric_batch.MetricBatch(tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch" title="Link to this definition"></a></dt> <dd>Maps a metric identity to its aggregated value This is used to hold unfinalized metrics for further aggregation until they are flushed to a backend. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A dictionary of tags to attach to all flushes. </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch.create_identity"> static create_identity(name, tags=None, typ=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch.create_identity">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.create_identity" title="Link to this definition"></a></dt> <dd>Creates a deterministic hashable identity for a metric <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> <li>typ (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – (optional) The metric type. One of “summary”, “count”, “gauge” or None. Default: None (gauge type).</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch.flush"> flush()<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch.flush">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.flush" title="Link to this definition"></a></dt> <dd>Flush all metrics from the batch This method returns all metrics in the batch and a common block representing timestamp as the start time for the period since creation or last flush, and interval representing the total amount of time in milliseconds between flushes. As a side effect, the batch’s interval is reset in anticipation of subsequent calls to flush. <dl class="field-list simple"> <dt class="field-odd">Returns:</dt> <dd class="field-odd">A tuple of (metrics, common) </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch.record_count"> record_count(name, value, tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch.record_count">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_count" title="Link to this definition"></a></dt> <dd>Records a count metric <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The metric value.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch.record_gauge"> record_gauge(name, value, tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch.record_gauge">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_gauge" title="Link to this definition"></a></dt> <dd>Records a gauge metric <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The metric value.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.metric_batch.MetricBatch.record_summary"> record_summary(name, value, tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/metric_batch.html#MetricBatch.record_summary">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch.record_summary" title="Link to this definition"></a></dt> <dd>Records a summary metric <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a>) – The name of the metric.</li> <li>value (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – The metric value.</li> <li>tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A set of tags that can be used to filter this metric in the New Relic UI.</li> </ul> </dd> </dl> </dd></dl> </dd></dl> <dl class="py class" id="module-newrelic_telemetry_sdk.batch"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.EventBatch"> class newrelic_telemetry_sdk.batch.EventBatch<a class="reference internal" href="_modules/newrelic_telemetry_sdk/batch.html#EventBatch">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.batch.EventBatch" title="Link to this definition"></a></dt> <dd>Aggregates events, providing a record / flush interface. <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.EventBatch.flush"> flush()<a class="reference internal" href="_modules/newrelic_telemetry_sdk/batch.html#EventBatch.flush">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.batch.EventBatch.flush" title="Link to this definition"></a></dt> <dd>Flush all items from the batch This method returns all items in the batch. The batch is cleared as part of this operation. <dl class="field-list simple"> <dt class="field-odd">Returns:</dt> <dd class="field-odd">A tuple of (items,) </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.EventBatch.record"> record(item)<a class="headerlink" href="#newrelic_telemetry_sdk.batch.EventBatch.record" title="Link to this definition"></a></dt> <dd>Merge an item into the batch <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">item – The item to merge into the batch. </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.LogBatch"> class newrelic_telemetry_sdk.batch.LogBatch(tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/batch.html#LogBatch">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.batch.LogBatch" title="Link to this definition"></a></dt> <dd>Aggregates logs, providing a record / flush interface. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A dictionary of tags to attach to all flushes. </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.LogBatch.flush"> flush()<a class="headerlink" href="#newrelic_telemetry_sdk.batch.LogBatch.flush" title="Link to this definition"></a></dt> <dd>Flush all items from the batch This method returns all items in the batch and a common block representing any tags if applicable. The batch is cleared as part of this operation. <dl class="field-list simple"> <dt class="field-odd">Returns:</dt> <dd class="field-odd">A tuple of (items, common) </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.LogBatch.record"> record(item)<a class="headerlink" href="#newrelic_telemetry_sdk.batch.LogBatch.record" title="Link to this definition"></a></dt> <dd>Merge an item into the batch <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">item – The item to merge into the batch. </dd> </dl> </dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.SpanBatch"> class newrelic_telemetry_sdk.batch.SpanBatch(tags=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/batch.html#SpanBatch">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.batch.SpanBatch" title="Link to this definition"></a></dt> <dd>Aggregates spans, providing a record / flush interface. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">tags (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)">dict</a>) – (optional) A dictionary of tags to attach to all flushes. </dd> </dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.SpanBatch.flush"> flush()<a class="headerlink" href="#newrelic_telemetry_sdk.batch.SpanBatch.flush" title="Link to this definition"></a></dt> <dd>Flush all items from the batch This method returns all items in the batch and a common block representing any tags if applicable. The batch is cleared as part of this operation. <dl class="field-list simple"> <dt class="field-odd">Returns:</dt> <dd class="field-odd">A tuple of (items, common) </dd> <dt class="field-even">Return type:</dt> <dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)">tuple</a> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.batch.SpanBatch.record"> record(item)<a class="headerlink" href="#newrelic_telemetry_sdk.batch.SpanBatch.record" title="Link to this definition"></a></dt> <dd>Merge an item into the batch <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">item – The item to merge into the batch. </dd> </dl> </dd></dl> </dd></dl> </section> <section id="module-newrelic_telemetry_sdk.harvester"> <h2>Harvester<a class="headerlink" href="#module-newrelic_telemetry_sdk.harvester" title="Link to this heading"></a></h2> <dl class="py class"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester"> class newrelic_telemetry_sdk.harvester.Harvester(client, batch, harvest_interval=5)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/harvester.html#Harvester">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester" title="Link to this definition"></a></dt> <dd>Bases: <a class="reference external" href="https://docs.python.org/3/library/threading.html#threading.Thread" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate">Thread</code></a> Report data to New Relic at a fixed interval The Harvester is a thread implementation which sends data to New Relic every <code class="docutils literal notranslate">harvest_interval</code> seconds or until the data buffers are full. The reporter will automatically handle error conditions which may occur such as: <ul class="simple"> <li>Network timeouts</li> <li>New Relic errors</li> </ul> <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>client (<a class="reference internal" href="#newrelic_telemetry_sdk.client.MetricClient" title="newrelic_telemetry_sdk.client.MetricClient">MetricClient</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.client.EventClient" title="newrelic_telemetry_sdk.client.EventClient">EventClient</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.client.SpanClient" title="newrelic_telemetry_sdk.client.SpanClient">SpanClient</a>) – The client instance to call in order to send data.</li> <li>batch (<a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch" title="newrelic_telemetry_sdk.metric_batch.MetricBatch">MetricBatch</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.batch.EventBatch" title="newrelic_telemetry_sdk.batch.EventBatch">EventBatch</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.batch.SpanBatch" title="newrelic_telemetry_sdk.batch.SpanBatch">SpanBatch</a>) – A batch with record and flush interfaces.</li> <li>harvest_interval (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – (optional) The interval in seconds at which data will be reported. (default 5)</li> </ul> </dd> <dt class="field-even">Variables:</dt> <dd class="field-even"><ul class="simple"> <li>client (Client) – The telemetry SDK client where the harvester sends data.</li> <li>batch (<a class="reference internal" href="#newrelic_telemetry_sdk.metric_batch.MetricBatch" title="newrelic_telemetry_sdk.metric_batch.MetricBatch">MetricBatch</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.batch.EventBatch" title="newrelic_telemetry_sdk.batch.EventBatch">EventBatch</a> or <a class="reference internal" href="#newrelic_telemetry_sdk.batch.SpanBatch" title="newrelic_telemetry_sdk.batch.SpanBatch">SpanBatch</a>) – The telemetry SDK batch where data is flushed from.</li> </ul> </dd> </dl> Example: <div class="highlight-default notranslate"><div class="highlight"><pre>>>> import os >>> license_key = os.environ.get("NEW_RELIC_LICENSE_KEY", "") >>> from newrelic_telemetry_sdk import MetricBatch, MetricClient >>> metric_client = MetricClient(license_key) >>> metric_batch = MetricBatch() >>> harvester = Harvester(metric_client, metric_batch) >>> harvester.start() >>> harvester.stop() </pre></div> </div> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.getName"> getName()<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.getName" title="Link to this definition"></a></dt> <dd>Return a string used for identification purposes only. This method is deprecated, use the name attribute instead. </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.ident"> property ident<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.ident" title="Link to this definition"></a></dt> <dd>Thread identifier of this thread or None if it has not been started. This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.isDaemon"> isDaemon()<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.isDaemon" title="Link to this definition"></a></dt> <dd>Return whether this thread is a daemon. This method is deprecated, use the daemon attribute instead. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.is_alive"> is_alive()<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.is_alive" title="Link to this definition"></a></dt> <dd>Return whether the thread is alive. This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.join"> join(timeout=None)<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.join" title="Link to this definition"></a></dt> <dd>Wait until the thread terminates. This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs. When the timeout argument is present and not None, it should be a floating-point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out. When the timeout argument is not present or None, the operation will block until the thread terminates. A thread can be join()ed many times. join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception. </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.name"> property name<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.name" title="Link to this definition"></a></dt> <dd>A string used for identification purposes only. It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor. </dd></dl> <dl class="py property"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.native_id"> property native_id<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.native_id" title="Link to this definition"></a></dt> <dd>Native integral thread ID of this thread, or None if it has not been started. This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.setDaemon"> setDaemon(daemonic)<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.setDaemon" title="Link to this definition"></a></dt> <dd>Set whether this thread is a daemon. This method is deprecated, use the .daemon property instead. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.setName"> setName(name)<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.setName" title="Link to this definition"></a></dt> <dd>Set the name string for this thread. This method is deprecated, use the name attribute instead. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.start"> start()<a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.start" title="Link to this definition"></a></dt> <dd>Start the thread’s activity. It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control. This method will raise a RuntimeError if called more than once on the same thread object. </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="newrelic_telemetry_sdk.harvester.Harvester.stop"> stop(timeout=None)<a class="reference internal" href="_modules/newrelic_telemetry_sdk/harvester.html#Harvester.stop">[source]</a><a class="headerlink" href="#newrelic_telemetry_sdk.harvester.Harvester.stop" title="Link to this definition"></a></dt> <dd>Terminate the harvester. This will request and wait for the thread to terminate. The thread will not terminate immediately since any pending data will be sent. When the timeout argument is present, this function will exit after at most timeout seconds. The thread may still be alive after this function exits if the timeout is reached but the thread hasn’t yet terminated. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">timeout (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)">float</a>) – (optional) A timeout in seconds to wait for the thread to shut down or None to block until the thread exits (default: None) </dd> </dl> </dd></dl> </dd></dl> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="proxy.html" class="btn btn-neutral float-left" title="Proxy Support" accesskey="p" rel="prev"> Previous</a> </div> <hr/> <div role="contentinfo"> © Copyright 2019, New Relic. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>