Skip to content
This repository was archived by the owner on Sep 17, 2025. It is now read-only.

Commit 54fe7ee

Browse files
committed
Update README.rst
1 parent 317fd5b commit 54fe7ee

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

contrib/opencensus-ext-azure/README.rst

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
OpenCensus Azure Monitor Exporters
2-
============================================================================
2+
==================================
33

44
|pypi|
55

@@ -13,6 +13,13 @@ Installation
1313

1414
pip install opencensus-ext-azure
1515

16+
Prerequisites
17+
-------------
18+
19+
* Create an Azure Monitor resource and get the instrumentation key, more information can be found in the official `docs <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
20+
* Place your instrumentation key in a `connection string` and directly into your code.
21+
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
22+
1623
Usage
1724
-----
1825

@@ -23,10 +30,6 @@ The **Azure Monitor Log Handler** allows you to export Python logs to `Azure Mon
2330

2431
This example shows how to send a warning level log to Azure Monitor.
2532

26-
* Create an Azure Monitor resource and get the instrumentation key, more information can be found `here <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
27-
* Place your instrumentation key in a `connection string` and directly into your code.
28-
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
29-
3033
.. code:: python
3134
3235
import logging
@@ -42,10 +45,7 @@ Correlation
4245

4346
You can enrich the logs with trace IDs and span IDs by using the `logging integration <../opencensus-ext-logging>`_.
4447

45-
* Create an Azure Monitor resource and get the instrumentation key, more information can be found `here <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
4648
* Install the `logging integration package <../opencensus-ext-logging>`_ using ``pip install opencensus-ext-logging``.
47-
* Place your instrumentation key in a `connection string` and directly into your code.
48-
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
4949

5050
.. code:: python
5151
@@ -142,10 +142,6 @@ Metrics
142142

143143
The **Azure Monitor Metrics Exporter** allows you to export metrics to `Azure Monitor`_.
144144

145-
* Create an Azure Monitor resource and get the instrumentation key, more information can be found `here <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
146-
* Place your instrumentation key in a `connection string` and directly into your code.
147-
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
148-
149145
.. code:: python
150146
151147
import time
@@ -297,10 +293,6 @@ The **Azure Monitor Trace Exporter** allows you to export `OpenCensus`_ traces t
297293

298294
This example shows how to send a span "hello" to Azure Monitor.
299295

300-
* Create an Azure Monitor resource and get the instrumentation key, more information can be found `here <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
301-
* Place your instrumentation key in a `connection string` and directly into your code.
302-
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
303-
304296
.. code:: python
305297
306298
from opencensus.ext.azure.trace_exporter import AzureExporter
@@ -324,10 +316,7 @@ OpenCensus also supports several `integrations <https://github.com/census-instru
324316

325317
This example shows how to integrate with the `requests <https://2.python-requests.org/en/master/>`_ library.
326318

327-
* Create an Azure Monitor resource and get the instrumentation key, more information can be found `here <https://docs.microsoft.com/azure/azure-monitor/app/create-new-resource>`_.
328319
* Install the `requests integration package <../opencensus-ext-requests>`_ using ``pip install opencensus-ext-requests``.
329-
* Place your instrumentation key in a `connection string` and directly into your code.
330-
* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
331320

332321
.. code:: python
333322
@@ -384,7 +373,7 @@ Modifying Traces
384373
Integrate with Azure Functions
385374
##############################
386375

387-
Users who want to capture custom telemetry in Azure Functions environments are encouraged to used the OpenCensus Python Azure Functions `extension <https://github.com/census-ecosystem/opencensus-python-extensions-azure/tree/main/extensions/functions#opencensus-python-azure-functions-extension>`_. More details can be found `here <https://docs.microsoft.com/azure/azure-functions/functions-reference-python?tabs=application-level#log-custom-telemetry>`_.
376+
Users who want to capture custom telemetry in Azure Functions environments are encouraged to used the OpenCensus Python Azure Functions `extension <https://github.com/census-ecosystem/opencensus-python-extensions-azure/tree/main/extensions/functions#opencensus-python-azure-functions-extension>`_. More details can be found in this `document <https://docs.microsoft.com/azure/azure-functions/functions-reference-python?tabs=application-level#log-custom-telemetry>`_.
388377

389378
References
390379
----------

0 commit comments

Comments
 (0)