gRPC Instrumentation - Support of metrics, messages as span events, conformity to official grpc.ClientInterceptor and bug fixes

CHANGELOG.md

@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Adding metrics in gRPC framework and creation of span events for messages
+  ([#1227](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1227))
 - `opentelemetry-instrumentation-boto3sqs` Make propagation compatible with other SQS instrumentations, add 'messaging.url' span attribute, and fix missing package dependencies.
   ([#1234](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1234)) 
 - `opentelemetry-instrumentation-pymongo` Change span names to not contain queries but only database name and command name

instrumentation/opentelemetry-instrumentation-grpc/src/opentelemetry/instrumentation/grpc/__init__.py

@@ -27,6 +27,11 @@
 
     from opentelemetry import trace
     from opentelemetry.instrumentation.grpc import GrpcInstrumentorClient
+    from opentelemetry.sdk.metrics import MeterProvider
+    from opentelemetry.sdk.metrics.export import (
+        ConsoleMetricExporter,
+        PeriodicExportingMetricReader,
+    )
     from opentelemetry.sdk.trace import TracerProvider
     from opentelemetry.sdk.trace.export import (
         ConsoleSpanExporter,
@@ -38,6 +43,12 @@
     except ImportError:
         from gen import helloworld_pb2, helloworld_pb2_grpc
 
+    exporter = ConsoleMetricExporter()
+    reader = PeriodicExportingMetricReader(exporter)
+    metrics.set_meter_provider(
+        MeterProvider(metric_readers=[reader])
+    )
+
     trace.set_tracer_provider(TracerProvider())
     trace.get_tracer_provider().add_span_processor(
         SimpleSpanProcessor(ConsoleSpanExporter())
@@ -59,6 +70,18 @@ def run():
         logging.basicConfig()
         run()
 
+You can also add the instrumentor manually, rather than using
+:py:class:`~opentelemetry.instrumentation.grpc.GrpcInstrumentorClient`:
+
+.. code-block:: python
+
+    from opentelemetry.instrumentation.grpc import client_interceptor
+
+    channel = grpc.intercept_channel(
+        grpc.insecure_channel(...) / grpc.secure_channel(...),
+        client_interceptor()
+    )
+
 Usage Server
 ------------
 .. code-block:: python
@@ -68,8 +91,13 @@ def run():
 
     import grpc
 
-    from opentelemetry import trace
+    from opentelemetry import metrics, trace
     from opentelemetry.instrumentation.grpc import GrpcInstrumentorServer
+    from opentelemetry.sdk.metrics import MeterProvider
+    from opentelemetry.sdk.metrics.export import (
+        ConsoleMetricExporter,
+        PeriodicExportingMetricReader,
+    )
     from opentelemetry.sdk.trace import TracerProvider
     from opentelemetry.sdk.trace.export import (
         ConsoleSpanExporter,
@@ -81,6 +109,12 @@ def run():
     except ImportError:
         from gen import helloworld_pb2, helloworld_pb2_grpc
 
+    exporter = ConsoleMetricExporter()
+    reader = PeriodicExportingMetricReader(exporter)
+    metrics.set_meter_provider(
+        MeterProvider(metric_readers=[reader])
+    )
+
     trace.set_tracer_provider(TracerProvider())
     trace.get_tracer_provider().add_span_processor(
         SimpleSpanProcessor(ConsoleSpanExporter())
@@ -124,8 +158,7 @@ def serve():
 import grpc  # pylint:disable=import-self
 from wrapt import wrap_function_wrapper as _wrap
 
-from opentelemetry import trace
-from opentelemetry.instrumentation.grpc.grpcext import intercept_channel
+from opentelemetry import metrics, trace
 from opentelemetry.instrumentation.grpc.package import _instruments
 from opentelemetry.instrumentation.grpc.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
@@ -154,17 +187,25 @@ def instrumentation_dependencies(self) -> Collection[str]:
 
     def _instrument(self, **kwargs):
         self._original_func = grpc.server
+        meter_provider = kwargs.get("meter_provider")
         tracer_provider = kwargs.get("tracer_provider")
 
         def server(*args, **kwargs):
             if "interceptors" in kwargs:
                 # add our interceptor as the first
                 kwargs["interceptors"].insert(
-                    0, server_interceptor(tracer_provider=tracer_provider)
+                    0,
+                    server_interceptor(
+                        meter_provider=meter_provider,
+                        tracer_provider=tracer_provider,
+                    ),
                 )
             else:
                 kwargs["interceptors"] = [
-                    server_interceptor(tracer_provider=tracer_provider)
+                    server_interceptor(
+                        meter_provider=meter_provider,
+                        tracer_provider=tracer_provider,
+                    )
                 ]
             return self._original_func(*args, **kwargs)
 
@@ -218,40 +259,49 @@ def _uninstrument(self, **kwargs):
 
     def wrapper_fn(self, original_func, instance, args, kwargs):
         channel = original_func(*args, **kwargs)
+        meter_provider = kwargs.get("meter_provider")
         tracer_provider = kwargs.get("tracer_provider")
-        return intercept_channel(
+        return grpc.intercept_channel(
             channel,
-            client_interceptor(tracer_provider=tracer_provider),
+            client_interceptor(
+                meter_provider=meter_provider, tracer_provider=tracer_provider
+            ),
         )
 
 
-def client_interceptor(tracer_provider=None):
+def client_interceptor(meter_provider=None, tracer_provider=None):
     """Create a gRPC client channel interceptor.
 
     Args:
-        tracer: The tracer to use to create client-side spans.
+        meter_provider: The meter provider which allows access to the meter.
+        tracer_provider: The tracer provider which allows access to the tracer.
 
     Returns:
         An invocation-side interceptor object.
     """
+
     from . import _client
 
+    meter = metrics.get_meter(__name__, __version__, meter_provider)
     tracer = trace.get_tracer(__name__, __version__, tracer_provider)
 
-    return _client.OpenTelemetryClientInterceptor(tracer)
+    return _client.OpenTelemetryClientInterceptor(meter, tracer)
 
 
-def server_interceptor(tracer_provider=None):
+def server_interceptor(meter_provider=None, tracer_provider=None):
     """Create a gRPC server interceptor.
 
     Args:
-        tracer: The tracer to use to create server-side spans.
+        meter_provider: The meter provider which allows access to the meter.
+        tracer_provider: The tracer provider which allows access to the tracer.
 
     Returns:
         A service-side interceptor object.
     """
+
     from . import _server
 
+    meter = metrics.get_meter(__name__, __version__, meter_provider)
     tracer = trace.get_tracer(__name__, __version__, tracer_provider)
 
-    return _server.OpenTelemetryServerInterceptor(tracer)
+    return _server.OpenTelemetryServerInterceptor(meter, tracer)