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/b0/77/b452bad5a614d00d11c2d7d3dba979de82bba18690e654a3db3e50815dcf/grpcio_csm_observability-1.68.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.68.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": "f41698abfe7b9f09ce4e04308fb07aad1f9cba8611813f5feea775b89b695182",
"md5": "07e5fa7db89394afc500a8c1f90eab79",
"sha256": "7eb08f3fc6b414f0f7ea072bbf3ecfc5dbefbcc76b526d299acdda2f13e64ccf"
},
"downloads": -1,
"filename": "grpcio_csm_observability-1.68.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07e5fa7db89394afc500a8c1f90eab79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15877,
"upload_time": "2024-11-16T00:21:33",
"upload_time_iso_8601": "2024-11-16T00:21:33.795791Z",
"url": "https://files.pythonhosted.org/packages/f4/16/98abfe7b9f09ce4e04308fb07aad1f9cba8611813f5feea775b89b695182/grpcio_csm_observability-1.68.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b077b452bad5a614d00d11c2d7d3dba979de82bba18690e654a3db3e50815dcf",
"md5": "efccd90cdfbcdda64f80267c538e2071",
"sha256": "e1380a8e5966a8e44c3dd74d7bad7c9114d76bfb0e355b6d7c3a520e2ca265e6"
},
"downloads": -1,
"filename": "grpcio_csm_observability-1.68.0.tar.gz",
"has_sig": false,
"md5_digest": "efccd90cdfbcdda64f80267c538e2071",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 15776,
"upload_time": "2024-11-16T00:24:40",
"upload_time_iso_8601": "2024-11-16T00:24:40.011070Z",
"url": "https://files.pythonhosted.org/packages/b0/77/b452bad5a614d00d11c2d7d3dba979de82bba18690e654a3db3e50815dcf/grpcio_csm_observability-1.68.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-16 00:24:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grpc",
"github_project": "grpc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "grpcio-csm-observability"
}
JSON
