Activity plugin API¶
-
GET
/activity
¶ Get list of PostgreSQL backends.
Request Headers: - X-Session – Session ID
Status Codes: - 200 OK – no error
- 401 Unauthorized – invalid session
- 500 Internal Server Error – internal error
- 406 Not Acceptable – header
X-Session
is malformed.
Example request:
GET /activity HTTP/1.1
X-Session: 3b28ed94743e3ada57b217bbf9f36c6d1eb45e669a1ab693e8ca7ac3bd070b9e
Example response:
HTTP/1.0 200 OK
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:57:52 GMT
Access-Control-Allow-Origin: *
Content-type: application/json
{
"rows":
[
{
"pid": 6285,
"database": "postgres",
"user": "postgres",
"client": null,
"cpu": 0.0,
"memory": 0.13,
"read_s": "0.00B",
"write_s": "0.00B",
"iow": "N",
"wait": "N",
"duration": "1.900",
"state": "idle",
"query": "SELECT 1;"
}
]
}
Error responses:
HTTP/1.0 401 Unauthorized
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:58:00 GMT
Content-type: application/json
{"error": "Invalid session."}
HTTP/1.0 406 Not Acceptable
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:58:00 GMT
Content-type: application/json
{"error": "Parameter 'X-Session' is malformed."}
-
GET
/activity/waiting
¶ Get list of PostgreSQL backends waiting for lock acquisition.
Request Headers: - X-Session – Session ID
Status Codes: - 200 OK – no error
- 401 Unauthorized – invalid session
- 500 Internal Server Error – internal error
- 406 Not Acceptable – header
X-Session
is malformed.
Example request:
GET /activity/waiting HTTP/1.1
X-Session: 3b28ed94743e3ada57b217bbf9f36c6d1eb45e669a1ab693e8ca7ac3bd070b9e
Example response:
HTTP/1.0 200 OK
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:57:52 GMT
Access-Control-Allow-Origin: *
Content-type: application/json
{
"rows":
[
{
"pid": 13532,
"database": "test",
"user": "postgres",
"cpu": 0.0,
"memory": 0.16,
"read_s": "0.00B",
"write_s": "0.00B",
"iow": "N",
"relation": " ",
"type": "transactionid",
"mode": "ShareLock",
"state": "active",
"duration": 4.35,
"query": "DELETE FROM t1 WHERE id = 1;"
}
]
}
-
GET
/activity/blocking
¶ Get list of PostgreSQL backends blocking other backends due to lock acquisition.
Request Headers: - X-Session – Session ID
Status Codes: - 200 OK – no error
- 401 Unauthorized – invalid session
- 500 Internal Server Error – internal error
- 406 Not Acceptable – header
X-Session
is malformed.
Example request:
GET /activity/blocking HTTP/1.1
X-Session: 3b28ed94743e3ada57b217bbf9f36c6d1eb45e669a1ab693e8ca7ac3bd070b9e
Example response:
HTTP/1.0 200 OK
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:57:52 GMT
Access-Control-Allow-Origin: *
Content-type: application/json
{
"rows":
[
{
"pid": 13309,
"database": "test",
"user": "postgres",
"cpu": 0.0,
"memory": 0.2,
"read_s": "0.00B",
"write_s": "0.00B",
"iow": "N",
"relation": " ",
"type": "transactionid",
"mode": "ExclusiveLock",
"state": "idle in transaction",
"duration": 4126.98,
"query": "UPDATE t1 SET id = 100000000 where id =1;"
}
]
}
-
POST
/activity/activity/kill
¶ Terminate (kill) a list of PostgreSQL backends.
Request Headers: - X-Session – Session ID
Status Codes: - 200 OK – no error
- 401 Unauthorized – invalid session
- 500 Internal Server Error – internal error
- 406 Not Acceptable – header
X-Session
is malformed.
Example request:
POST /activity/kill HTTP/1.1
X-Session: 3b28ed94743e3ada57b217bbf9f36c6d1eb45e669a1ab693e8ca7ac3bd070b9e
Content-Type: application/json
{
"pids":
[
13309
]
}
Example response:
HTTP/1.0 200 OK
Server: temboard-agent/0.0.1 Python/2.7.8
Date: Wed, 22 Apr 2015 09:57:52 GMT
Access-Control-Allow-Origin: *
Content-type: application/json
{
"backends":
[
{"pid": 13309, "killed": true},
]
}