gRPC Python CSM observability package
Project description
Package for gRPC Python CSM Observability.
Installation
Currently gRPC Python CSM Observability is only available for Linux.
Installing From PyPI
$ pip install grpcio-csm-observability
Installing From Source
$ export REPO_ROOT=grpc # REPO_ROOT can be any directory of your choice $ git clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc $REPO_ROOT $ cd $REPO_ROOT $ git submodule update --init $ cd src/python/grpcio_csm_observability # For the next command do `sudo pip install` if you get permission-denied errors $ pip install .
Dependencies
gRPC Python CSM Observability Depends on the following packages:
grpcio grpcio-observability opentelemetry-sdk
Usage
Example usage is similar to the example here, instead of importing from grpc_observability, you should import from grpc_csm_observability:
import grpc_csm_observability
csm_otel_plugin = grpc_csm_observability.CsmOpenTelemetryPlugin(
meter_provider=provider
)We also provide several environment variables to help you optimize gRPC python observability for your particular use.
Note: The term “Census” here is just for historical backwards compatibility reasons and does not imply any dependencies.
- GRPC_PYTHON_CENSUS_EXPORT_BATCH_INTERVAL
This controls how frequently telemetry data collected within gRPC Core is sent to Python layer.
Default value is 0.5 (Seconds).
- GRPC_PYTHON_CENSUS_MAX_EXPORT_BUFFER_SIZE
This controls the maximum number of telemetry data items that can be held in the buffer within gRPC Core before they are sent to Python.
Default value is 10,000.
- GRPC_PYTHON_CENSUS_EXPORT_THRESHOLD
This setting acts as a trigger: When the buffer in gRPC Core reaches a certain percentage of its capacity, the telemetry data is sent to Python.
Default value is 0.7 (Which means buffer will start export when it’s 70% full).
- GRPC_PYTHON_CENSUS_EXPORT_THREAD_TIMEOUT
This controls the maximum time allowed for the exporting thread (responsible for sending data to Python) to complete.
Main thread will terminate the exporting thread after this timeout.
Default value is 10 (Seconds).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file grpcio_csm_observability-1.68.0rc1.tar.gz.
File metadata
- Download URL: grpcio_csm_observability-1.68.0rc1.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd505be8be160e7fd37980e2e37fa87ad37e701fe7e6972395346c198e501294 |
|
| MD5 | 434b32ef1fdba1a941a57186729e4012 |
|
| BLAKE2b-256 | 55f537330933d65148940dc4013e58d5b06e9091334c418253732aacba635a10 |
File details
Details for the file grpcio_csm_observability-1.68.0rc1-py3-none-any.whl.
File metadata
- Download URL: grpcio_csm_observability-1.68.0rc1-py3-none-any.whl
- Upload date:
- Size: 15.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 10ee25cc02ec65ce4f2a6b6e52c88d85a4c6ad6232ad91fded42e6550c4f32f3 |
|
| MD5 | 275db3d87cbb59dd6fccfe237930a449 |
|
| BLAKE2b-256 | 0597af7da13769dd1389fec0e1f15da303fdd3cc89e04753b5624a89647d6ad7 |
