{"id":13937712,"url":"https://github.com/cyberdelia/metrology","last_synced_at":"2025-04-05T01:06:16.221Z","repository":{"id":2732175,"uuid":"3727523","full_name":"cyberdelia/metrology","owner":"cyberdelia","description":"A library to easily measure what's going on in your python.","archived":false,"fork":false,"pushed_at":"2020-08-10T21:03:37.000Z","size":168,"stargazers_count":305,"open_issues_count":8,"forks_count":23,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-29T00:11:11.805Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://metrology.readthedocs.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cyberdelia.png","metadata":{"files":{"readme":"README.rst","changelog":"ChangeLog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-15T11:23:12.000Z","updated_at":"2025-03-04T11:19:34.000Z","dependencies_parsed_at":"2022-09-05T23:51:43.668Z","dependency_job_id":null,"html_url":"https://github.com/cyberdelia/metrology","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberdelia%2Fmetrology","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberdelia%2Fmetrology/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberdelia%2Fmetrology/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cyberdelia%2Fmetrology/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cyberdelia","download_url":"https://codeload.github.com/cyberdelia/metrology/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271528,"owners_count":20911587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-07T23:03:48.195Z","updated_at":"2025-04-05T01:06:16.199Z","avatar_url":"https://github.com/cyberdelia.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"=========\nMetrology\n=========\n\nA library to easily measure what's going on in your python.\n\nMetrology 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.\n\nInstalling\n==========\n\nTo install : ::\n\n    pip install metrology\n\nAPI\n===\n\nGauge\n-----\n\nA gauge is an instantaneous measurement of a value\n\n.. code-block:: python\n\n    class JobGauge(metrology.instruments.Gauge):\n        def value(self):\n            return len(queue)\n    gauge = Metrology.gauge('pending-jobs', JobGauge())\n\n\nCounters\n--------\n\nA counter is like a gauge, but you can increment or decrement its value\n\n.. code-block:: python\n\n    counter = Metrology.counter('pending-jobs')\n    counter.increment()\n    counter.decrement()\n    counter.count\n\nMeters\n------\n\nA meter measures the rate of events over time (e.g., \"requests per second\").\nIn addition to the mean rate, you can also track 1, 5 and 15 minutes moving averages\n\n.. code-block:: python\n\n    meter = Metrology.meter('requests')\n    meter.mark()\n    meter.count\n\nor as a decorator:\n\n.. code-block:: python\n\n    @Metrology.meter('requests')\n    def do_this_again():\n        # do something\n\nor with context manager:\n\n.. code-block:: python\n\n    with Metrology.meter('requests'):\n        # do something\n\nTimers\n------\n\nA timer measures both the rate that a particular piece of code is called and the distribution of its duration\n\n.. code-block:: python\n\n    timer = Metrology.timer('responses')\n    with timer:\n        do_something()\n\nor as a decorator:\n\n.. code-block:: python\n\n    @Metrology.timer('responses')\n    def response():\n        # do_something\n\n\nUtilization Timer\n-----------------\n\nA specialized timer that calculates the percentage of wall-clock time that was spent\n\n.. code-block:: python\n\n    utimer = Metrology.utilization_timer('responses')\n    with utimer:\n      do_something()\n\nTagging metrics\n---------------\n\nAll metrics can be tagged if the reporter supports it (currently: Graphite, Librato, Logger. The StatsD reporter supports the Datadog tag format because no official tag standard has been devised by the project).\nTags can be arbitrary key-value pairs. Just assign a dict as metric name. A 'name'-entry is required.\n\n.. code-block:: python\n\n    counter = Metrology.counter({\n      'name': 'pending-jobs',\n      'host': 'backend',\n      'priority': 'high'\n    })\n    counter.increment()\n    counter.decrement()\n    counter.count\n\nAll metric types support tagging.\n\nReporters\n=========\n\nLogger Reporter\n---------------\n\nA logging reporter that write metrics to a logger\n\n.. code-block:: python\n\n    reporter = LoggerReporter(level=logging.INFO, interval=10)\n    reporter.start()\n\n\nGraphite Reporter\n-----------------\n\nA graphite reporter that send metrics to graphite\n\n.. code-block:: python\n\n    reporter = GraphiteReporter('graphite.local', 2003)\n    reporter.start()\n\n\nLibrato Reporter\n----------------\n\nA librator metric reporter that send metrics to librato API\n\n.. code-block:: python\n\n    reporter = LibratoReporter(\"\u003cemail\u003e\", \"\u003ctoken\u003e\")\n    reporter.start()\n\n\nGanglia Reporter\n----------------\n\nA ganglia reporter that sends metrics to gmond.\n\n.. code-block:: python\n\n    reporter = GangliaReporter(\"Group Name\", \"localhost\", 8649, \"udp\", interval=60)\n    reporter.start()\n\nStatsD Reporter\n----------------\n\nA statsd reporter that sends metrics to statsd daemon.\n\n.. code-block:: python\n\n    reporter = StatsDReporter('localhost', 3333, conn_type='tcp')\n    reporter.start()\n\nor use default UDP setting:\n\n.. code-block:: python\n\n    reporter = StatsDReporter('localhost', 3333)\n    reporter.start()\n\n\nAcknowledgement\n===============\n\nThis is heavily inspired by the awesome `metrics \u003chttps://github.com/codahale/metrics\u003e`_ library.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberdelia%2Fmetrology","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcyberdelia%2Fmetrology","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcyberdelia%2Fmetrology/lists"}