From b1c4b5846bf1772cd0810061d7cd4c0d270c96e7 Mon Sep 17 00:00:00 2001 From: Angela Li Date: Fri, 15 Dec 2017 15:17:27 -0800 Subject: [PATCH] Update README for the gRPC interceptors --- README.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.rst b/README.rst index 1ea0ab019..669224038 100644 --- a/README.rst +++ b/README.rst @@ -253,6 +253,24 @@ setting in ``settings.py``: 'ZIPKIN_EXPORTER_PORT': 9411, } +gRPC Integration +---------------- + +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 + Service Integration -------------------