A notification plugin to send the result of a Rundeck job execution to the Prometheus Pushgateway.
Supported Rundeck job trigger types are: success, failure
- Gradle
- Java >= 1.8
Copy your compiled jar into /var/lib/rundeck/libext (can also be done via the interface in newer versions via Configuration -> Plugins -> Upload Plugin).
chown rundeck:rundeck /var/lib/rundeck/libext/rundeck-prometheuspushplugin*.jar
rm -rf /var/lib/rundeck/libext/cache
service rundeckd restart| Name | Description | Default Value |
|---|---|---|
| pushgateway_endpoints | Comma seperated list of Pushgateway endpoints | ${globals.prometheus_pushgateway_endpoints} |
| metric_prefix | Metric name prefix | ${globals.prometheus_metric_prefix} |
Project level configuration example (Project Settings -> Edit Configuration -> Edit Configuration File):
project.globals.prometheus_pushgateway_endpoints=pushgateway1:9091,pushgateway2:9091
project.globals.prometheus_metric_prefix=app| Metric | Labels | Example | Description | Source |
|---|---|---|---|---|
| * | job | my_rundeck_job | Prometheus job ID | Rundeck job ID |
PREFIX |
name type environment project | app{job="my_rundeck_job",name="My Rundeck Job",project="RundeckProjectName", type="RundeckJobGroupFirst",environment="RundeckJobGroupSecond"} |
Root of PREFIX labels |
Rundeck Project, Rundeck Job Group (type/environment) |
PREFIX_state |
app_state{job="my_rundeck_job"} | Execution state (1 = healthy 0 = unhealthy) | Rundeck job execution succeeded/failed | |
PREFIX_epochtime |
Execution timestamp | Rundeck job execution startime | ||
PREFIX_duration |
Time taken to get retrieve health state | Rundeck job execution duration | ||
PREFIX_execution |
instance execution | app_execution{execution="322335",instance="https://myrundeck:8080",job="my_rundeck_job"} | Root of execution labels | Rundeck instance and job execution ID |
app{job="check_application_state",name="Check Application State",project="Internal",type="Applicative",environment="Development"}
Get application state based on environment:
app_state and on(job) app{environment="Development"}
Plugin errors are written into /var/log/rundeck/service.log.
On failure it will notify Rundeck by returning "false", but it is currently unclear how you can actually act on it...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent