Prometheus
App Vendor: Prometheus
App Category: Analytics & SIEM
App version: 1.0.0
API version: 1.0.0
Product version: 2.20
About App
The Prometheus app allows the security teams to integrate with the Prometheus enterprise app, a systems and service monitoring application. Analysts can collect metrics from configured targets at given intervals, evaluate rule expressions, display results, and trigger alerts if a condition is true.
The Prometheus app in the Orchestrate application can perform the below-listed actions:
Action Name | Description |
|---|---|
Fetch active alert | This action can be used to return a list of all active alerts. |
List rules | This action fetches a list of alerting or recording rules that are currently loaded. |
Get runtime information | This action can be used to fetch various runtime information properties about the Prometheus server. |
Create query | This action can be used to create and run queries. |
Fetch labels | This action can be used to fetch Labels. |
Fetch target state | This action can be used to return an overview of the current state of the Prometheus target discovery. |
Prerequisites
All the actions configured in the Prometheus app relate to private APIs. Prometheus Enterprise subscription is required to access the private APIs.
Configuration parameters
The following configuration parameters are required for the Prometheus app to communicate with Prometheus enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the Base URL as “http/<https://<ip>:<port>>”. | Text | Required | |
Username | Enter the username. | Text | Optional | |
Password | Enter the Password. | Text | Optional | |
TLS verification | Optional preference to either verify or skip the TLS certificate verification. | Boolean | Optional | Allowed values:
By default, the value is "False" |
Action: Fetch active alert
This action can be used to retrieve a list of all active alerts.
Action Input Parameters
No input parameters are required for this action.
Action: List rules
This action fetches a list of alerting or recording rules that are currently loaded.
Action Input Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Rule type | Enter the rule type to filter the search. | Text | Optional | Allowed types:
When the parameter is empty, no filtering is done. |
Example Request
{
"rule_type": "alert"
}Action: Get runtime information
This action can be used to fetch various runtime information properties about the Prometheus server.
Action Input Parameters
No input parameters are required for this action.
Action: Create query
This action can be used to create and run queries.
Action Input Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
Query | Enter the query. For example, “go_threads”. | Text | Required |
Example Request
[
{
"query": "go_threads"
}
]Action: Fetch labels
This action can be used to fetch labels.
Action Input Parameters
No input parameters are required for this action.
Action: Fetch target state
This action can be used to return an overview of the current state of the Prometheus target discovery.
Action Input Parameters
Parameter | Description | Field Type | Required / Optional | Comments |
|---|---|---|---|---|
State | Enter the state to filter targets. | Text | Optional | Allowed states:
|
Example Request
[
{
"state": "active"
}
]