Fix to run the Auto instrumentation example in the docs (#1435)

* Fix to run the auto-instrumentation example successfully

* reverting the changes in ConsoleSpanExporter, setup.cfg
Modifying the README.rst accordingly.

* changes to include a consolespanexporter and consolemetricsexporter as per review comments.

* Change as per review comments to replace **kwargs with service_name

* moving the service_name as the first parameter in the ConsoleSpanExporter since some py35-exporter-zipkin test were failing.

* changes to add the service_name to the exported span

* pass the service name to the exported span
fix the unit tests for the above change.

* update the setup.cfg to the correct path of ConsoleMetricsExporter

* revert the changes to add the service_name to the exported span.

Co-authored-by: Leighton Chen <[email protected]>

Author: dmarar

docs/examples/auto-instrumentation/README.rst

@@ -37,9 +37,8 @@ Manually instrumented server
     def server_request():
         with tracer.start_as_current_span(
             "server_request",
-            parent=propagators.extract(
-                lambda dict_, key: dict_.get(key, []), request.headers
-            )["current-span"],
+            context=propagators.extract(DictGetter(), request.headers
+            ),
         ):
             print(request.args.get("param"))
             return "served"
@@ -137,7 +136,12 @@ similar to the following example:
             "http.flavor": "1.1"
         },
         "events": [],
-        "links": []
+        "links": [],
+        "resource": {
+            "telemetry.sdk.language": "python",
+            "telemetry.sdk.name": "opentelemetry",
+            "telemetry.sdk.version": "0.16b1"
+        }
     }
 
 Execute an automatically instrumented server
@@ -148,7 +152,7 @@ and run the following command instead:
 
 .. code:: sh
 
-    $ opentelemetry-instrument python server_uninstrumented.py
+    $ opentelemetry-instrument -e console_span,console_metrics python server_uninstrumented.py
 
 In the console where you previously executed ``client.py``, run the following
 command again:
@@ -192,7 +196,13 @@ similar to the following example:
             "http.status_code": 200
         },
         "events": [],
-        "links": []
+        "links": [],
+        "resource": {
+        "telemetry.sdk.language": "python",
+        "telemetry.sdk.name": "opentelemetry",
+        "telemetry.sdk.version": "0.16b1",
+        "service.name": ""
+        }
     }
 
 You can see that both outputs are the same because automatic instrumentation does

docs/examples/auto-instrumentation/server_instrumented.py

@@ -21,6 +21,7 @@
     ConsoleSpanExporter,
     SimpleExportSpanProcessor,
 )
+from opentelemetry.trace.propagation.textmap import DictGetter
 
 app = Flask(__name__)
 
@@ -36,9 +37,7 @@
 def server_request():
     with tracer.start_as_current_span(
         "server_request",
-        parent=propagators.extract(
-            lambda dict_, key: dict_.get(key, []), request.headers
-        )["current-span"],
+        context=propagators.extract(DictGetter(), request.headers),
         kind=trace.SpanKind.SERVER,
         attributes=collect_request_attributes(request.environ),
     ):

opentelemetry-sdk/setup.cfg

@@ -53,6 +53,9 @@ opentelemetry_tracer_provider =
     sdk_tracer_provider = opentelemetry.sdk.trace:TracerProvider
 opentelemetry_propagator =
     b3 = opentelemetry.sdk.trace.propagation.b3_format:B3Format
+opentelemetry_exporter =
+    console_span = opentelemetry.sdk.trace.export:ConsoleSpanExporter
+    console_metrics = opentelemetry.sdk.metrics.export:ConsoleMetricsExporter
 
 [options.extras_require]
 test =

opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

@@ -13,12 +13,14 @@
 # limitations under the License.
 
 import collections
+import json
 import logging
 import os
 import sys
 import threading
 import typing
 from enum import Enum
+from typing import Optional
 
 from opentelemetry.configuration import Configuration
 from opentelemetry.context import Context, attach, detach, set_value
@@ -370,12 +372,14 @@ class ConsoleSpanExporter(SpanExporter):
 
     def __init__(
         self,
+        service_name: Optional[str] = None,
         out: typing.IO = sys.stdout,
         formatter: typing.Callable[[Span], str] = lambda span: span.to_json()
         + os.linesep,
     ):
         self.out = out
         self.formatter = formatter
+        self.service_name = service_name
 
     def export(self, spans: typing.Sequence[Span]) -> SpanExportResult:
         for span in spans:

opentelemetry-sdk/tests/trace/export/test_export.py

@@ -477,14 +477,15 @@ def test_batch_span_processor_parameters(self):
 class TestConsoleSpanExporter(unittest.TestCase):
     def test_export(self):  # pylint: disable=no-self-use
         """Check that the console exporter prints spans."""
-        exporter = export.ConsoleSpanExporter()
 
+        exporter = export.ConsoleSpanExporter()
         # Mocking stdout interferes with debugging and test reporting, mock on
         # the exporter instance instead.
         span = trace._Span("span name", trace_api.INVALID_SPAN_CONTEXT)
         with mock.patch.object(exporter, "out") as mock_stdout:
             exporter.export([span])
         mock_stdout.write.assert_called_once_with(span.to_json() + os.linesep)
+
         self.assertEqual(mock_stdout.write.call_count, 1)
         self.assertEqual(mock_stdout.flush.call_count, 1)