Skip to content

Commit

Permalink
Port readme text into docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
a-feld committed Apr 20, 2020
1 parent 3f7b46b commit a440dc0
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
newrelic-telemetry-sdk: Send data to New Relic!
===============================================

``newrelic-telemetry-sdk`` provides a Python library for sending data into `New Relic <https://newrelic.com>`_ using the Python `urllib3 <https://urllib3.readthedocs.io>`_ library.
`newrelic-telemetry-sdk-python <https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/new-relic-sdks/telemetry-sdks-send-custom-telemetry-data-new-relic>`_ provides a Python library for sending data into `New Relic <https://newrelic.com>`_ using the Python `urllib3 <https://urllib3.readthedocs.io>`_ library.

The current SDK supports sending dimensional metrics to our `Metric API <https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/introduction-metric-api>`_ and spans to our `Trace API <https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/introduction-trace-api>`_.
See dimensional `metrics`_, `events`_, and `spans/traces`_ in New Relic, without having to use an agent!

Why is this cool?
-----------------

Dimensional metrics, events, and traces in New Relic! No agent required.

Our `Telemetry SDK <https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/new-relic-sdks/telemetry-sdks-send-custom-telemetry-data-new-relic>`_ tries to be helpful, so your job of sending telemetry data to New Relic can be done in the right way, easily. We've covered all of the basics for you so you can focus on writing feature code directly related to your business need or interest.

Why would you want to use the Telemetry SDK?
--------------------------------------------

We imagine you (or your customers) are interested in seeing the telemetry data, generated by your tool, framework, or code, in New Relic. You can write an exporter to do so! Read below to get started
.. _metrics: https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/introduction-metric-api#find-data
.. _events: https://docs.newrelic.com/docs/insights/insights-data-sources/custom-data/introduction-event-api#find-data
.. _spans/traces: https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/introduction-trace-api#view-data

Get Started!
------------
Expand Down

0 comments on commit a440dc0

Please sign in to comment.