api

package
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 20, 2017 License: MPL-2.0 Imports: 15 Imported by: 1

README

pulse logo
Build Status

Pulse

Pulse is a stat collecting and publishing service. It serves historical stats over an http api while live stats are sent to mist for live updates.

API

Route Description Output
GET /keys Returns list of stats being recorded string array
GET /tags Returns list of filterable tags string array
GET /latest/{stat}* Returns latest stat (averages if multiple filters applied) json stat object
GET /hourly/{stat}** Returns hourly averages for stat json array of stat objects
GET /daily/{stat}** Returns average for stat at the same daily time string map

ALERTS (requires "kapacitor-address" to be configured)

Route Description Payload Output
POST /alerts Add a kapacitor alert json alert object json alert object
PUT /alerts Update a kapacitor alert json alert object json alert object
DELETE /alerts/{alert} Delete a kapacitor alert nil success message

*: reserved query parameters is 'verb', all others act as filters
**: reserved query parameters are 'backfill', 'verb', 'start', and 'stop', all others act as filters

note: The API requires a token to be passed for authentication by default and is configurable at server start (--token). The token is passed in as a custom header: X-AUTH-TOKEN.

Usage Example:

get latest 'cpu_used' for 'web1' service
$ curl http://localhost:8080/latest/cpu_used?service=web1
# {"time":0,"value":0.2207}
get latest max 'cpu_used' for 'web1', 'web2', and 'web3' services
$ curl "http://localhost:8080/latest/cpu_used?service=web1&service=web2&service=web3&verb=max"
# {"time":0,"value":0.262}
get hourly 'cpu_used' for 'web1' service
$ curl http://localhost:8080/hourly/cpu_used?service=web1
# [{"time":1465419600000,"value":0.22331906098017212}]
get hourly max 'cpu_used' for 'web1', 'web2', and 'web3' services
$ curl "http://localhost:8080/hourly/cpu_used?service=web1&service=web2&service=web3&verb=max"
# [{"time":1465419600000,"value":0.22331906098017212}]
get daily averages 'cpu_used' for 'web1' service
$ curl http://localhost:8080/daily/cpu_used?service=web1
# {"15:0":0.22501574074074077,"15:15":0.22325925160697888,"15:30":0.22123160173160175}
get daily max 'cpu_used' for 'web1', 'web2', and 'web3' services for the last 3 days
$ curl "http://localhost:8080/daily/cpu_used?service=web1&service=web2&service=web3&verb=max&start=3d"
# [{"time":1465419600000,"value":0.22331906098017212}]
get tags to filter by
$ curl -k -H "X-AUTH-TOKEN: secret" https://localhost:8080/tags
# ["host","service"]
get list of stats stored
$ curl http://localhost:8080/keys
# ["cpu_used","ram_used"]
add alert for cpu_used to trigger critical alert to localhost/alert if cpu_used is > 0.80 for 30s
$ curl http://localhost:8080/alerts -d '{
  "tags": {"host":"abcd"},
  "metric": "cpu_used",
  "level": "crit",
  "threshold": "0.80",
  "duration": "30s",
  "post": "http://127.0.0.1/alert"
}'
# {"id":"785ba395-f2a0-47b3-b1cf-ee788dd0d5c8","tags":{"host":"abcd"},"metric":"cpu_percent","level":"crit","threshold":"0.80","duration":"30s","post":"http://127.0.0.1/alert"}

Alert post body example:

