Metadata-Version: 2.3
Name: sb-opentelemetry-sdk-extension-statsd
Version: 1.0.2
Summary: StatsD extension for OpenTelemetry
Author: Rangel Reale, Rangel Reale
Author-email: Rangel Reale <rangelreale@gmail.com>, Rangel Reale <rangelspam@gmail.com>
License: Apache-2.0
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: setuptools>=80.9.0
Requires-Dist: opentelemetry-sdk~=1.38
Requires-Dist: statsd-python~=0.6
Requires-Python: >=3.9
Project-URL: Bug Tracker, https://github.com/SibrosTech/otel-statsd/issues
Project-URL: Homepage, https://github.com/SibrosTech/otel-statsd/tree/master/python/opentelemetry-sdk-extension-statsd
Provides-Extra: test
Description-Content-Type: text/x-rst

OpenTelemetry SDK Extension for StatsD
=======================================================

This library provides components necessary to send OpenTelemetry
metrics to a StatsD backend.

Installation
------------

::

    pip install sb-opentelemetry-sdk-extension-statsd

Usage
-----

Install the OpenTelemetry SDK package.

::

    pip install opentelemetry-sdk

Next, use the provided `StatsdMeterProvider` instead of the default `MeterProvider`.

.. code-block:: python

    from statsd import StatsdClient

    from opentelemetry import metrics
    from opentelemetry.sdk.resources import Resource
    from opentelemetry.sdk.extension.statsd.metrics import StatsdMeterProvider

    statsd = StatsdClient(max_buffer_size=0)
    provider = StatsdMeterProvider(statsd=statsd, resource=Resource(attributes={
        "service.name": "service-Name",
    }))
    metrics.set_meter_provider(provider)


References
----------

* `OpenTelemetry Project <https://opentelemetry.io/>`_
* `OpenTelemetry Specification for Resource Attributes <https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/resource/semantic_conventions>`_
