ledatelescope / bifrost

A stream processing framework for high-throughput applications.
BSD 3-Clause "New" or "Revised" License
66 stars 29 forks source link

Lightweight Telemetry #152

Closed jaycedowell closed 2 years ago

jaycedowell commented 3 years ago

This PR adds a lightweight telemetry client to Bifrost to help provide insight into the users and usage of the Python portions of the library. This includes the ability to:

All of this can be toggled on/off using either functions in the bifrost.telemetry module or with the bifrost_telemetry.py script in tools.

codecov-commenter commented 3 years ago

Codecov Report

Merging #152 (10c0c7e) into master (a531545) will decrease coverage by 0.18%. The diff coverage is 57.89%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #152      +/-   ##
==========================================
- Coverage   61.51%   61.32%   -0.19%     
==========================================
  Files          64       65       +1     
  Lines        5264     5549     +285     
==========================================
+ Hits         3238     3403     +165     
- Misses       2026     2146     +120     
Impacted Files Coverage Δ
python/bifrost/GPUArray.py 0.00% <0.00%> (ø)
python/bifrost/blocks/audio.py 11.53% <0.00%> (-0.97%) :arrow_down:
python/bifrost/blocks/psrdada.py 4.34% <0.00%> (-0.10%) :arrow_down:
python/bifrost/header_standard.py 0.00% <0.00%> (ø)
python/bifrost/psrdada.py 1.63% <0.00%> (-0.02%) :arrow_down:
python/bifrost/udp_capture.py 0.00% <0.00%> (ø)
python/bifrost/udp_transmit.py 0.00% <0.00%> (ø)
python/bifrost/telemetry.py 34.96% <34.96%> (ø)
python/bifrost/DataType.py 65.67% <100.00%> (+0.52%) :arrow_up:
python/bifrost/Space.py 65.00% <100.00%> (+3.88%) :arrow_up:
... and 52 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update a531545...10c0c7e. Read the comment docs.

coveralls commented 3 years ago

Coverage Status

Coverage decreased (-0.2%) to 61.364% when pulling 10c0c7eac54487c5a0b62ff03697b7ef5d2e3b2a on telemetry into a53154552e2cf52ea8746f9c49f1f729973850bc on master.