[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":21,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/krpn/prometheus-alert-webhooker/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","krpn","reponame","prometheus-alert-webhooker","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":21,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2018-08-30T12:58:26.02906Z","description","","is_private","last_updated","2021-09-12T16:23:55.228161Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",4601,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# prometheus-alert-webhooker\n\n[![Build Status](https://travis-ci.org/krpn/prometheus-alert-webhooker.svg?branch=master)](https://travis-ci.org/krpn/prometheus-alert-webhooker) [![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=krpn_prometheus-alert-webhooker&metric=alert_status)](https://sonarcloud.io/dashboard?id=krpn_prometheus-alert-webhooker) [![Coverage Status](https://sonarcloud.io/api/project_badges/measure?project=krpn_prometheus-alert-webhooker&metric=coverage)](https://sonarcloud.io/component_measures?id=krpn_prometheus-alert-webhooker&metric=coverage) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=krpn_prometheus-alert-webhooker&metric=sqale_index)](https://sonarcloud.io/component_measures?id=krpn_prometheus-alert-webhooker&metric=sqale_index) [![License](https://img.shields.io/github/license/krpn/prometheus-alert-webhooker.svg)](https://github.com/krpn/prometheus-alert-webhooker/blob/master/LICENSE)\n\nprometheus-alert-webhooker converts [Prometheus Alertmanager Webhook](https://prometheus.io/docs/operating/integrations/#alertmanager-webhook-receiver) to any action\n\n# Table of Contents\n* [Features](#features)\n* [Quick Start](#quick-start)\n* [Configuration](#configuration)\n* [Executors](#executors)\n * [Executor `jenkins`](#executor-jenkins)\n * [Executor `shell`](#executor-shell)\n * [Executor `http`](#executor-http)\n * [Executor `telegram`](#executor-telegram)\n* [Command-Line Flags](#command-line-flags)\n* [Exposed Prometheus Metrics](#exposed-prometheus-metrics)\n* [Contribute](#contribute)\n\n# Features\n\n* Converts Prometheus Alertmanager Webhook to any action using rules\n* Currently supports actions (see [executors](#executors)):\n * run Jenkins job (optionally with parameters)\n * run shell command\n * send Telegram message\n* Alert labels/annotations can be used in action placeholders\n* Rules are set in config and can be flexible ([example](https://github.com/krpn/prometheus-alert-webhooker/blob/master/example/config.yaml))\n* Supported config types JSON, TOML, YAML, HCL, and Java properties ([Viper](https://github.com/spf13/viper) is used)\n* Supported config providers: file, etcd, consul (with automatic refresh)\n* Prometheus metrics built in\n* A docker image available on [Docker Hub](https://hub.docker.com/r/krpn/prometheus-alert-webhooker/)\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Quick Start\n\n1. Prepare config.yaml file based on [example](https://github.com/krpn/prometheus-alert-webhooker/blob/master/example/config.yaml) (details in [configuration](#configuration))\n\n2. Run container with command ([cli flags](#command-line-flags)):\n\n If you use file config:\n \n `docker run -d -p :8080 -v :/config --name prometheus-alert-webhooker krpn/prometheus-alert-webhooker --verbose`\n \n If you use Consul:\n \n `docker run -d -p :8080 --name prometheus-alert-webhooker krpn/prometheus-alert-webhooker --verbose --provider consul --config http://:8500/v1/kv/`\n\n3. Checkout logs:\n\n `docker logs prometheus-alert-webhooker`\n\n4. Add webhook to [Alertmanager webhook config](https://prometheus.io/docs/alerting/configuration/#webhook_config). url will be:\n\n `url: http://:/webhooker`\n \n5. Add webhooker instance to [Prometheus scrape targets](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#%3Cscrape_config%3E) if needed (port is the same; [metrics](#exposed-prometheus-metrics))\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Configuration\n\nConfiguration description based on YAML format:\n\n```yaml\n# WEBHOOKER GLOBAL SETTINGS\n# cache size for blocked tasks\n# calculate: 50 * 1024 * 1024 = 50 MB\n# default if not set: 52428800\nblock_cache_size: 52428800\n\n# pool size for new tasks\n# locks webhook if overflow\n# default if not set: 100\npool_size: 100\n\n# runners count for parallel actions execute\n# default if not set: 10\nrunners: 10\n\n# remote config refresh interval\n# used only for etcd and consul config providers\n# rules including common parameters will be refreshed only\n# global settings exclude refresh interval will NOT be refreshed (restart is required)\n# will not refresh if zero\n# default if not set: 0s\nremote_config_refresh_interval: 60s\n\n\n# COMMON PARAMETERS FOR ACTIONS (optional)\n# available to get in rules-actions-common_parameters\n# can be used for storing credentials\ncommon_parameters:\n # name of parameters set\n :\n : \n : \n\n\n# LIST OF RULES\nrules:\n- name: # rule name\n\n # list of conditions for this rule\n # values can be regexp\n # regexp detecting by existence of regexp group\n # if no regexp groups found value used as string\n # matching with AND operator, ALL conditions must match\n conditions:\n # define alert status for match if needed\n # default if not set: firing\n # alert_status: firing\n \n # list of alert labels for match\n alert_labels:\n : \n : \n \n # list of alert annotations for match\n alert_annotations:\n : \n : \n \n # list of actions for this rule\n # (!) if few actions are match for alert all matched actions will be exec\n # (!) actions will be execute sequentially\n # if action fails the other actions will be cancelled\n actions:\n - executor: # executor from available executor list \n \n # get parameters from common if needed\n # common parameters has low priority to action parameters:\n # the same parameter will be replaced by action parameter\n # common_parameters: \n \n # list of parameters for action\n # (!) each executor can have a list of required parameters\n # parameter values can contains placeholders fully in UPPER case:\n # ${LABELS_} will be replaced by \n # ${ANNOTATIONS_} will be replaced by \n # each placeholder can have one modificator (optionally): ${LABELS_}\n # list:\n # URLENCODE_ - escapes the string so it can be safely placed inside a URL query\n # CUT_AFTER_LAST_COLON_ - cuts text after last colon, can be used for cut port from instance label\n # JSON_ESCAPE_ - escapes the string so it can be safely placed inside a JSON value\n # examples:\n # ${LABEL_ALERTNAME} - alert name\n # ${ANNOTATIONS_COMMAND} - value from annotation \"command\"\n # ${CUT_AFTER_LAST_COLON_LABEL_INSTANCE} - instance without port\n # ${URLENCODE_ANNOTATIONS_SUMMARY} - urlencoded value from annotation \"summary\"\n # ${JSON_ESCAPE_ANNOTATIONS_DESCRIPTION} - JSON escaped value from annotation \"description\"\n # (!) all unexpected parameters will be ignored\n parameters:\n : \n : \n \n # block time for successfully executed action\n # used for occasional exec\n # (!) blocks only unique set of parameters for this action\n # will not block if zero\n # (!) all blocks released when webhooker restarts\n # default if not set: 0s\n block: 10m\n```\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Executors\n\nExecutors and it parameters described below.\n\n## Executor `jenkins`\n\n`jenkins` is used for run Jenkins jobs. Runner starts job, waits job finish and check it was successfull.\n\n| Parameter | Type | Description | Example |\n|----------------------------------|:----------:|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|\n| `endpoint` | `string` | Jenkins address | `endpoint: https://jenkins.example.com/` |\n| `login` | `string` | Jenkins login | `login: webhooker` |\n| `password` | `string` | Jenkins password | `password: qwerty123` |\n| `job` | `string` | Name of job to run. If you use Jenkins Folders Plugin you need set the full path to job | `job: YourJob or Folder/job/YourJob (Folders Plugin)` |\n| `job parameter ` | `string` | (optional) Pass to job | `job parameter server: ${CUT_AFTER_LAST_COLON_LABEL_INSTANCE}` |\n| `state_refresh_delay` | `duration` | (optional, default: 15s) How often runner will be refresh job status when executing | `state_refresh_delay: 3s` |\n| `secure_interations_limit` | `integer` | (optional, default: 1000) How many refresh status iterations will be until Job will be considered hung and runner release it | `secure_interations_limit: 500` |\n\n## Executor `shell`\n\n`shell` is used for run unix shell command. *Remember: all shell scripts must be mounted if you use Docker.*\n\n| Parameter | Type | Description | Example |\n|-----------|:------------------:|----------------------------------|---------------------------------------|\n| `command` | `string` | Command for execute | `command: ./clean.sh ${LABEL_FOLDER}` |\n| `args` | `array of strings` | (optional) arguments for command | `args: ['-i', '/root/.ssh/id_rsa']` |\n\n## Executor `http`\n\n`http` is used for making HTTP requests.\n\n| Parameter | Type | Description | Example |\n|------------------------|:----------:|----------------------------------------------------------------------------------------------|------------------------------------------------------------|\n| `url` | `string` | Request URL | `url: https://www.example.com/` |\n| `method` | `string` | (optional, default: GET) Request method | `method: POST` |\n| `body` | `string` | (optional) Request body | `body: {\"data\": \"${JSON_ESCAPE_ANNOTATIONS_DESCRIPTION}\"}` |\n| `header ` | `string` | (optional) Sets header | `header Authorization: ba0828c9fac6b0b47d9147963429d091` |\n| `timeout` | `duration` | (optional, default: 1s) Request timeout | `timeout: 100ms` |\n| `success_http_status` | `integer` | (optional, default: 200) Success response status code, will be checked after request execute | `success_http_status: 201` |\n\n## Executor `telegram`\n\n`telegram` is used for handy notifications about webhooker events.\n\n| Parameter | Type | Description | Example |\n|-------------|:---------:|----------------------------------------------------|--------------------------------------------------------|\n| `bot_token` | `string` | Bot token from [BotFather](https://t.me/BotFather) | `bot_token: 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11` |\n| `chat_id` | `integer` | Chat ID for send notifications to | `chat_id: -1001103941234` |\n| `message` | `string` | Message for send | `message: Fixed ${LABEL_ALERTNAME}` |\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Command-Line Flags\n\nUsage: `prometheus-alert-webhooker []`\n\n| Flag | Type | Description | Default |\n|----------------------|:--------:|----------------------------------------------------------------------------|----------------------|\n| `-p` or `--provider` | `string` | Config provider: file, etcd, consul | `file` |\n| `-c` or `--config` | `string` | Path to config file with extension, can be link for etcd, consul providers | `config/config.yaml` |\n| `-l` or `--listen` | `string` | HTTP port to listen on | `:8080` |\n| `-v` or `--verbose` | | Enable verbose logging | |\n| `--help` | | Show help | |\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Exposed Prometheus Metrics\n\n| Name | Description | Labels |\n|---------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------------------------|\n| `prometheus_alert_webhooker_income_tasks` | Income tasks counter | `rule` `alert` `executor` |\n| `prometheus_alert_webhooker_executed_tasks` | Executed tasks histogram with duration in seconds. `error` label is empty if no error occurred | `rule` `alert` `executor` `result` `error` |\n\n[(back to top)](#prometheus-alert-webhooker)\n\n# Contribute\n\nPlease feel free to send me [pull requests](https://github.com/krpn/prometheus-alert-webhooker/pulls).\n\n[(back to top)](#prometheus-alert-webhooker)","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",421564674,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",3903047,"full_size",12938220,"id",34246084,"images",[101],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},"architecture","amd64","digest","sha256:7d4f7f836f4e341f0eba193dec57305fda31f8bcb588ea381475d2a21ee5b387","features","last_pulled","2026-10-01T22:30:26.721374622Z","last_pushed","2021-09-12T16:23:55Z","os","linux","os_features","os_version","size","variant","2021-09-12T16:23:54.806709Z","last_updater","last_updater_username","media_type","latest","repository",5952943,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":21,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_102":103,"_104":105,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":96,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

krpn/prometheus-alert-webhooker

Tags for krpn/prometheus-alert-webhooker