Skip to content

Commit

Permalink
Repharse
Browse files Browse the repository at this point in the history
  • Loading branch information
XuanWang-Amos committed Jan 19, 2024
1 parent 20e8cdd commit 47f9f91
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions src/python/grpcio_observability/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ More details can be found in `OpenTelemetry Metrics gRFC <https://github.com/grp
How gRPC Python Observability Works
-------------------------

gRPC Python is a wrapper layer built upon the gRPC Core (written in C/C++). Most of census data is collected at core layer and then exported to Python layer.
gRPC Python is a wrapper layer built upon the gRPC Core (written in C/C++). Most of census data
is collected at core layer and then exported to Python layer. To optimize performance and reduce
the overhead of acquiring GIL too frequently, census data is initially cached at the Core layer
and then exported to the Python layer in batches.

To optimize performance and reduce the overhead of acquiring GIL too frequently, census data is initially cached at the Core layer.

This data is then exported to the Python layer in batches. While this approach enhances efficiency, it will introduce a slight delay between the time the data is collected and the time it becomes available through Python exporters.
Note that while this approach enhances efficiency, it will introduce a slight delay between the
time the data is collected and the time it becomes available through Python exporters.


Supported Python Versions
Expand Down Expand Up @@ -67,9 +69,9 @@ gRPC Python Observability Depends on the following packages:
Usage
-----

You can find example usage in `Python example folder <https://pypi.python.org/pypi/grpcio-health-checking>`_.
You can find example usage in `Python example folder <https://github.com/grpc/grpc/tree/master/examples/python/observability>`_.

We also provides couple of environment variables to help you optimize gRPC for your particular use.
We also provides couple of environment variables to help you optimize gRPC python observability for your particular use.

1. GRPC_PYTHON_CENSUS_EXPORT_BATCH_INTERVAL
* This controls how frequently census data collected within gRPC Core is sent to Python layer.
Expand Down

0 comments on commit 47f9f91

Please sign in to comment.