Skip to main content

Python library to interact transparently with Prometheus, Pushgateway and Dogstatsd.

Project description

snyk-python-metrics

Python library to interact transparently with Prometheus, Pushgateway and Dogstatsd.

Usage

The client can be used with two different approaches, one more opinionated and structured, with all the metrics created and registered at the creation of the client, and one more flexible, where metrics can be registered at any time.

The first approach should help keeping the application using this client cleaner and the metrics management in a centralised place.

Example 1 - "Locked Registry"

In this example all the metrics used by the application are registered as part of the client initialisation.

Example:

# my_app/settings.py
from snyk_metrics import initialise, Counter

counter_1 = Counter(
    name="my_app_counter",
    documentation="Simple example counter",
    label_names=None,
)
counter_2 = Counter(
    name="my_app_requests",
    documentation="Requests per endpoint and method",
    label_names=("endpoint", "method"),
)

metrics = [counter_1, counter_2]

initialise(metrics=metrics, prometheus_enabled=True)
# my_app/api/endpoints.py
from my_app.metrics import counter_1, counter_2


def my_function():
    counter_1.increment()


def foo_get_endpoint():
    counter_2.increment()

Example 2 - "Unstructured flexibility"

In this example metrics are created and used within the same file. It could make it harder to keep track of all the metrics in the application, but it can also help in keeping them closer to the part of the project where the metrics are used.

# my_app/settings.py
from snyk_metrics import initialise

initialise(prometheus_enabled=True, lock_registry=False)
# my_app/api/endpoints.py
from snyk_metrics import Counter

counter_1 = Counter(
    name="my_app_counter",
    documentation="Simple example counter",
    label_names=None,
)
counter_2 = Counter(
    name="my_app_requests",
    documentation="Requests per endpoint and method",
    label_names=("endpoint", "method"),
)


def my_function():
    counter_1.increment()


def foo_get_endpoint():
    counter_2.increment()

Project details


Download files

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

Source Distribution

snyk_metrics-0.0.6.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

snyk_metrics-0.0.6-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file snyk_metrics-0.0.6.tar.gz.

File metadata

  • Download URL: snyk_metrics-0.0.6.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.14 Linux/5.15.0-1056-aws

File hashes

Hashes for snyk_metrics-0.0.6.tar.gz
Algorithm Hash digest
SHA256 5d9d4829d388c33bd917d8815e39e9f869e0e096237a557996d2d41fd04ef0be
MD5 bd8de139d0f55c119d7987da04d403fa
BLAKE2b-256 6e35b0cfa68456741f87056828682cfb5c01474980fd4bbe8a8f8bdf57a8fe02

See more details on using hashes here.

File details

Details for the file snyk_metrics-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: snyk_metrics-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.14 Linux/5.15.0-1056-aws

File hashes

Hashes for snyk_metrics-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 92e36f8154587ed8932dd5df3495f217eda998631ef06ece51a84c678e321f75
MD5 1e0c240680d35008c98f0ae597de140a
BLAKE2b-256 059e209a9770214a9f23b609c708817896f61938db6ab50f37149090ec2d89b7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page