grpcio-observability

gRPC Python observability package

These details have not been verified by PyPI

Project links

Project description

Package for gRPC Python Observability.

More details can be found in OpenTelemetry Metrics gRFC.

How gRPC Python Observability Works

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

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.

Installation

Currently gRPC Python Observability is only available for Linux.

Installing From PyPI

$ pip install grpcio-observability

Installing From Source

Building from source requires that you have the Python headers (usually a package named python-dev) and Cython installed. It further requires a GCC-like compiler to go smoothly; you can probably get it to work without GCC-like stuff, but you may end up having a bad time.

$ 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_observability
$ python -m make_grpcio_observability

# For the next command do `sudo pip install` if you get permission-denied errors
$ GRPC_PYTHON_BUILD_WITH_CYTHON=1 pip install .

Dependencies

gRPC Python Observability Depends on the following packages:

grpcio
opentelemetry-api

Usage

You can find example usage in Python example folder.

We also provide several environment variables to help you optimize gRPC python observability for your particular use.

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

Project details

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

1.68.0

Nov 16, 2024

1.68.0rc1 pre-release

Oct 31, 2024

1.67.1

Oct 29, 2024

1.67.0

Oct 16, 2024

1.67.0rc1 pre-release

Sep 20, 2024

1.66.2

Sep 28, 2024

1.66.1

Aug 28, 2024

1.66.0

Aug 22, 2024

1.66.0rc5 pre-release

Aug 16, 2024

1.66.0rc3 pre-release

Aug 8, 2024

1.66.0rc2 pre-release

Aug 2, 2024

1.66.0rc1 pre-release

Aug 2, 2024

1.65.5

Aug 17, 2024

1.65.4

Aug 2, 2024

1.65.2

Jul 31, 2024

1.65.1

Jul 18, 2024

1.65.0 yanked

Jul 11, 2024

Reason this release was yanked:

https://github.com/grpc/grpc/issues/37178

1.65.0rc2 pre-release

Jun 27, 2024

1.65.0rc1 pre-release

Jun 18, 2024

1.64.3

Aug 6, 2024

1.64.1

Jun 3, 2024

1.64.0

May 20, 2024

1.64.0rc1 pre-release

May 8, 2024

1.63.2

Aug 6, 2024

1.63.0

Apr 30, 2024

1.63.0rc2 pre-release

Apr 19, 2024

1.63.0rc1 pre-release

Apr 15, 2024

1.62.3

Aug 6, 2024

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

grpcio_observability-1.68.0.tar.gz (5.5 MB view details)

Uploaded Nov 16, 2024 Source

Built Distributions

grpcio_observability-1.68.0-cp313-cp313-musllinux_1_1_x86_64.whl (633.2 kB view details)

Uploaded Nov 16, 2024 CPython 3.13 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp313-cp313-musllinux_1_1_i686.whl (702.7 kB view details)

Uploaded Nov 16, 2024 CPython 3.13 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (314.1 kB view details)

