Skip to main content

py-vigil-reporter

codecov downloads

Vigil Reporter for Python. Used in pair with Vigil, the Microservices Status Page.

Who uses it?

Smartphoniker

How to install

Install with pip:

$ pip install py-vigil-reporter

How to use

vigil-reporter can be instantiated as such:

from vigil_reporter.reporter import VigilReporter

SAMPLE_CONFIG = {
    "url": "http://localhost:8080",
    "token": "REPLACE_THIS_WITH_A_SECRET_KEY",
    "probe_id": "stats",
    "node_id": "stats-node",
    "replica_id": "192.168.1.103",
    "interval": 5
}
reporter = VigilReporter.from_config(SAMPLE_CONFIG)
reporter.start_reporting()
print("You can continue with your normal work here!")

This module uses the threading.Timer class from the threading module to run reporting in background. This makes the method non-blocking.

NOTE: The threaded execution drifts about +/- 0.05 seconds. But this won't be an issue, as you should set an interval that is greater than 1.0 seconds.

For further details see this Stackoverflow post.

What is Vigil?

ℹ️ Wondering what Vigil is? Check out valeriansaliou/vigil.

Metadata

Release files for py-vigil-reporter 0.2.0

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

Source distribution (sdist)

Source distribution for py-vigil-reporter 0.2.0
File Size Uploaded Provenance
py-vigil-reporter-0.2.0.tar.gz 5.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for py-vigil-reporter 0.2.0
File Interpreter ABI Platform
py_vigil_reporter-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 13.1 kB

Release files / py-vigil-reporter-0.2.0.tar.gz

Download URL py-vigil-reporter-0.2.0.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1377d08f7a64ccd10b31c654af3f529eefbcd4068fcac02d35ac0ea24c81ca26
BLAKE2b-256 checksum
How to use checksums
5719451e6f7d4edb6f7fa939b7b502a9827273b4435b10678f3c5cf7a4412013
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

Release files / py_vigil_reporter-0.2.0-py3-none-any.whl

Download URL py_vigil_reporter-0.2.0-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce46e38e8c022ccb845a6e953242d15b9c5e7c0ac5e6f87ff9080c885f75c2da
BLAKE2b-256 checksum
How to use checksums
b31d3214cb5522e83943a3ce7a2285aec7f3e9a41bb1209c62d1930ef94f039b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.0

Security for py-vigil-reporter 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page