{"id":21013399,"url":"https://github.com/heavenshell/py-mackerel-client","last_synced_at":"2025-05-15T04:34:16.862Z","repository":{"id":27971454,"uuid":"31464674","full_name":"heavenshell/py-mackerel-client","owner":"heavenshell","description":"Mackerel client implemented by Python.","archived":false,"fork":false,"pushed_at":"2023-05-23T03:30:13.000Z","size":77,"stargazers_count":8,"open_issues_count":4,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T22:47:23.542Z","etag":null,"topics":["mackerel","mackerel-client","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heavenshell.png","metadata":{"files":{"readme":"README.rst","changelog":null,"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":"2015-02-28T14:20:14.000Z","updated_at":"2022-04-02T08:12:27.000Z","dependencies_parsed_at":"2022-08-26T11:01:46.472Z","dependency_job_id":null,"html_url":"https://github.com/heavenshell/py-mackerel-client","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavenshell%2Fpy-mackerel-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavenshell%2Fpy-mackerel-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavenshell%2Fpy-mackerel-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heavenshell%2Fpy-mackerel-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heavenshell","download_url":"https://codeload.github.com/heavenshell/py-mackerel-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225328906,"owners_count":17457324,"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":["mackerel","mackerel-client","python"],"created_at":"2024-11-19T09:42:12.845Z","updated_at":"2024-11-19T09:42:14.391Z","avatar_url":"https://github.com/heavenshell.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"mackerel.client\n===============\n.. image:: https://travis-ci.org/heavenshell/py-mackerel-client.svg?branch=master\n    :target: https://travis-ci.org/heavenshell/py-mackerel-client\n\nmackerel.client is a python library to access Mackerel (https://mackerel.io/).\n\nThis client is Ported from `mackerel-client-ruby \u003chttps://github.com/mackerelio/mackerel-client-ruby\u003e`_.\n\nInstall\n-------\n\n.. code:: shell\n\n  $ pip install mackerel.client\n\n\nDependency\n----------\n\nmackerel.client use `requests \u003chttp://docs.python-requests.org/en/latest/\u003e`_, `simplejson \u003chttps://github.com/simplejson/simplejson\u003e`_ and `click \u003chttp://click.pocoo.org/3/\u003e`_.\n\nUsage\n-----\nGet hosts\n~~~~~~~~~\n\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key')\n  host = client.get_hosts()\n\n\nGet host\n~~~~~~~~\n\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key')\n  host = client.get_host('\u003chostId\u003e')\n\n\nUpdate host status\n~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key')\n  # Poweroff.\n  self.client.update_host_status('\u003chostId\u003e', 'poweroff')\n  # Standby.\n  self.client.update_host_status('\u003chostId\u003e', 'standby')\n  # Working.\n  self.client.update_host_status('\u003chostId\u003e', 'working')\n  # Maintenance.\n  self.client.update_host_status('\u003chostId\u003e', 'maintenance')\n\nRetire host\n~~~~~~~~~~~\n\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key')\n  self.client.retire_host('\u003chostId\u003e')\n\n\nGet latest metrics\n~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key')\n  # Get hostId A's and hostId B's loadavg5, memory.free value.\n  metrics = self.client.get_latest_metrics(['\u003chostId A\u003e', '\u003chostId B\u003e'],\n                                           ['loadavg5', 'memory.free'])\n\n\n\nPost metrics\n~~~~~~~~~~~~\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key\u003e')\n  metrics = [\n      {\n          'hostId': '\u003chostId\u003e', 'name': 'custom.metrics.loadavg',\n          'time': 1401537844, 'value': 1.4\n      },\n      {\n          'hostId': '\u003chostId\u003e', 'name': 'custom.metrics.uptime',\n          'time': 1401537844, 'value': 500\n      }\n\n  ]\n  # Post `custom.metrics.loadavg` and `custom.metrics.uptime` to `hostId`.\n  client.post_metrics(metrics)\n\n\nPost service metrics\n~~~~~~~~~~~~~~~~~~~~\n.. code:: python\n\n  from mackerel.client import Client\n\n  client = Client(mackerel_api_key='\u003cPut your API key\u003e')\n  metrics = [\n      {\n          'name': 'custom.metrics.latency',\n          'time': 1401537844, 'value': 0.5\n      },\n      {\n          'name': 'custom.metrics.uptime',\n          'time': 1401537844, 'value': 500\n      }\n  ]\n  # Post 'custom.metrics.latency' and 'custom.metrics.uptime' to `service_name`.\n  self.client.post_service_metrics('service_name', metrics)\n\n\nCLI\n---\n\nGet host(s) information from hostname or service, role.\n\n.. code:: shell\n\n  $ mkr.py info [--name foo] [--service service] [--role role]\n\nSet status of a host.\n\n.. code:: shell\n\n  $ mkr.py status --host-id foo --status working\n\nRetire a host.\n\n.. code:: shell\n\n  $ mkr.py retire --host-id foo\n\nGet status of a host.\n\n.. code:: shell\n\n  $ mkr.py status --host-id foo\n\nAuthentication\n--------------\n\n.. code:: shell\n\n  $ export MACKEREL_APIKEY=foobar\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheavenshell%2Fpy-mackerel-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheavenshell%2Fpy-mackerel-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheavenshell%2Fpy-mackerel-client/lists"}