pipeline-telemetry

Create and store data pipeline telemetry data

Free software: GNU Lesser General Public License v3 or later (LGPLv3+)

Installation

pip install pipeline-telemetry

You can also install the in-development version with:

pip install https://github.com/MaartendeRuyter/pipeline-telemetry/archive/master.zip

Documentation

https://pipeline-telemetry.readthedocs.io/

Development

To run all the tests run:

tox

Note, to combine the coverage data from all the tox environments run:

Windows	set PYTEST_ADDOPTS=--cov-append tox
Other	PYTEST_ADDOPTS=--cov-append tox

Changelog

0.0.1 (2021-10-06)

First release on PyPI.

0.0.4 (2021-10-31)

Seperated the storage module
Added MongoDb storage class
Started with documentation

0.1.0 (2021-11-05)

added Telemetry method add_telemetry_counter

Added TelemetryCounter class that can be used to make prefedined objects that can be added to the Telemetry instance with the add_telemetry_counter method. This will improve readibilty of your code:

from pipeline_telemetry import TelemetryCounter

YOUR_PREDFINED_COUNTER = (
    process_type=ProcessTypes.CREATE_DATA_FROM_API,
    sub_process='RETRIEVE_RAW_DATA',
    counter_name='my_custom_counter',
)

telemetry.add_telemetry_counter(YOUR_PREDFINED_COUNTER)

0.2.0 (2021-11-09)

added error field to TelemetryCounter so that default Errorcodes can be used in a TelemetryCounter instance to keep an error counter in the telemetry
Updated add_telemetry_counter so that it can handle TelemetryCounter instances with either an Errorcode of a custom counter. In case of ErrorCode the actual error_code will serve as the customer counter.

0.2.1 (2021-11-09)

added is_telemetry_counter method in helper module
moved add_telemetry decorator to helper module
both methods can be directly imported from pipeline_telemetry module

0.2.2 (2021-11-10)

added add_mongo_telemetry decorator that uses mongo storage class

0.2.3 (2021-11-10)

Added attribute process_types to TelemetryCounter dataclass next to existing process_type attribute. This allows you to choose between a list of process_types or just a single process_type to be in scope of the TelemetryCounter` instance

Release files for pipeline-telemetry 0.2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipeline-telemetry 0.2.3
File	Size	Uploaded
pipeline-telemetry-0.2.3.tar.gz	51.5 kB	Nov 10, 2021	Details

Built distribution (wheel)

Table of built distributions (wheels) for pipeline-telemetry 0.2.3
File	Interpreter	ABI	Platform	Reset
pipeline_telemetry-0.2.3-py2.py3-none-any.whl 36.0 kB Nov 10, 2021	Python 2, Python 3	none	any	Details

Total release size: 87.6 kB

Release files / pipeline-telemetry-0.2.3.tar.gz

Download URL	pipeline-telemetry-0.2.3.tar.gz
Size	51.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`db2235d070a4037c937a4f6b2cf4d2aba4c9efddb8557a5c5799db35e6dce9b6`
BLAKE2b-256 checksum How to use checksums	`e03b77956bdbce120f018129301a80374858753d61a80a2f586f57ebc44168b3`
Upload date	Nov 10, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2`

Release files / pipeline_telemetry-0.2.3-py2.py3-none-any.whl

Download URL	pipeline_telemetry-0.2.3-py2.py3-none-any.whl
Size	36.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`cb9a1c6b33d36ffff2eb9066c02d3b05034e7a738940b52222932ca751005f40`
BLAKE2b-256 checksum How to use checksums	`83c3ae7531d46503af278d7cd0de37cf000d165e1144834367da72906be6b492`
Upload date	Nov 10, 2021
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.2`