getIssues - Get check-up issues and alerts
Use case
You can utilize this endpoint to export the currently active issues for a server or database, as determined by the pganalyze Check-Up system, in order to export them to a third-party system such as PagerDuty.
API
Arguments for getIssues
:
databaseId
(string)
Database ID for which to retrieve issues forserverId
(string)
Server ID for which to retrieve issues for (either this ordatabaseID
needs to be specified)
Fields returned:
-
issues
(Array of IssueType)id
(String)
Unique ID of this issuedatabaseId
(Number)
Database ID this issue is related todescription
(String)
Issue descriptionseverity
(String)
Issue severity (info, warning, critical)displayName
(String)
Name of the object this issue is associated to-
reference
(IssueReferenceType)kind
(String)
Type of object this issue referencesname
(String)
Name of the object this issue referencesurl
(String)
URL to the object this issue referencessecondaryUrl
(String) (optional)
Secondary URL for an alternate object this issue references (e.g. active queries reference both the connection as well as the query object)queryText
(String) (optional)
For query references, statement text of the query
Example
query {
getIssues(databaseId: 12345) {
id
displayName
description
severity
reference {
url
}
}
}
curl -XPOST -H 'Authorization: Token XXXXXXX' -F 'query=query { getIssues(databaseId: 12345) { id, displayName, description, severity, reference { url } } }' https://app.pganalyze.com/graphql
{
"data": {
"getIssues": [
{
"id": "42",
"displayName": "shared_buffers",
"description": "is too small. For 996 MB RAM try using shared_buffers = 256 MB (current: 199 MB)",
"severity": "warning",
"reference": {
"url": "/databases/6/config/shared_buffers"
}
}
]
}
}
Couldn't find what you were looking for or want to talk about something specific?
Start a conversation with us →