OpenCensus gRPC Integration
============================================================================

|pypi|

.. |pypi| image:: https://badge.fury.io/py/opencensus-ext-grpc.svg
   :target: https://pypi.org/project/opencensus-ext-grpc/

OpenCensus provides the implementation of interceptors for both the client side
and server side to instrument the gRPC requests and responses. The client
interceptors are used to create a decorated channel that intercepts client
gRPC calls and server interceptors act as decorators over handlers.

gRPC interceptor is a new feature in the grpcio1.8.0 release, please upgrade
your grpcio to the latest version to use this feature.

For sample usage, please refer to the hello world example in the examples
directory.

More information about the gRPC interceptors please see the `proposal`_.

.. _proposal: https://github.com/mehrdada/proposal/blob/python-interceptors/L13-Python-Interceptors.md

Installation
------------

::

    pip install opencensus-ext-grpc

Usage
-----

Please refer to the `examples <https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-grpc/examples>`_.
For more information, read `gRPC Python Interceptors <https://github.com/grpc/proposal/blob/master/L13-python-interceptors.md>`_.

References
----------

* `Examples <https://github.com/census-instrumentation/opencensus-python/tree/master/contrib/opencensus-ext-grpc/examples>`_
* `gRPC <https://grpc.io/>`_
* `OpenCensus Project <https://opencensus.io/>`_
