用python实现的mackerel客户端。
mackerel.clienthde的Python项目详细描述
clienthde是一个访问mackerel(https://mackerel.io/)的python库。
这个项目是从heavenshell/py-mackerel-client派生的,最初是从mackerel-client-ruby移植的。
安装
$ pip install mackerel.clienthde
依赖性
用法
获取主机
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')hosts=client.get_hosts()
获得主机
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')host=client.get_host('<hostId>')
更新主机状态
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')# Poweroff.self.client.update_host_status('<hostId>','poweroff')# Standby.self.client.update_host_status('<hostId>','standby')# Working.self.client.update_host_status('<hostId>','working')# Maintenance.self.client.update_host_status('<hostId>','maintenance')
退出主机
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')self.client.retire_host('<hostId>')
获取最新指标
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')# Get hostId A's and hostId B's loadavg5, memory.free value.metrics=self.client.get_latest_metrics(['<hostId A>','<hostId B>'],['loadavg5','memory.free'])
后指标
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key>')metrics=[{'hostId':'<hostId>','name':'custom.metrics.loadavg','time':1401537844,'value':1.4},{'hostId':'<hostId>','name':'custom.metrics.uptime','time':1401537844,'value':500}]# Post `custom.metrics.loadavg` and `custom.metrics.uptime` to `hostId`.client.post_metrics(metrics)
服务后指标
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key>')metrics=[{'name':'custom.metrics.latency','time':1401537844,'value':0.5},{'name':'custom.metrics.uptime','time':1401537844,'value':500}]# Post 'custom.metrics.latency' and 'custom.metrics.uptime' to `service_name`.self.client.post_service_metrics('service_name',metrics)
获取监视器[此分叉版本中的新功能]
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')monitors=client.get_monitors()# list all Monitors# Specify list of ids to search, return a dict with id as keymonitor_targets=client.get_monitors(ids=['1ABCDabcde1'])
创建监视器[在此分叉版本中新建]
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')# Create monitor as specified in https://mackerel.io/api-docs/entry/monitors#createparams={'type':'service','name':'ConsumedReadCapacityUnits.table-name','service':'HDE','duration':1,'metric':'ConsumedReadCapacityUnits.table-name','operator':'>','warning':700,'critical':900}# Post params to Mackerel# result['id'] will give Monitor id if create operation succeededresult=client.create_monitor(params)
更新监视器[此分叉版本中的新功能]
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')# Since update Monitor requires all fields to be specified,# it is suggested to retrieve the latest value firstmonitor_id='1ABCDabcde1'monitors=client.get_monitors(ids=[monitor_id])monitor=monitors[monitor_id]# In this example, we assume Monitor is class of MonitorServicemonitor.warning=800monitor.critical=1000# Update params to Mackerelresult=client.update_monitor(monitor_id=monitor_id,monitor_params=monitor._to_post_params_dict())
删除监视器[在此分叉版本中新增]
frommackerel.clienthdeimportClient# Alternatively, you can set MACKEREL_APIKEY as environment variable# And simply call "client = Client()"client=Client(mackerel_api_key='<Put your API key')# Delete Monitorresult=client.delete_monitor(monitor_id='1ABCDabcde1')
cli
从主机名或服务、角色获取主机信息。
$ mkr.py info [--name foo][--service service][--role role]
设置主机的状态。
$ mkr.py status --host-id foo --status working
使主机退役。
$ mkr.py retire --host-id foo
获取主机的状态。
$ mkr.py status --host-id foo
身份验证
$ exportMACKEREL_APIKEY=foobar