Implement Connection Strings for Azure Exporters (#767)

* Connection string

* Implement derived endpoint, authorization

* Update README, add tests

* Fix lint

* Update CHANGELOG

* Fix lint

* Fix examples

* Address comments

* Fix use case

* fix test

* Fix example

* Address comments

* include tests

Author: lzchen

contrib/opencensus-ext-azure/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
 ## Unreleased
+- Implement connection strings
+  ([#767](https://github.com/census-instrumentation/opencensus-python/pull/767))
 - Standard metrics incoming requests per second
   ([#758](https://github.com/census-instrumentation/opencensus-python/pull/758))
 - Standard metrics incoming requests average execution rate

contrib/opencensus-ext-azure/README.rst

@@ -24,8 +24,8 @@ The **Azure Monitor Log Handler** allows you to export Python logs to `Azure Mon
 This example shows how to send a warning level log to Azure Monitor.
 
 * 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>`_.
-* Put the instrumentation key in ``APPINSIGHTS_INSTRUMENTATIONKEY`` environment variable.
-* You can also specify the instrumentation key explicitly in the code, which will take priority over a set environment variable.
+* Place your instrumentation key in a `connection string` and directly into your code.
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
 
 .. code:: python
 
@@ -34,15 +34,16 @@ This example shows how to send a warning level log to Azure Monitor.
     from opencensus.ext.azure.log_exporter import AzureLogHandler
 
     logger = logging.getLogger(__name__)
-    logger.addHandler(AzureLogHandler())
+    logger.addHandler(AzureLogHandler(connection_string='InstrumentationKey=<your-instrumentation_key-here>'))
     logger.warning('Hello, World!')
 
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
+
 You can enrich the logs with trace IDs and span IDs by using the `logging integration <../opencensus-ext-logging>`_.
 
 * 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>`_.
-* Install the `logging integration package <../opencensus-ext-logging>`_ using ``pip install opencensus-ext-logging``.
-* Put the instrumentation key in ``APPINSIGHTS_INSTRUMENTATIONKEY`` environment variable.
-* You can also specify the instrumentation key explicitly in the code, which will take priority over a set environment variable.
+* Place your instrumentation key in a `connection string` and directly into your code.
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
 
 .. code:: python
 
@@ -58,25 +59,28 @@ You can enrich the logs with trace IDs and span IDs by using the `logging integr
 
     logger = logging.getLogger(__name__)
 
-    handler = AzureLogHandler()
+    handler = AzureLogHandler(connection_string='InstrumentationKey=<your-instrumentation_key-here>')
     handler.setFormatter(logging.Formatter('%(traceId)s %(spanId)s %(message)s'))
     logger.addHandler(handler)
 
-    tracer = Tracer(exporter=AzureExporter(), sampler=ProbabilitySampler(1.0))
+    tracer = Tracer(
+        exporter=AzureExporter(connection_string='InstrumentationKey=<your-instrumentation_key-here>'),
+        sampler=ProbabilitySampler(1.0)
+    )
 
     logger.warning('Before the span')
     with tracer.span(name='test'):
         logger.warning('In the span')
-    logger.warning('After the span')
+    logger.warning('After the span')s
 
 Metrics
 ~~~~~~~
 
 The **Azure Monitor Metrics Exporter** allows you to export metrics to `Azure Monitor`_.
 
 * 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>`_.
-* Put the instrumentation key in ``APPINSIGHTS_INSTRUMENTATIONKEY`` environment variable.
-* You can also specify the instrumentation key explicitly in the code, which will take priority over a set environment variable.
+* Place your instrumentation key in a `connection string` and directly into your code.
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
 
 .. code:: python
 
@@ -105,7 +109,7 @@ The **Azure Monitor Metrics Exporter** allows you to export metrics to `Azure Mo
     def main():
         # Enable metrics
         # Set the interval in seconds in which you want to send metrics
-        exporter = metrics_exporter.new_metrics_exporter()
+        exporter = metrics_exporter.new_metrics_exporter(connection_string='InstrumentationKey=<your-instrumentation-key-here>')
         view_manager.register_exporter(exporter)
 
         view_manager.register_view(CARROTS_VIEW)
@@ -138,7 +142,7 @@ The exporter also includes a set of standard metrics that are exported to Azure
         # All you need is the next line. You can disable standard metrics by
         # passing in enable_standard_metrics=False into the constructor of
         # new_metrics_exporter() 
-        _exporter = metrics_exporter.new_metrics_exporter()
+        _exporter = metrics_exporter.new_metrics_exporter(connection_string='InstrumentationKey=<your-instrumentation-key-here>')
         
         for i in range(100):
             print(psutil.virtual_memory())
@@ -167,26 +171,31 @@ The **Azure Monitor Trace Exporter** allows you to export `OpenCensus`_ traces t
 This example shows how to send a span "hello" to Azure Monitor.
 
 * 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>`_.
-* Put the instrumentation key in ``APPINSIGHTS_INSTRUMENTATIONKEY`` environment variable.
-* You can also specify the instrumentation key explicitly in the code, which will take priority over a set environment variable.
+* Place your instrumentation key in a `connection string` and directly into your code.
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
 
-.. code:: python
+ .. code:: python
 
     from opencensus.ext.azure.trace_exporter import AzureExporter
     from opencensus.trace.samplers import ProbabilitySampler
     from opencensus.trace.tracer import Tracer
 
-    tracer = Tracer(exporter=AzureExporter(), sampler=ProbabilitySampler(1.0))
+    tracer = Tracer(
+        exporter=AzureExporter(connection_string='InstrumentationKey=<your-instrumentation-key-here>'),
+        sampler=ProbabilitySampler(1.0)
+    )
 
     with tracer.span(name='hello'):
         print('Hello, World!')
 
-You can also specify the instrumentation key explicitly in the code.
+OpenCensus also supports several [integrations](https://github.com/census-instrumentation/opencensus-python#integration) which allows OpenCensus to integrate with third party libraries.
+
+This example shows how to integrate with the [requests](https://2.python-requests.org/en/master/) library.
 
 * 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>`_.
 * Install the `requests integration package <../opencensus-ext-requests>`_ using ``pip install opencensus-ext-requests``.
-* Put the instrumentation key in ``APPINSIGHTS_INSTRUMENTATIONKEY`` environment variable.
-* You can also specify the instrumentation key explicitly in the code, which will take priority over a set environment variable.
+* Place your instrumentation key in a `connection string` and directly into your code.
+* Alternatively, you can specify your `connection string` in an environment variable ``APPLICATIONINSIGHTS_CONNECTION_STRING``.
 
 .. code:: python
 

contrib/opencensus-ext-azure/examples/logs/correlated.py

@@ -24,8 +24,9 @@
 
 logger = logging.getLogger(__name__)
 
-# TODO: you need to specify the instrumentation key in the
-# APPINSIGHTS_INSTRUMENTATIONKEY environment variable.
+# TODO: you need to specify the instrumentation key in a connection string
+# and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+# environment variable.
 handler = AzureLogHandler()
 logger.addHandler(handler)
 

contrib/opencensus-ext-azure/examples/logs/error.py

@@ -17,8 +17,9 @@
 from opencensus.ext.azure.log_exporter import AzureLogHandler
 
 logger = logging.getLogger(__name__)
-# TODO: you need to specify the instrumentation key in the
-# APPINSIGHTS_INSTRUMENTATIONKEY environment variable.
+# TODO: you need to specify the instrumentation key in a connection string
+# and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+# environment variable.
 logger.addHandler(AzureLogHandler())
 
 

contrib/opencensus-ext-azure/examples/logs/simple.py

@@ -17,7 +17,8 @@
 from opencensus.ext.azure.log_exporter import AzureLogHandler
 
 logger = logging.getLogger(__name__)
-# TODO: you need to specify the instrumentation key in the
-# APPINSIGHTS_INSTRUMENTATIONKEY environment variable.
+# TODO: you need to specify the instrumentation key in a connection string
+# and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+# environment variable.
 logger.addHandler(AzureLogHandler())
 logger.warning('Hello, World!')

contrib/opencensus-ext-azure/examples/metrics/simple.py

@@ -38,6 +38,9 @@
 def main():
     # Enable metrics
     # Set the interval in seconds in which you want to send metrics
+    # TODO: you need to specify the instrumentation key in a connection string
+    # and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+    # environment variable.
     exporter = metrics_exporter.new_metrics_exporter()
     view_manager.register_exporter(exporter)
 

contrib/opencensus-ext-azure/examples/metrics/standard.py

@@ -19,6 +19,9 @@
 
 
 def main():
+    # TODO: you need to specify the instrumentation key in a connection string
+    # and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+    # environment variable.
     # All you need is the next line. You can disable standard metrics by
     # passing in enable_standard_metrics=False into the constructor of
     # new_metrics_exporter()

contrib/opencensus-ext-azure/examples/metrics/sum.py

@@ -38,6 +38,9 @@
 def main():
     # Enable metrics
     # Set the interval in seconds in which you want to send metrics
+    # TODO: you need to specify the instrumentation key in a connection string
+    # and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+    # environment variable.
     exporter = metrics_exporter.new_metrics_exporter()
     view_manager.register_exporter(exporter)
 

contrib/opencensus-ext-azure/examples/traces/client.py

@@ -20,8 +20,9 @@
 from opencensus.trace.tracer import Tracer
 
 config_integration.trace_integrations(['requests'])
-# TODO: you need to specify the instrumentation key in the
-# APPINSIGHTS_INSTRUMENTATIONKEY environment variable.
+# TODO: you need to specify the instrumentation key in a connection string
+# and place it in the APPLICATIONINSIGHTS_CONNECTION_STRING
+# environment variable.
 tracer = Tracer(exporter=AzureExporter(), sampler=ProbabilitySampler(1.0))
 with tracer.span(name='parent'):
     with tracer.span(name='child'):

contrib/opencensus-ext-azure/examples/traces/config.py

@@ -19,7 +19,8 @@
 tracer = Tracer(
     exporter=AzureExporter(
         # TODO: replace the all-zero GUID with your instrumentation key.
-        instrumentation_key='00000000-0000-0000-0000-000000000000',
+        connection_string='InstrumentationKey= \
+        00000000-0000-0000-0000-000000000000',
     ),
     sampler=ProbabilitySampler(rate=1.0),
 )