| Table of Contents |
|---|
...
| Code Block |
|---|
curl -X POST -k -H "Content-Type: application/json" "https://apps.sematext.com/spm-reports/api/v2/alert/threshold/add" -d '
{
"apiKey":"a9092d95-d062-4499-ad0b-a1b43fadb9b5",
"appToken":"12c91563-ba95-4a73-aa5a-08fe04b94631",
"alertRule":{
"name":"Req. Rate Alert",
"enabled":"true",
"estimateValue":500,
"estimateOperation":"MORE",
"metricLabel":"req. count",
"reportName":"solrOverviewReportPage",
"chartKey":"solrRequestRate",
"analyzingTime":"05",
"backToNormalNeeded":false,
"ignoreRegularEventsEnabled":false,
"muteTimePeriodInMinutes":"30",
"minDelayBetweenNotificationsInMinutes":"1",
"maxNotificationsInMutePeriod":"3",
"muteIsGlobal":false,
"sendToEmail":"email-to-send-alerts-to@your-company.com",
"ruleType": "AFValuesRule"
}
}' |
Example of a success response (with HTTP code 200):
...
| Code Block |
|---|
curl -X POST -k -H "Content-Type: application/json" "https://apps.sematext.com/spm-reports/api/v2/alert/thresholdanomaly/add" -d ' { "apiKey":"a9092d95-d062-4499-ad0b-a1b43fadb9b5", "appToken":"12c91563-ba95-4a73-aa5a-08fe04b94631", "alertRule":{ "name":"Req. Rate Alert Anomaly1", "enabled":"true", "metricLabel":"req. count", "reportName":"solrOverviewReportPage", "chartKey":"solrRequestRate","analyzingTime":"60", "backToNormalNeeded":false, "ignoreRegularEventsEnabled":true, "muteTimePeriodInMinutes":"30", "minDelayBetweenNotificationsInMinutes":"1", "maxNotificationsInMutePeriod":"3", "muteIsGlobal":false, "sendToEmail":"email-to-send-alerts-to@your-company.com", "ruleType": "AFAnomalyValuesRule" } }' |
Example of a success response (with HTTP code 200):
...
| Code Block |
|---|
curl -X POST -k -H "Content-Type: application/json" "https://apps.sematext.com/spm-reports/api/v2/alert/heartbeat/add" -d '
{
"apiKey":"a9092d95-d062-4499-ad0b-a1b43fadb9b5",
"appToken":"12c91563-ba95-4a73-aa5a-08fe04b94631",
"alertRule":{
"ruleKey":"",
"name":"MyAPP - heartbeat Alert",
"enabled":"true",
"analyzingTime":"5",
"backToNormalNeeded":false,
"ignoreRegularEventsEnabled":false,
"muteTimePeriodInMinutes":"30",
"minDelayBetweenNotificationsInMinutes":"1",
"maxNotificationsInMutePeriod":"3",
"muteIsGlobal":false,
"sendToEmail":"email-to-send-alerts-to@your-company.com",
"ruleType": "HeartbeatRule"
}
}' |
Example of a success response (with HTTP code 200):
...
| Code Block |
|---|
{
"success" : true,
"data" : {
"metrics" : ["jvm.files.open", "jvm.files.open.max", "jvm.files.open.percentage", "jvm.gc.collection.count", ... "solr.cache.doc.autowarm.count", "solr.cache.doc.evicted", "solr.cache.doc.hits", "solr.cache.doc.hits.percentage", "solr.cache.doc.lookups", ...]
}
} |
Returned metric keys can be used to obtain data points using metrics data API, or list of available filters using metrics filters API.
Metrics Data
For a particular SPM application, this API call will return data points for referenced metric(s) and time span, matching specified filters.
...