跳转到主要内容

gRPC Python CSM 可观测性包

项目描述

gRPC Python CSM 可观测性包。

安装

目前 gRPC Python CSM 可观测性仅适用于 Linux。

从 PyPI 安装

$ pip install grpcio-csm-observability

从源安装

$ 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 .

依赖项

gRPC Python CSM 可观测性依赖于以下包

grpcio
grpcio-observability
opentelemetry-sdk

用法

示例用法与此处示例类似,而不是从 grpc_observability 导入,您应该从 grpc_csm_observability 导入。

import grpc_csm_observability

csm_otel_plugin = grpc_csm_observability.CsmOpenTelemetryPlugin(
    meter_provider=provider
)

我们还提供了一些环境变量,以帮助您针对特定用途优化 gRPC Python 可观测性。

  • 注意:此处“Census”一词仅出于历史向后兼容性原因,并不表示任何依赖。

  1. GRPC_PYTHON_CENSUS_EXPORT_BATCH_INTERVAL
    • 这控制了收集在 gRPC Core 中的遥测数据发送到 Python 层的频率。

    • 默认值为 0.5 (秒)。

  2. GRPC_PYTHON_CENSUS_MAX_EXPORT_BUFFER_SIZE
    • 这控制了在将数据发送到 Python 之前,可以在 gRPC Core 缓冲区中保留的最大遥测数据项数。

    • 默认值为 10,000。

  3. GRPC_PYTHON_CENSUS_EXPORT_THRESHOLD
    • 此设置作为触发器:当 gRPC Core 缓冲区达到其容量的某个百分比时,将发送遥测数据到 Python。

    • 默认值为 0.7 (这意味着缓冲区在 70% 填满时开始导出)。

  4. GRPC_PYTHON_CENSUS_EXPORT_THREAD_TIMEOUT
    • 这控制了导出线程(负责将数据发送到 Python)允许完成的最大时间。

    • 主线程将在超时后终止导出线程。

    • 默认值为 10 (秒)。

项目详情


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解有关安装包的更多信息。

源代码分发

grpcio_csm_observability-1.66.2.tar.gz (16.3 kB 查看哈希值)

上传时间 源代码

构建分发

grpcio_csm_observability-1.66.2-py3-none-any.whl (16.4 kB 查看哈希值)

上传时间 Python 3

由以下机构支持