gRPC Python CSM Observability
=============================
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 <https://github.com/grpc/grpc/tree/master/examples/python/observability>`_, instead of importing from ``grpc_observability``, you should import from ``grpc_csm_observability``:
.. code-block:: python
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.
1. 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).
2. 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.
3. 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).
4. 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).
Raw data
{
"_id": null,
"home_page": "https://grpc.io",
"name": "grpcio-csm-observability",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "The gRPC Authors",
"author_email": "grpc-io@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/6d/bb/a005b370e74234fb446a026e9d7d39d5a74c21af518083ac800c09684666/grpcio_csm_observability-1.70.0.tar.gz",
"platform": null,
"description": "gRPC Python CSM Observability\n=============================\n\nPackage for gRPC Python CSM Observability.\n\n\nInstallation\n------------\n\nCurrently gRPC Python CSM Observability is **only available for Linux**.\n\nInstalling From PyPI\n~~~~~~~~~~~~~~~~~~~~\n\n::\n\n $ pip install grpcio-csm-observability\n\n\nInstalling From Source\n~~~~~~~~~~~~~~~~~~~~~~\n\n::\n\n $ export REPO_ROOT=grpc # REPO_ROOT can be any directory of your choice\n $ git clone -b RELEASE_TAG_HERE https://github.com/grpc/grpc $REPO_ROOT\n $ cd $REPO_ROOT\n $ git submodule update --init\n\n $ cd src/python/grpcio_csm_observability\n\n # For the next command do `sudo pip install` if you get permission-denied errors\n $ pip install .\n\n\nDependencies\n------------\ngRPC Python CSM Observability Depends on the following packages:\n\n::\n\n grpcio\n grpcio-observability\n opentelemetry-sdk\n\n\nUsage\n-----\n\nExample usage is similar to `the example here <https://github.com/grpc/grpc/tree/master/examples/python/observability>`_, instead of importing from ``grpc_observability``, you should import from ``grpc_csm_observability``:\n\n.. code-block:: python\n\n import grpc_csm_observability\n \n csm_otel_plugin = grpc_csm_observability.CsmOpenTelemetryPlugin(\n meter_provider=provider\n )\n\n\nWe also provide several environment variables to help you optimize gRPC python observability for your particular use.\n\n* Note: The term \"Census\" here is just for historical backwards compatibility reasons and does not imply any dependencies.\n\n1. GRPC_PYTHON_CENSUS_EXPORT_BATCH_INTERVAL\n * This controls how frequently telemetry data collected within gRPC Core is sent to Python layer.\n * Default value is 0.5 (Seconds).\n\n2. GRPC_PYTHON_CENSUS_MAX_EXPORT_BUFFER_SIZE\n * 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.\n * Default value is 10,000.\n\n3. GRPC_PYTHON_CENSUS_EXPORT_THRESHOLD\n * 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.\n * Default value is 0.7 (Which means buffer will start export when it's 70% full).\n\n4. GRPC_PYTHON_CENSUS_EXPORT_THREAD_TIMEOUT\n * This controls the maximum time allowed for the exporting thread (responsible for sending data to Python) to complete.\n * Main thread will terminate the exporting thread after this timeout.\n * Default value is 10 (Seconds).\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "gRPC Python CSM observability package",
"version": "1.70.0",
"project_urls": {
"Bug Tracker": "https://github.com/grpc/grpc/issues",
"Homepage": "https://grpc.io",
"Source Code": "https://github.com/grpc/grpc/tree/master/src/python/grpcio_csm_observability"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc8082d3b64473f2c8f3cbceda230fa9cef499393d88e40e2ce4994477c81de8",
"md5": "44594b249d78491a9f3dc74f80519fe2",
"sha256": "675865f66cdced568b87e4fe6de8eb1a161d0bce3b1f02c636ca90765aec9565"
},
"downloads": -1,
"filename": "grpcio_csm_observability-1.70.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44594b249d78491a9f3dc74f80519fe2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15877,
"upload_time": "2025-01-23T17:56:11",
"upload_time_iso_8601": "2025-01-23T17:56:11.938415Z",
"url": "https://files.pythonhosted.org/packages/bc/80/82d3b64473f2c8f3cbceda230fa9cef499393d88e40e2ce4994477c81de8/grpcio_csm_observability-1.70.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6dbba005b370e74234fb446a026e9d7d39d5a74c21af518083ac800c09684666",
"md5": "67da50b8f4489a9adef7325814ba9e7b",
"sha256": "1a162cd41fddf856e8326c4cd2b99337329a0233390ca67321513a50b27fa2e9"
},
"downloads": -1,
"filename": "grpcio_csm_observability-1.70.0.tar.gz",
"has_sig": false,
"md5_digest": "67da50b8f4489a9adef7325814ba9e7b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15795,
"upload_time": "2025-01-23T18:00:24",
"upload_time_iso_8601": "2025-01-23T18:00:24.508206Z",
"url": "https://files.pythonhosted.org/packages/6d/bb/a005b370e74234fb446a026e9d7d39d5a74c21af518083ac800c09684666/grpcio_csm_observability-1.70.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 18:00:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grpc",
"github_project": "grpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "coverage",
"specs": [
[
">=",
"4.0"
]
]
},
{
"name": "cython",
"specs": [
[
">=",
"3.0.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
">=",
"5.26.1"
],
[
"<",
"6.0dev"
]
]
},
{
"name": "wheel",
"specs": [
[
">=",
"0.29"
]
]
}
],
"lcname": "grpcio-csm-observability"
}
JSON
