{"id":13936784,"url":"https://github.com/benhoyt/graphyte","last_synced_at":"2025-04-07T11:04:57.672Z","repository":{"id":46811823,"uuid":"63971454","full_name":"benhoyt/graphyte","owner":"benhoyt","description":"Python 3 compatible library to send data to a Graphite metrics server (Carbon)","archived":false,"fork":false,"pushed_at":"2022-01-23T21:43:35.000Z","size":60,"stargazers_count":81,"open_issues_count":1,"forks_count":18,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-31T09:06:42.543Z","etag":null,"topics":["async","carbon","graphite","metrics","python"],"latest_commit_sha":null,"homepage":"","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/benhoyt.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-22T17:32:12.000Z","updated_at":"2024-03-07T09:22:42.000Z","dependencies_parsed_at":"2022-09-26T21:31:46.255Z","dependency_job_id":null,"html_url":"https://github.com/benhoyt/graphyte","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoyt%2Fgraphyte","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoyt%2Fgraphyte/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoyt%2Fgraphyte/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/benhoyt%2Fgraphyte/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/benhoyt","download_url":"https://codeload.github.com/benhoyt/graphyte/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247640462,"owners_count":20971557,"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":["async","carbon","graphite","metrics","python"],"created_at":"2024-08-07T23:02:59.537Z","updated_at":"2025-04-07T11:04:57.647Z","avatar_url":"https://github.com/benhoyt.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"graphyte\n========\n\n.. image:: https://img.shields.io/pypi/v/graphyte.svg\n   :target: https://pypi.org/project/graphyte/\n   :alt: graphyte on PyPI (Python Package Index)\n\n.. image:: https://github.com/benhoyt/graphyte/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/benhoyt/graphyte/actions/workflows/tests.yml\n   :alt: GitHub Actions Tests\n\n\ngraphyte is a small Python library that sends data to a Graphite metrics\nserver (Carbon). We wrote it because the existing `graphitesend`_ library\ndidn’t support Python 3, and it also required gevent for asyncronous use.\ngraphyte is tested on Python 3.5+ as well as Python 2.7, and uses the\nstandard library’s ``threading`` module for asynchronous use.\n\nThe library is `on the Python Package Index (PyPI)`_, so to install it, fire up\na command prompt, activate your virtualenv if you’re using one, and type:\n\n::\n\n    pip install graphyte\n\nUsing graphyte is simple – just call ``init()`` to initialize the default\nsender and then ``send()`` to send a message. For example, to send\n``system.sync.foo.bar 42 {timestamp}\\n`` to graphite.example.com:2003\nsynchronously:\n\n.. code:: python\n\n    import graphyte\n    graphyte.init('graphite.example.com', prefix='system.sync')\n    graphyte.send('foo.bar', 42)\n\nIf you want to send asynchronously on a background thread (for example, in a\nweb server context), just specify a send interval. For example, this will\nsetup a background thread to send every 10 seconds:\n\n.. code:: python\n\n    graphyte.init('graphite.example.com', prefix='system.async', interval=10)\n    graphyte.send('foo.bar', 42)\n\nIf you want to send tagged metrics, the usage is as follows:\n\n.. code:: python\n\n    graphite.send('foo.bar', 42, tags={'ding': 'dong'})\n\nFor more advanced usage, for example if you want to send to multiple servers\nor if you want to subclass ``Sender``, you can instantiate instances of\n``Sender`` directly. For example, to instantiate two senders sending to\ndifferent   servers (one synchronous, one using a background thread with send\ninterval 10   seconds), use something like the following:\n\n.. code:: python\n\n    sender1 = graphyte.Sender('graphite1.example.com', prefix='system.one')\n    sender2 = graphyte.Sender('graphite2.example.com', prefix='system.two', interval=10)\n    sender1.send('foo.bar1', 42)\n    sender2.send('foo.bar2', 43)\n\nIf you want to send via UDP instead of TCP, just add   ``protocol='udp'`` to\nthe ``init()`` or ``Sender()`` call.\n\nOr, to customize how messages are logged or sent to the socket, subclass\n``Sender`` and override ``send_message`` (or even ``send_socket`` if you\nwant to override logging and exception handling):\n\n.. code:: python\n\n    class CustomSender(graphyte.Sender):\n        def send_message(self, message):\n            print('Sending bytes in some custom way: {!r}'.format(message))\n\nBy default, exceptions that occur when sending a message are logged. If you\nwant to raise and propagate exceptions instead, instantiate ``Sender`` with\n``raise_send_errors=True``. It's an error to set ``raise_send_errors`` when\n``interval`` is specified.\n\nSocket sending errors are logged using the Python logging system (using\nlogger name “graphyte”). If the sender is initialized with\n``log_sends=True``, all sends are logged at the INFO level.\n\nYou can also use graphyte to send metrics directly from the command line:\n\n::\n\n    python -m graphyte foo.bar 42\n\nThere are command line arguments to specify the server and port and other\nconfiguration. Type ``python -m graphyte --help`` for help.\n\nRead the code in `graphyte.py`_ for more details – it’s pretty small!\n\ngraphyte was written by `Ben Hoyt`_ and is licensed with a\npermissive MIT license (see `LICENSE.txt`_).\n\n**Related work:** `delphid`_ has a fork of graphyte which supports the statsd\nprotocol. See the changes on `delphid's branch`_.\n\n\n.. _graphitesend: https://github.com/daniellawrence/graphitesend\n.. _on the Python Package Index (PyPI): https://pypi.python.org/pypi/graphyte\n.. _graphyte.py: https://github.com/benhoyt/graphyte/blob/master/graphyte.py\n.. _Ben Hoyt: http://benhoyt.com/\n.. _LICENSE.txt: https://github.com/benhoyt/graphyte/blob/master/LICENSE.txt\n.. _delphid: https://github.com/delphid\n.. _delphid's branch: https://github.com/benhoyt/graphyte/compare/master...delphid:statsd_message_style?expand=1\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenhoyt%2Fgraphyte","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbenhoyt%2Fgraphyte","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbenhoyt%2Fgraphyte/lists"}