Azure Core Tracing OpenTelemetry client library for Python
==========================================================

Getting started
---------------

Install the package
^^^^^^^^^^^^^^^^^^^

Install the opentelemetry python for Python with `pip <https://pypi.org/project/pip/>`_\ :

.. code-block:: bash

   pip install azure-core-tracing-opentelemetry

Now you can use opentelemetry for Python as usual with any SDKs that are compatible
with azure-core tracing. This includes (not exhaustive list), azure-storage-blob, azure-keyvault-secrets, azure-eventhub, etc.

Key concepts
------------


* You don't need to pass any context, SDK will get it for you
* 
  Those lines are the only ones you need to enable tracing

  .. code-block:: python

       from azure.core.settings import settings
       from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan
       settings.tracing_implementation = OpenTelemetrySpan

Examples
--------

There is no explicit context to pass, you just create your usual opentelemetry tracer and
call any SDK code that is compatible with azure-core tracing. This is an example
using Azure Monitor exporter, but you can use any exporter (Zipkin, etc.).

.. code-block:: python


   # Declare OpenTelemetry as enabled tracing plugin for Azure SDKs
   from azure.core.settings import settings
   from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan

   settings.tracing_implementation = OpenTelemetrySpan

   # In the below example, we use a simple console exporter, uncomment these lines to use
   # the Azure Monitor Exporter.
   # Example of Azure Monitor exporter, but you can use anything OpenTelemetry supports
   # from azure_monitor import AzureMonitorSpanExporter
   # exporter = AzureMonitorSpanExporter(
   #     instrumentation_key="uuid of the instrumentation key (see your Azure Monitor account)"
   # )

   # Regular open telemetry usage from here, see https://github.com/open-telemetry/opentelemetry-python
   # for details
   from opentelemetry import trace
   from opentelemetry.sdk.trace import TracerProvider
   from opentelemetry.sdk.trace.export import ConsoleSpanExporter
   from opentelemetry.sdk.trace.export import SimpleExportSpanProcessor

   # Simple console exporter
   exporter = ConsoleSpanExporter()

   trace.set_tracer_provider(TracerProvider())
   tracer = trace.get_tracer(__name__)
   trace.get_tracer_provider().add_span_processor(
       SimpleExportSpanProcessor(exporter)
   )

   # Example with Storage SDKs

   from azure.storage.blob import BlobServiceClient

   with tracer.start_as_current_span(name="MyApplication"):
       client = BlobServiceClient.from_connection_string('connectionstring')
       client.create_container('mycontainer')  # Call will be traced

Azure Exporter can be found in the `package <https://pypi.org/project/opentelemetry-azure-monitor-exporter/>`_ ``opentelemetry-azure-monitor-exporter``

Troubleshooting
---------------

This client raises exceptions defined in `Azure Core <https://docs.microsoft.com/en-us/python/api/azure-core/azure.core.exceptions?view=azure-python>`_.

Next steps
----------

More documentation on OpenTelemetry configuration can be found on the `OpenTelemetry website <https://opentelemetry.io>`_

Contributing
------------

This project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`_. For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`_ or contact `opencode@microsoft.com <mailto:opencode@microsoft.com>`_ with any additional questions or comments.


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
  :maxdepth: 5
  :glob:
  :caption: Developer Documentation

  azure.core.tracing.ext.opentelemetry_span.rst