Skeleton for Azure Log Exporter (#657)

added initial prototype on log exporter
added skeleton azure log exporter

Author: reyang

README.rst

@@ -237,6 +237,11 @@ Stats Exporter
 .. _threading: https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-threading
 .. _Zipkin: https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-zipkin
 
+Log Exporter
+--------------
+
+-  `Azure`_
+
 ------------
  Versioning
 ------------

contrib/opencensus-ext-azure/CHANGELOG.md

@@ -1,7 +1,9 @@
 # Changelog
 
 ## Unreleased
-- Add persistent storage support
+- Added log exporter
+  ([#657](https://github.com/census-instrumentation/opencensus-python/pull/657))
+- Added persistent storage support
   ([#640](https://github.com/census-instrumentation/opencensus-python/pull/640))
 - Changed AzureExporter constructor signature to use kwargs
   ([#632](https://github.com/census-instrumentation/opencensus-python/pull/632))

contrib/opencensus-ext-azure/README.rst

@@ -1,4 +1,4 @@
-OpenCensus Azure Monitor Trace Exporter
+OpenCensus Azure Monitor Exporters
 ============================================================================
 
 |pypi|
@@ -21,15 +21,11 @@ Trace
 
 The **Azure Monitor Trace Exporter** allows you to export `OpenCensus`_ traces to `Azure Monitor`_.
 
-.. _Azure Monitor: https://docs.microsoft.com/azure/azure-monitor/
-.. _OpenCensus: https://github.com/census-instrumentation/opencensus-python/
-
 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.
 
-
 .. code:: python
 
     from opencensus.ext.azure.trace_exporter import AzureExporter
@@ -43,6 +39,10 @@ This example shows how to send a span "hello" to Azure Monitor.
 
 You can also specify the instrumentation key explicitly in the code.
 
+* 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 the following code.
+
 .. code:: python
 
     import requests
@@ -57,16 +57,69 @@ You can also specify the instrumentation key explicitly in the code.
         exporter=AzureExporter(
             # TODO: replace this with your own instrumentation key.
             instrumentation_key='00000000-0000-0000-0000-000000000000',
-            timeout=29.9,
         ),
         sampler=ProbabilitySampler(1.0),
     )
     with tracer.span(name='parent'):
         response = requests.get(url='https://www.wikipedia.org/wiki/Rabbit')
 
+Log
+~~~
+
+The **Azure Monitor Log Handler** allows you to export Python logs to `Azure Monitor`_.
+
+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.
+
+.. code:: python
+
+    import logging
+
+    from opencensus.ext.azure.log_exporter import AzureLogHandler
+
+    logger = logging.getLogger(__name__)
+    logger.addHandler(AzureLogHandler())
+    logger.warning('Hello, World!')
+
+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.
+
+.. code:: python
+
+    import logging
+
+    from opencensus.ext.azure.log_exporter import AzureLogHandler
+    from opencensus.ext.azure.trace_exporter import AzureExporter
+    from opencensus.trace import config_integration
+    from opencensus.trace.samplers import ProbabilitySampler
+    from opencensus.trace.tracer import Tracer
+
+    config_integration.trace_integrations(['logging'])
+
+    logger = logging.getLogger(__name__)
+
+    handler = AzureLogHandler()
+    handler.setFormatter(logging.Formatter('%(traceId)s %(spanId)s %(message)s'))
+    logger.addHandler(handler)
+
+    tracer = Tracer(exporter=AzureExporter(), sampler=ProbabilitySampler(1.0))
+
+    logger.warning('Before the span')
+    with tracer.span(name='test'):
+        logger.warning('In the span')
+    logger.warning('After the span')
+
 References
 ----------
 
 * `Azure Monitor <https://docs.microsoft.com/azure/azure-monitor/>`_
 * `Examples <https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-azure/examples>`_
 * `OpenCensus Project <https://opencensus.io/>`_
+
+.. _Azure Monitor: https://docs.microsoft.com/azure/azure-monitor/
+.. _OpenCensus: https://github.com/census-instrumentation/opencensus-python/

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

@@ -0,0 +1,38 @@
+# Copyright 2019, OpenCensus Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+
+from opencensus.ext.azure.log_exporter import AzureLogHandler
+from opencensus.ext.azure.trace_exporter import AzureExporter
+from opencensus.trace import config_integration
+from opencensus.trace.samplers import ProbabilitySampler
+from opencensus.trace.tracer import Tracer
+
+config_integration.trace_integrations(['logging'])
+
+logger = logging.getLogger(__name__)
+
+# TODO: you need to specify the instrumentation key in the
+# APPINSIGHTS_INSTRUMENTATIONKEY environment variable.
+handler = AzureLogHandler()
+handler.setFormatter(logging.Formatter('%(traceId)s %(spanId)s %(message)s'))
+logger.addHandler(handler)
+
+tracer = Tracer(exporter=AzureExporter(), sampler=ProbabilitySampler(1.0))
+
+logger.warning('Before the span')
+with tracer.span(name='test'):
+    logger.warning('In the span')
+logger.warning('After the span')

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

@@ -0,0 +1,23 @@
+# Copyright 2019, OpenCensus Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import logging
+
+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.
+logger.addHandler(AzureLogHandler())
+logger.warning('Hello, World!')

…/opencensus-ext-azure/examples/client.py …nsus-ext-azure/examples/traces/client.pycontrib/opencensus-ext-azure/examples/client.py renamed to contrib/opencensus-ext-azure/examples/traces/client.py contrib/opencensus-ext-azure/examples/client.py renamed to contrib/opencensus-ext-azure/examples/traces/client.py

@@ -22,7 +22,6 @@
         'SAMPLER': 'opencensus.trace.samplers.ProbabilitySampler(rate=1.0)',
         'EXPORTER': '''opencensus.ext.azure.trace_exporter.AzureExporter(
             instrumentation_key='00000000-0000-0000-0000-000000000000',
-            timeout=29.9,
         )''',
     },
 }