{
 "id": "[do.1] cpu_percent",
 "message": "[do.1] cpu_percent is CRITICAL value:0.11818333333333335",
 "details": "{"Name":"cpu_percent","TaskName":"fe64d9d7-5b35-43f0-a57c-52a6ead3a361","Group":"nil","Tags":null,"ID":"[do.1] cpu_percent","Fields":{"mean_cpu_percent":0.11818333333333335},"Level":"CRITICAL","Time":"2017-04-14T20:12:03.972677173Z","Message":"[do.1] cpu_percent is CRITICAL value:0.11818333333333335"}\n",
 "time": "2017-04-14T20:12:03.972677173Z",
 "duration": 0,
 "level": "CRITICAL",
 "data": {
   "series": [
     {
       "name": "cpu_percent",
       "columns": [
         "time",
         "mean_cpu_percent"
       ],
       "values": [
         [
           "2017-04-14T20:12:03.972677173Z",
           0.11818333333333335
         ]
       ]
     }
   ]
 }
}
delete alert for cpu_used to trigger critical alert to localhost/alert if cpu_used is > 0.80 for 30s
$ curl http://localhost:8080/alerts/785ba395-f2a0-47b3-b1cf-ee788dd0d5c8 -X DELETE
# {"msg":"Success"}
get alerts
$ curl http://localhost:8080/alerts
# [{"link":{"rel":"self","href":"/kapacitor/v1/tasks/36f9aaa7-689d-47b0-a08f-f9f6575548ee"},"id":"36f9aaa7-689d-47b0-a08f-f9f6575548ee","template-id":"","type":"batch","dbrps":[{"db":"statistics","rp":"one_day"}],"script":"batch\n    |query('''\n\t\tSELECT mean(ram_percent) AS mean_ram_percent\n\t\tFROM \"statistics\".\"one_day\".\"ram_percent\"\n\t\tWHERE \"host\" = 'do.1'\n\t''')\n        .period(1s)\n        .every(30s)\n    |alert()\n        .id('[do.1] ram_percent')\n        .message('{{ .ID }} is {{ .Level }} value:{{ index .Fields \"mean_ram_percent\" }}')\n        .crit(lambda: \"mean_ram_percent\" \u003e 2)\n        .post('http://127.0.0.1/alert')\n        .stateChangesOnly()\n        .log('/tmp/alerts.log')\n","vars":null,"dot":"digraph 36f9aaa7-689d-47b0-a08f-f9f6575548ee {\ngraph [throughput=\"0.00 batches/s\"];\n\nquery1 [avg_exec_time_ns=\"6.243805ms\" batches_queried=\"0\" points_queried=\"0\" query_errors=\"0\" ];\nquery1 -\u003e alert2 [processed=\"0\"];\n\nalert2 [alerts_triggered=\"0\" avg_exec_time_ns=\"0s\" crits_triggered=\"0\" infos_triggered=\"0\" oks_triggered=\"0\" warns_triggered=\"0\" ];\n}","status":"enabled","executing":true,"error":"","stats":{"task-stats":{"throughput":0},"node-stats":{"alert2":{"alerts_triggered":0,"avg_exec_time_ns":0,"collected":0,"crits_triggered":0,"emitted":0,"infos_triggered":0,"oks_triggered":0,"warns_triggered":0},"batch0":{"avg_exec_time_ns":0,"collected":0,"emitted":0},"query1":{"avg_exec_time_ns":6243805,"batches_queried":0,"collected":0,"emitted":0,"points_queried":0,"query_errors":0}}},"created":"2017-04-14T20:42:00.221022462Z","modified":"2017-04-14T20:42:00.221022462Z","last-enabled":"2017-04-14T20:42:00.221022462Z"},{"link":{"rel":"self","href":"/kapacitor/v1/tasks/c084588c-f2e9-447b-a67a-038a71b64639"},"id":"c084588c-f2e9-447b-a67a-038a71b64639","template-id":"","type":"batch","dbrps":[{"db":"statistics","rp":"one_day"}],"script":"batch\n    |query('''\n\t\tSELECT mean(cpu_percent) AS mean_cpu_percent\n\t\tFROM \"statistics\".\"one_day\".\"cpu_percent\"\n\t\tWHERE \"host\" = 'do.1'\n\t''')\n        .period(1s)\n        .every(30s)\n    |alert()\n        .id('[do.1] cpu_percent')\n        .message('{{ .ID }} is {{ .Level }} value:{{ index .Fields \"mean_cpu_percent\" }}')\n        .crit(lambda: \"mean_cpu_percent\" \u003e 1)\n        .post('http://api.nanobox.dev:8080/v1/triggers/1b2b22f3-62e1-4690-bc62-4cf3e156e20b/pull')\n        .stateChangesOnly()\n        .log('/tmp/alerts.log')\n","vars":null,"dot":"digraph c084588c-f2e9-447b-a67a-038a71b64639 {\ngraph [throughput=\"0.00 batches/s\"];\n\nquery1 [avg_exec_time_ns=\"3.637332ms\" batches_queried=\"0\" points_queried=\"0\" query_errors=\"0\" ];\nquery1 -\u003e alert2 [processed=\"0\"];\n\nalert2 [alerts_triggered=\"0\" avg_exec_time_ns=\"0s\" crits_triggered=\"0\" infos_triggered=\"0\" oks_triggered=\"0\" warns_triggered=\"0\" ];\n}","status":"enabled","executing":true,"error":"","stats":{"task-stats":{"throughput":0},"node-stats":{"alert2":{"alerts_triggered":0,"avg_exec_time_ns":0,"collected":0,"crits_triggered":0,"emitted":0,"infos_triggered":0,"oks_triggered":0,"warns_triggered":0},"batch0":{"avg_exec_time_ns":0,"collected":0,"emitted":0},"query1":{"avg_exec_time_ns":3637332,"batches_queried":0,"collected":0,"emitted":0,"points_queried":0,"query_errors":0}}},"created":"2017-04-14T19:58:36.752134021Z","modified":"2017-04-14T19:58:36.752134021Z","last-enabled":"2017-04-14T19:58:36.752134021Z"}]
get alert
$ curl http://localhost:8080/alerts/36f9aaa7-689d-47b0-a08f-f9f6575548ee
# {"link":{"rel":"self","href":"/kapacitor/v1/tasks/36f9aaa7-689d-47b0-a08f-f9f6575548ee"},"id":"36f9aaa7-689d-47b0-a08f-f9f6575548ee","template-id":"","type":"batch","dbrps":[{"db":"statistics","rp":"one_day"}],"script":"batch\n    |query('''\n\t\tSELECT mean(ram_percent) AS mean_ram_percent\n\t\tFROM \"statistics\".\"one_day\".\"ram_percent\"\n\t\tWHERE \"host\" = 'do.1'\n\t''')\n        .period(1s)\n        .every(30s)\n    |alert()\n        .id('[do.1] ram_percent')\n        .message('{{ .ID }} is {{ .Level }} value:{{ index .Fields \"mean_ram_percent\" }}')\n        .crit(lambda: \"mean_ram_percent\" \u003e 2)\n        .post('http://127.0.0.1/alert')\n        .stateChangesOnly()\n        .log('/tmp/alerts.log')\n","vars":null,"dot":"digraph 36f9aaa7-689d-47b0-a08f-f9f6575548ee {\ngraph [throughput=\"0.00 batches/s\"];\n\nquery1 [avg_exec_time_ns=\"6.243805ms\" batches_queried=\"0\" points_queried=\"0\" query_errors=\"0\" ];\nquery1 -\u003e alert2 [processed=\"0\"];\n\nalert2 [alerts_triggered=\"0\" avg_exec_time_ns=\"0s\" crits_triggered=\"0\" infos_triggered=\"0\" oks_triggered=\"0\" warns_triggered=\"0\" ];\n}","status":"enabled","executing":true,"error":"","stats":{"task-stats":{"throughput":0},"node-stats":{"alert2":{"alerts_triggered":0,"avg_exec_time_ns":0,"collected":0,"crits_triggered":0,"emitted":0,"infos_triggered":0,"oks_triggered":0,"warns_triggered":0},"batch0":{"avg_exec_time_ns":0,"collected":0,"emitted":0},"query1":{"avg_exec_time_ns":6243805,"batches_queried":0,"collected":0,"emitted":0,"points_queried":0,"query_errors":0}}},"created":"2017-04-14T20:42:00.221022462Z","modified":"2017-04-14T20:42:00.221022462Z","last-enabled":"2017-04-14T20:42:00.221022462Z"}

open source

Documentation

Overview

Package api provides a restful interface to view aggregated stats as well as manage alerts.

Index

Constants

This section is empty.

Variables

View Source 
var (
	BadJson      = errors.New("Bad JSON syntax received in body")
	BodyReadFail = errors.New("Body Read Failed")
)

Functions

func Start 

func Start() error

start sets the state of the package if the config has all the necessary data for the api and starts the default api server; routing web requests and handling all the routes

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.