Uploaded Nov 16, 2024 CPython 3.13 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl (350.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.13 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp313-cp313-manylinux_2_17_aarch64.whl (277.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.13 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp313-cp313-linux_armv7l.whl (299.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.13

grpcio_observability-1.68.0-cp312-cp312-musllinux_1_1_x86_64.whl (632.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.12 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp312-cp312-musllinux_1_1_i686.whl (701.8 kB view details)

Uploaded Nov 16, 2024 CPython 3.12 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (313.6 kB view details)

Uploaded Nov 16, 2024 CPython 3.12 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl (350.2 kB view details)

Uploaded Nov 16, 2024 CPython 3.12 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp312-cp312-manylinux_2_17_aarch64.whl (277.3 kB view details)

Uploaded Nov 16, 2024 CPython 3.12 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp312-cp312-linux_armv7l.whl (299.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.12

grpcio_observability-1.68.0-cp311-cp311-musllinux_1_1_x86_64.whl (639.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.11 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp311-cp311-musllinux_1_1_i686.whl (708.9 kB view details)

Uploaded Nov 16, 2024 CPython 3.11 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (320.2 kB view details)

Uploaded Nov 16, 2024 CPython 3.11 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (356.9 kB view details)

Uploaded Nov 16, 2024 CPython 3.11 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp311-cp311-manylinux_2_17_aarch64.whl (284.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.11 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp311-cp311-linux_armv7l.whl (308.6 kB view details)

Uploaded Nov 16, 2024 CPython 3.11

grpcio_observability-1.68.0-cp310-cp310-musllinux_1_1_x86_64.whl (639.0 kB view details)

Uploaded Nov 16, 2024 CPython 3.10 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp310-cp310-musllinux_1_1_i686.whl (708.9 kB view details)

Uploaded Nov 16, 2024 CPython 3.10 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (320.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.10 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (356.8 kB view details)

Uploaded Nov 16, 2024 CPython 3.10 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp310-cp310-manylinux_2_17_aarch64.whl (284.1 kB view details)

Uploaded Nov 16, 2024 CPython 3.10 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp310-cp310-linux_armv7l.whl (309.1 kB view details)

Uploaded Nov 16, 2024 CPython 3.10

grpcio_observability-1.68.0-cp39-cp39-musllinux_1_1_x86_64.whl (639.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.9 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp39-cp39-musllinux_1_1_i686.whl (709.9 kB view details)

Uploaded Nov 16, 2024 CPython 3.9 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (321.2 kB view details)

Uploaded Nov 16, 2024 CPython 3.9 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (357.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.9 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp39-cp39-manylinux_2_17_aarch64.whl (284.9 kB view details)

Uploaded Nov 16, 2024 CPython 3.9 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp39-cp39-linux_armv7l.whl (310.2 kB view details)

Uploaded Nov 16, 2024 CPython 3.9

grpcio_observability-1.68.0-cp38-cp38-musllinux_1_1_x86_64.whl (639.6 kB view details)

Uploaded Nov 16, 2024 CPython 3.8 musllinux: musl 1.1+ x86-64

grpcio_observability-1.68.0-cp38-cp38-musllinux_1_1_i686.whl (710.1 kB view details)

Uploaded Nov 16, 2024 CPython 3.8 musllinux: musl 1.1+ i686

grpcio_observability-1.68.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (321.4 kB view details)

Uploaded Nov 16, 2024 CPython 3.8 manylinux: glibc 2.17+ x86-64

grpcio_observability-1.68.0-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (358.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.8 manylinux: glibc 2.17+ i686

grpcio_observability-1.68.0-cp38-cp38-manylinux_2_17_aarch64.whl (285.3 kB view details)

Uploaded Nov 16, 2024 CPython 3.8 manylinux: glibc 2.17+ ARM64

grpcio_observability-1.68.0-cp38-cp38-linux_armv7l.whl (310.5 kB view details)

Uploaded Nov 16, 2024 CPython 3.8

File details

Details for the file grpcio_observability-1.68.0.tar.gz.

File metadata

Download URL: grpcio_observability-1.68.0.tar.gz
Upload date: Nov 16, 2024
Size: 5.5 MB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.11.9

File hashes

Hashes for grpcio_observability-1.68.0.tar.gz
Algorithm	Hash digest
SHA256	`2a35facdbdfa2f0c7d9985aaef4cbbf9b4539e8a40f2786989a39627428a7a6f`
MD5	`0dad1a8869eed30b61a1a11bdb866e48`
BLAKE2b-256	`c0d736aa8b9441e08fc0008f903e806396f26ef5fcdfcad65e45324048d89487`

Algorithm	Hash digest
SHA256	`903ae61f5d4c89ddbbdf0e2952c79d969ff09523407c371a65f364ae9fdcdb08`
MD5	`d52ff13540ebff95729b6fd44c2c7fc3`
BLAKE2b-256	`233a91a103662807526dad2073c22750d8e219c09b9b9764b4f3ac2b709d1081`

Algorithm	Hash digest
SHA256	`7e3346d59a6de00ed4df0e002b8e0aab30f048765b1096a22b914c40ae532384`
MD5	`0c7cb1fb42cdd597c6cba74aee205cf5`
BLAKE2b-256	`a0bf0ff403caa80326cf3a667365bec6626ed8389cb5c9b5931ea8bb698e4d7e`

Algorithm	Hash digest
SHA256	`a4b3b0ffe64b2741c63302c8f6800611dcf1cbe5f5cd69b4f539f54e6e4a9351`
MD5	`4e6736bbce00093e62798d8ff817e5eb`
BLAKE2b-256	`310d95f8a3d3d9008076ec5843b5b4d3c8fda9793f17c50100cf3ad56a667341`

Algorithm	Hash digest
SHA256	`24fba6cb5fe580ebc210c54206d8eed302147818cd809bfdf04aace0c394f33b`
MD5	`7ac6c7b9bb1d0a04991a47706ca68a9e`
BLAKE2b-256	`bd42951684928e48051b5413b22bbae1f50904a4bc8467b64005475a376f5b5f`

Algorithm	Hash digest
SHA256	`4cc9d49be278ba5b494f20065127743efa308a442932b9853ca6b2d84668e6e4`
MD5	`313a3f2bb8c3cba7b641ef1a5a2af8cd`
BLAKE2b-256	`a1d106754c8f503aec1c16a6f602c9b8c6fc682f2c065637326101badb0ac6f2`

Algorithm	Hash digest
SHA256	`e8576a16d28e5a2ae74565d273d01c9424e160fd9e5787e761a84cc1f326bc35`
MD5	`33eee966c975a03ee7922d9191736063`
BLAKE2b-256	`6bad7d35bffa603bda54dd6079f2b997f892b544b16adf4b6238857a5019facc`

Algorithm	Hash digest
SHA256	`8c3b615f9c4310c4b58754aa01ae12505629ea067e36656425c5b3cda53931ce`
MD5	`f04e6c4ccdb03fb97c8cdaa39afabf32`
BLAKE2b-256	`8107044393c36f5d22afbc64e8808dccf6e463de6b51d8cb01461e8c9b95c455`

Algorithm	Hash digest
SHA256	`20e690d679057a0f6dd8970c11731b5e1777804635abbb0ba8b1d47a25d26ab5`
MD5	`f2dbcff55fa6da4506eb20c4f23e1692`
BLAKE2b-256	`6f4b6f41d9f088bc907dea19125b2d9da81fae2ddba1c2715407409103145c19`

Algorithm	Hash digest
SHA256	`e4f2a029ff77e5086e3cacd267ee06dfaff5a327ea513b946c01c4db2895680d`
MD5	`b87a1619cdcc1c19b14008fba77b144f`
BLAKE2b-256	`da7e8e7e97cd295565d74d505a180fba7e9f2d48c5e84633c64040cb32627df0`

Algorithm	Hash digest
SHA256	`7c4e098a671fe3fcc65cce2e3810c42ac26021b7f8ca106d8f3ca5cceb21fc0c`
MD5	`4fc7889bdb5e8182a583410a0db597cf`
BLAKE2b-256	`cce71a1a648e27dee08647f64b9fbed3f8707abb149e51f594718219028b3d07`

Algorithm	Hash digest
SHA256	`ddb70e301a69a194d3c68354f77680a06dbf24d220af56e2e31e856df344794a`
MD5	`3a5093ae92804b9f00deb701e62dcb40`
BLAKE2b-256	`7da4cd5036bd1ea35f08b47a71cb42b2d9f233613ddcf4d767fc87959c88e3c1`

Algorithm	Hash digest
SHA256	`ebfe3baf276f6c6aa3c6853f0af826674dc75456e1613da7896e41941069c3fa`
MD5	`1fe347cfc723bfa9119ae33b136a110b`
BLAKE2b-256	`bec2b3423629315fee22ff11e432de734fbf070b92e551e881dc19ebc5a7d052`

Algorithm	Hash digest
SHA256	`fa8aeb0f84c59c940b381436f47245606f6e799083e3733b8a7df845606c4026`
MD5	`2799d0c6f468c037f9f21b880e33be10`
BLAKE2b-256	`9f4cd38fb44d872a8f7f0be1ad8c208f2aa664d3489801dedf7708def95107c7`

Algorithm	Hash digest
SHA256	`0e7419585acba585d988939dc0878703af7ec4e00f3831ebbecb30dc564775be`
MD5	`b6c8f91eb1c36418977392beabe529fd`
BLAKE2b-256	`1dc8a834abbbad6717ba8e0fed1f5b348344ea300fce4af655ce0d5b67315929`

Algorithm	Hash digest
SHA256	`330c1aefbab712b9b0d86bb083917197266dbc19f080cccfbac377939aa9017f`
MD5	`b95e092767cb2ee2a8cb5ee337959412`
BLAKE2b-256	`12ef44e82f479d80187af630fdecf9b72d28e84d2306010e124b4dac2f018eb6`

Algorithm	Hash digest
SHA256	`70eac85bd9dcadb3f791ae8dcbc153346496e12328e7f37e0950d8df768c229a`
MD5	`07365419c2abf78b0bdec3f99fbfdd57`
BLAKE2b-256	`40ef7862b34b96db115549f88fb567e5194b5345f840808bffadbdbfdac54861`

Algorithm	Hash digest
SHA256	`6da4a86d57bc7e667309333c9fe7455cb400b67cea959b57cab27b97b151b016`
MD5	`dab65118fc19f03add2931a8772d1be7`
BLAKE2b-256	`62d7751d208789791746dc1a82e6bcf60acdadb9fa44d1561b164b36c1615892`

Algorithm	Hash digest
SHA256	`5777a7671157a423d6722caf6ed35be5cc419469b1d866882e1ace2783b74a53`
MD5	`bce4c6aed5732b9ef296c2900054f503`
BLAKE2b-256	`6847e599fdfa81710c416b929aaab1d6a76181321a8ea0d338cf5e4ce2b333d1`

Algorithm	Hash digest
SHA256	`c2b63ee57c85eca1f6f1811c12e39afb207d5faf94a5c8480086d953e84ae154`
MD5	`61d20259ff226bb2505f48f91c10ac52`
BLAKE2b-256	`6ead80ee64477941cf37e745d77638756019839cc86c01d6a2328d2d758f8f21`

Algorithm	Hash digest
SHA256	`eed961256a4b0f7b1a74492401c010902d628dd05edc26a60371cd5efddbb043`
MD5	`30f28130195bd1043a3427a0c1a9534a`
BLAKE2b-256	`e193a549205bc0a91cb030217e20bed26a3e8014e84570873e539a17ae2f8ce8`

grpcio-observability 1.68.0

Navigation

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Project description

How gRPC Python Observability Works

Installation

Installing From PyPI

Installing From Source

Dependencies

Usage

Project details

Verified details

Maintainers

Unverified details

Project links

Meta

Classifiers

Release history Release notifications | RSS feed

Download files

Source Distribution

Built Distributions

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

File details

File metadata

File hashes

Algorithm	Hash digest
SHA256	`e729aae661c4d842e4b37dff6f28c8ae4e1d225ff98e70d27c29a7e73705e06c`
MD5	`09103464bdf197936895c7a64de5ca57`
BLAKE2b-256	`71418c88654a4f7aa279adb96e522a11d1862eb51faee33d7a869212ec585822`

Algorithm	Hash digest
SHA256	`57cdc986ba840bd48ad91f7172dddb55489ab262d407502beab18fa95cb714af`
MD5	`fb244469441c7ca5070228a319d516c3`
BLAKE2b-256	`b76268f044cc0b87a65bc1fb6a6f6729a251f16573334ada71ed45eebdfb04aa`

Algorithm	Hash digest
SHA256	`c316434cde74b82ef496aa1f16da28f4a44f39b27d8a764a9ccfc5761b56012f`
MD5	`e8bb6a0057788476e083204ff83bed9b`
BLAKE2b-256	`53ca02a15d005121d36bd78aca367d060c2f98c15864719222fd0696c1e5f333`

Algorithm	Hash digest
SHA256	`cdedff8e5c63cc0c9930d8fd1192967b3ef2610cc1dfe8ea21ee73fa7f3ee76e`
MD5	`1046e9279f3d0f511164ee75380c1ac0`
BLAKE2b-256	`1acb5adc606de48f3e2af0adbb4ec1f4d983a7c8cecee2d9e36508e252571a48`

Algorithm	Hash digest
SHA256	`074a31a4226829a9eaa0fd70722ff4b12899c770fdb521fe06f3e74e609f7cfe`
MD5	`bca996914673f57cf0b839b1df996d4d`
BLAKE2b-256	`b3dc51d1eaf98eb6a8f938a1b2d3faf16e1d872558436eae9dbc4be567bd6fba`

Algorithm	Hash digest
SHA256	`46ab6ac44afbd4c4f5e3028160b8aea7f36f832338e78966db65e3cc730759ce`
MD5	`3648832faad7abd6322d8452cd4e2606`
BLAKE2b-256	`24118c11d0c591bfae7ec9c43b3d3be615d7c3d2127a784777f38051c104efb7`

Algorithm	Hash digest
SHA256	`60e3afbd2d97f03e4a9656d177d1380644b1a15e48c9ef43e5098a1bf9e5f997`
MD5	`5881b71c69c89f8414e27ffef2a63500`
BLAKE2b-256	`a3c42cf7a7b9eb5014d520455820e429a35c2d18a8ddc0e8013de9b3f307b274`

Algorithm	Hash digest
SHA256	`51741d596fe90956b9c8546cc3fbb28c5d49f45e5f310a01a13c95275eab0536`
MD5	`86b2ccd17fd13ba3a906de32f855acd8`
BLAKE2b-256	`ca8064c4e9f82a69afbeb393f7d10c5c01ab048f6c17db3dd02fb7721e883d3b`

Algorithm	Hash digest
SHA256	`a1512c4c70dffad6f7b5bfea16561d78c2c50083703993795003dbe1f7a3445a`
MD5	`98fe5afecad936b1c3f552c0a00ffaf3`
BLAKE2b-256	`f70a8482293c67cd0016661fda91d556666afab5bd0e3ef88936b146020662bd`

Algorithm	Hash digest
SHA256	`40ba7bc2dabc9d85f16a06aa7a28763f6de0bb2375dc3a129ce196c294909021`
MD5	`cf2a3f45e86127e9125de648338a4e5a`
BLAKE2b-256	`5000b308af52a63e2cb0d94d1a9969dda5f291ec12e536132593077c86a96527`