Skip to main content

A library to easily measure what's going on in your python.

Project description

A library to easily measure what’s going on in your python.

Metrology allows you to add instruments to your python code and hook them to external reporting tools like Graphite so as to better understand what’s going on in your running python program.

Installing

To install :

pip install metrology

API

Gauge

A gauge is an instantaneous measurement of a value

class JobGauge(metrology.instruments.Gauge):
    def value(self):
        return len(queue)
gauge = Metrology.gauge('pending-jobs', JobGauge())

Counters

A counter is like a gauge, but you can increment or decrement its value

counter = Metrology.counter('pending-jobs')
counter.increment()
counter.decrement()
counter.count

Meters

A meter measures the rate of events over time (e.g., “requests per second”). In addition to the mean rate, you can also track 1, 5 and 15 minutes moving averages

meter = Metrology.meter('requests')
meter.mark()
meter.count

or as a decorator:

@Metrology.meter('requests')
def do_this_again():
    # do something

or with context manager:

with Metrology.meter('requests'):
    # do something

Timers

A timer measures both the rate that a particular piece of code is called and the distribution of its duration

timer = Metrology.timer('responses')
with timer:
    do_something()

or as a decorator:

@Metrology.timer('responses')
def response():
    # do_something

Utilization Timer

A specialized timer that calculates the percentage of wall-clock time that was spent

utimer = Metrology.utilization_timer('responses')
with utimer:
  do_something()

Reporters

Logger Reporter

A logging reporter that write metrics to a logger

reporter = LoggerReporter(level=logging.INFO, interval=10)
reporter.start()

Graphite Reporter

A graphite reporter that send metrics to graphite

reporter = GraphiteReporter('graphite.local', 2003)
reporter.start()

Librato Reporter

A librator metric reporter that send metrics to librato API

reporter = LibratoReporter("<email>", "<token>")
reporter.start()

Ganglia Reporter

A ganglia reporter that sends metrics to gmond.

reporter = GangliaReporter("Group Name", "localhost", 8649, "udp", interval=60)
reporter.start()

Acknowledgement

This is heavily inspired by the awesome metrics library.

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

metrology-1.1.0.tar.gz (19.2 kB view details)

Uploaded Source

Built Distribution

metrology-1.1.0-py2.py3-none-any.whl (22.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file metrology-1.1.0.tar.gz.

File metadata

  • Download URL: metrology-1.1.0.tar.gz
  • Upload date:
  • Size: 19.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for metrology-1.1.0.tar.gz
Algorithm Hash digest
SHA256 1a4f471bdd58813651622b46d18bc55b59fcdff4c6df7fe91d890a58762490b2
MD5 27f1ac2048f90df2e9a187147d7ed357
BLAKE2b-256 ffaa518f9519b3495ffde2684fc963813218f65a8d5ac75f6160a46d37a034c5

See more details on using hashes here.

File details

Details for the file metrology-1.1.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for metrology-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9cf5e45a1fd868721260c3d3ad2fc390a63d10d7556a49d1ceb4c500dba976bd
MD5 15245a5b79cb1707fed4e3cf8c915388
BLAKE2b-256 fb7dd4b9fc838e5e9afaa921703853dc8a8434edce243ff799f233921b8a1d6d

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