ansible-collection-prometheus/branch/main/searchindex.js

Search.setIndex({"docnames": ["alertmanager_role", "blackbox_exporter_role", "environment_variables", "index", "mysqld_exporter_role", "node_exporter_role", "prometheus_role", "snmp_exporter_role", "systemd_exporter_role"], "filenames": ["alertmanager_role.rst", "blackbox_exporter_role.rst", "environment_variables.rst", "index.rst", "mysqld_exporter_role.rst", "node_exporter_role.rst", "prometheus_role.rst", "snmp_exporter_role.rst", "systemd_exporter_role.rst"], "titles": ["prometheus.prometheus.alertmanager role \u2013 Prometheus Alertmanager service", "prometheus.prometheus.blackbox_exporter role \u2013 Deploy and manage Prometheus blackbox exporter", "Index of all Collection Environment Variables", "Prometheus.Prometheus", "prometheus.prometheus.mysqld_exporter role \u2013 Prometheus MySQLd Exporter", "prometheus.prometheus.node_exporter role \u2013 Prometheus Node Exporter", "prometheus.prometheus.prometheus role \u2013 Installs and configures prometheus", "prometheus.prometheus.snmp_exporter role \u2013 Prometheus SNMP exporter", "prometheus.prometheus.systemd_exporter role \u2013 Prometheus Systemd Exporter"], "terms": {"thi": [0, 1, 4, 5, 6, 7, 8], "i": [0, 1, 4, 5, 6, 7, 8], "part": [0, 1, 4, 5, 6, 7, 8], "version": [0, 1, 3, 4, 5, 6, 7, 8], "0": [0, 1, 3, 4, 5, 6, 7, 8], "5": [0, 1, 3, 4, 5, 6, 7, 8], "2": [0, 1, 3, 4, 5, 6, 7, 8], "To": [0, 1, 4, 5, 6, 7, 8], "instal": [0, 1, 3, 4, 5, 7, 8], "us": [0, 1, 2, 4, 5, 6, 7, 8], "ansibl": [0, 1, 2, 3, 4, 5, 6, 7, 8], "galaxi": [0, 1, 4, 5, 6, 7, 8], "playbook": [0, 1, 4, 5, 6, 7, 8], "specifi": [0, 1, 4, 5, 6, 7, 8], "deploi": [0, 3, 4, 5, 7, 8], "manag": [0, 3, 6, 7], "comment": [0, 1, 4, 5, 6, 7, 8], "alertmanager_amtool_config_alertmanager_url": 0, "string": [0, 1, 4, 5, 6, 7, 8], "url": [0, 1, 4, 5, 6, 7, 8], "default": [0, 1, 4, 5, 6, 7, 8], "alertmanager_web_external_url": 0, "alertmanager_amtool_config_fil": 0, "templat": [0, 6], "amtool": 0, "config": [0, 4, 5, 6], "yml": [0, 6, 7], "j2": [0, 6], "alertmanager_amtool_config_output": 0, "extend": 0, "output": 0, "simpl": 0, "alertmanager_binary_local_dir": 0, "allow": [0, 1, 6, 8], "local": [0, 4, 5, 6, 8], "packag": [0, 1, 4, 5, 6, 7, 8], "instead": [0, 4, 5, 6, 8], "ones": [0, 6, 8], "distribut": [0, 4, 5, 6, 8], "github": [0, 1, 3, 4, 5, 6, 7, 8], "As": [0, 6, 8], "take": [0, 6, 8], "directori": [0, 4, 5, 6, 8], "where": [0, 4, 5, 6, 8], "AND": [0, 6], "binari": [0, 1, 4, 5, 6, 7, 8], "ar": [0, 2, 3, 4, 5, 6], "store": [0, 4, 5, 6, 8], "host": [0, 4, 5, 6, 8], "which": [0, 1, 4, 5, 6, 7, 8], "ran": [0, 6], "overrid": [0, 4, 5, 6, 8], "alertmanager_vers": 0, "alertmanager_binary_url": 0, "tar": [0, 1, 4, 5, 6, 7, 8], "gz": [0, 1, 4, 5, 6, 7, 8], "file": [0, 1, 4, 5, 6, 7, 8], "http": [0, 1, 3, 4, 5, 6, 7, 8], "com": [0, 1, 3, 4, 5, 6, 7, 8], "_alertmanager_repo": 0, "releas": [0, 1, 4, 5, 6, 7, 8], "download": [0, 1, 4, 5, 6, 7, 8], "v": [0, 1, 4, 5, 6, 7, 8], "linux": [0, 1, 4, 5, 6, 7, 8], "go_arch": [0, 4, 5, 6, 8], "alertmanager_checksums_url": 0, "checksum": [0, 4, 5, 6, 7, 8], "sha256sum": [0, 4, 5, 6, 7, 8], "txt": [0, 4, 5, 6, 7, 8], "alertmanager_clust": 0, "dictionari": [0, 1, 4, 5, 6], "ha": 0, "cluster": 0, "network": 0, "configur": [0, 1, 2, 3, 4, 5, 7, 8], "disabl": [0, 4, 5], "more": [0, 5, 8], "inform": [0, 5], "readm": 0, "listen": [0, 1, 4, 5, 6, 7, 8], "address": [0, 1, 4, 5, 6, 7, 8], "alertmanager_config_dir": 0, "path": [0, 4, 5, 6, 7], "etc": [0, 6], "alertmanager_config_fil": 0, "variabl": [0, 6], "provid": [0, 6], "custom": [0, 6, 7], "form": [0, 6], "alertmanager_config_flags_extra": 0, "addit": [0, 1, 6], "flag": [0, 1, 6], "pass": [0, 1, 6], "startup": [0, 1, 6], "alertmanager_db_dir": 0, "databas": [0, 6], "var": [0, 5, 6], "lib": [0, 5, 6], "alertmanager_hipchat_api_url": 0, "hipchat": 0, "webhook": 0, "alertmanager_hipchat_auth_token": 0, "authent": [0, 4, 5], "token": 0, "alertmanager_http_config": 0, "alertmanager_inhibit_rul": 0, "list": [0, 4, 5, 6], "element": [0, 4, 5, 6], "inhibit": 0, "rule": [0, 6], "same": [0, 4, 5, 6], "offici": [0, 6], "doc": [0, 4, 5, 6], "alertmanager_opsgenie_api_kei": 0, "opsgeni": 0, "kei": [0, 4, 5], "alertmanager_opsgenie_api_url": 0, "alertmanager_pagerduty_url": 0, "pagerduti": 0, "alertmanager_receiv": 0, "A": [0, 6], "notif": 0, "receiv": 0, "alertmanager_resolve_timeout": 0, "time": [0, 6], "after": 0, "an": 0, "alert": [0, 6], "declar": [0, 2], "resolv": 0, "3m": 0, "alertmanager_rout": 0, "rout": 0, "alertmanager_skip_instal": 0, "boolean": [0, 1, 4, 5, 6, 7, 8], "task": [0, 1, 4, 5, 6, 7, 8], "get": [0, 1, 4, 5, 6, 7, 8], "skip": [0, 1, 4, 5, 6, 7, 8], "when": [0, 1, 4, 5, 6, 7, 8], "set": [0, 1, 2, 4, 5, 6, 7, 8], "true": [0, 1, 4, 5, 6, 7, 8], "choic": [0, 1, 4, 5, 6, 7, 8], "fals": [0, 1, 4, 5, 6, 7, 8], "alertmanager_slack_api_url": 0, "slack": 0, "alertmanager_smtp": 0, "smtp": 0, "email": 0, "alertmanager_template_fil": 0, "folder": [0, 6], "look": [0, 6], "copi": [0, 6], "must": [0, 5, 6], "have": [0, 2, 6], "tmpl": 0, "extens": [0, 6], "also": [0, 4, 5, 6, 8], "accept": [0, 4, 5, 6, 8], "latest": [0, 4, 5, 6, 8], "25": 0, "alertmanager_victorops_api_kei": 0, "victorop": 0, "alertmanager_victorops_api_url": 0, "extern": [0, 6], "avail": [0, 6], "behind": [0, 6], "revers": [0, 6], "proxi": [0, 6], "ex": [0, 6], "exampl": [0, 6], "org": [0, 6], "localhost": [0, 6], "9093": 0, "alertmanager_web_listen_address": 0, "alertmanager_wechat_corp_id": 0, "enterpris": 0, "wechat": 0, "corpor": 0, "id": 0, "alertmanager_wechat_secret": 0, "secret": 0, "alertmanager_wechat_url": 0, "commun": [0, 1, 4, 5, 6, 7, 8], "issu": [0, 1, 3, 4, 5, 6, 7, 8], "tracker": [0, 1, 3, 4, 5, 6, 7, 8], "homepag": [0, 1, 3, 4, 5, 6, 7, 8], "repositori": [0, 1, 3, 4, 5, 6, 7, 8], "sourc": [0, 1, 3, 4, 5, 6, 7, 8], "probe": 1, "endpoint": 1, "over": 1, "dn": 1, "tcp": 1, "icmp": 1, "blackbox_exporter_binary_url": 1, "_blackbox_exporter_repo": 1, "blackbox_exporter_vers": 1, "go_arch_map": [1, 7], "ansible_architectur": [1, 7], "blackbox_exporter_cli_flag": 1, "blackbox_exporter_configuration_modul": 1, "http_2xx": 1, "method": 1, "valid_status_cod": 1, "prober": 1, "timeout": [1, 6], "blackbox_exporter_skip_instal": 1, "24": 1, "blackbox_exporter_web_listen_address": 1, "9115": 1, "The": [2, 4, 5], "follow": 2, "document": [2, 3], "plugin": 2, "core": [2, 3], "No": 2, "been": 2, "defin": [2, 4, 5], "collect": 3, "author": 3, "ben": 3, "kochi": 3, "superq": 3, "gar\u00f0ar": 3, "arnarsson": 3, "gardar": 3, "pawe\u0142": 3, "krupa": 3, "paulfantom": 3, "support": [3, 4, 5, 6], "9": 3, "15": [3, 6], "14": 3, "13": 3, "12": 3, "11": 3, "10": [3, 6], "There": 3, "automat": [3, 4, 5], "gener": 3, "These": 3, "alertmanag": [3, 6], "servic": [3, 7, 8], "blackbox_export": 3, "blackbox": 3, "export": 3, "mysqld_export": 3, "mysqld": 3, "node_export": 3, "node": [3, 6], "snmp_export": 3, "snmp": 3, "systemd_export": 3, "systemd": [3, 5], "mysqld_exporter_basic_auth_us": 4, "user": [4, 5, 8], "password": [4, 5], "basic": [4, 5], "hash": [4, 5], "bcrypt": [4, 5], "mysqld_exporter_binary_install_dir": 4, "advanc": [4, 5, 8], "usr": [4, 5, 8], "bin": [4, 5, 8], "mysqld_exporter_binary_local_dir": 4, "enabl": [4, 5, 8], "those": [4, 5], "mai": [4, 5], "run": [4, 5, 8], "mysqld_exporter_vers": 4, "mysqld_exporter_binary_url": 4, "_mysqld_exporter_repo": 4, "mysqld_exporter_checksums_url": 4, "mysqld_exporter_config_fil": 4, "filenam": 4, "mysql": 4, "cnf": 4, "mysqld_exporter_disabled_collector": 4, "collector": [4, 5], "By": [4, 5], "here": [4, 5], "mysqld_exporter_enabled_collector": 4, "dict": [4, 5], "addition": [4, 5], "It": [4, 5, 6], "add": [4, 5], "mysqld_exporter_host": 4, "target": [4, 6], "mysqld_exporter_http_server_config": 4, "valu": [4, 5, 6], "mysqld_exporter_port": 4, "port": 4, "mysqld_exporter_skip_instal": 4, "mysqld_exporter_socket": 4, "unix": 4, "socket": 4, "sock": 4, "mysqld_exporter_system_group": 4, "system": [4, 5, 6, 8], "group": [4, 5, 8], "exp": [4, 5], "mysqld_exporter_system_us": 4, "mysqld_exporter_tls_server_config": 4, "tl": [4, 5, 6], "1": [4, 5, 8], "mysqld_exporter_web_listen_address": 4, "9104": 4, "mysqld_exporter_web_telemetry_path": 4, "under": [4, 5], "expos": [4, 5], "metric": [4, 5, 6, 8], "node_exporter_basic_auth_us": 5, "node_exporter_binary_install_dir": 5, "node_exporter_binary_local_dir": 5, "node_exporter_vers": 5, "node_exporter_binary_url": 5, "_node_exporter_repo": 5, "node_exporter_checksums_url": 5, "node_exporter_disabled_collector": 5, "node_exporter_enabled_collector": 5, "textfil": 5, "node_exporter_textfile_dir": 5, "node_exporter_http_server_config": 5, "node_exporter_skip_instal": 5, "node_exporter_system_group": 5, "node_exporter_system_us": 5, "permiss": 5, "write": [5, 6], "note": 5, "troubleshoot": 5, "md": 5, "guid": 5, "node_exporter_tls_server_config": 5, "6": 5, "node_exporter_web_listen_address": 5, "9100": 5, "node_exporter_web_telemetry_path": 5, "monitor": 6, "prometheus_alert_relabel_config": 6, "relabel": 6, "should": [6, 7], "yaml": 6, "format": 6, "compat": 6, "alert_relabel_config": 6, "prometheus_alert_rul": 6, "full": 6, "prometheus_config_dir": 6, "ansible_manag": 6, "can": 6, "other": 6, "locat": 6, "pleas": 6, "see": 6, "prometheus_alert_rules_fil": 6, "contain": [6, 7], "prometheus_alertmanager_config": 6, "respons": 6, "alertmanager_config": 6, "prometheus_binary_local_dir": 6, "promtool": 6, "prometheus_vers": 6, "prometheus_binary_url": 6, "_prometheus_repo": 6, "prometheus_checksums_url": 6, "prometheus_config_fil": 6, "prometheus_config_flags_extra": 6, "storag": 6, "tsdb": 6, "retent": 6, "15d": 6, "prometheus_db_dir": 6, "prometheus_external_label": 6, "map": 6, "label": 6, "ad": 6, "ani": 6, "seri": 6, "environ": 6, "ansible_fqdn": 6, "ansible_host": 6, "inventory_hostnam": 6, "prometheus_glob": 6, "global": 6, "evaluation_interv": 6, "scrape_interv": 6, "60": 6, "scrape_timeout": 6, "prometheus_metrics_path": 6, "prometheus_web_external_url": 6, "regex_replac": 6, "prometheus_read_only_dir": 6, "read": 6, "ssl": 6, "cert": 6, "outsid": 6, "prometheus_remote_read": 6, "remot": 6, "prometheus_remote_writ": 6, "prometheus_scrape_config": 6, "scrape": 6, "job": 6, "job_nam": 6, "metrics_path": 6, "static_config": 6, "9090": 6, "file_sd_config": 6, "file_sd": 6, "prometheus_skip_instal": 6, "prometheus_static_targets_fil": 6, "static": 6, "json": 6, "prometheus_storage_retent": 6, "data": 6, "period": 6, "30d": 6, "prometheus_storage_retention_s": 6, "size": [6, 8], "maximum": 6, "number": 6, "byte": 6, "block": 6, "unit": [6, 8], "kb": 6, "mb": 6, "gb": 6, "tb": 6, "pb": 6, "prometheus_target": 6, "onli": [6, 8], "x": [6, 8], "45": 6, "prometheus_web_config": 6, "web": 6, "auth": 6, "prometheus_web_listen_address": 6, "snmp_exporter_binary_url": 7, "_snmp_exporter_repo": 7, "snmp_exporter_vers": 7, "snmp_exporter_checksums_url": 7, "snmp_exporter_config_fil": 7, "If": 7, "empti": 7, "from": [7, 8], "otherwis": 7, "snmp_exporter_log_level": 7, "log": 7, "level": 7, "info": 7, "snmp_exporter_skip_instal": 7, "21": 7, "snmp_exporter_web_listen_address": 7, "9116": 7, "systemd_exporter_binary_install_dir": 8, "systemd_exporter_binary_local_dir": 8, "systemd_exporter_vers": 8, "systemd_exporter_binary_url": 8, "_systemd_exporter_repo": 8, "systemd_exporter_checksums_url": 8, "systemd_exporter_enable_file_descriptor_s": 8, "descriptor": 8, "featur": 8, "caus": 8, "root": 8, "need": 8, "access": 8, "proc": 8, "fd": 8, "systemd_exporter_enable_ip_account": 8, "ip": 8, "account": 8, "work": 8, "235": 8, "abov": 8, "systemd_exporter_enable_restart_count": 8, "restart": 8, "count": 8, "systemd_exporter_skip_instal": 8, "systemd_exporter_system_group": 8, "systemd_exporter_system_us": 8, "systemd_exporter_unit_allowlist": 8, "includ": 8, "some": 8, "expect": 8, "regex": 8, "error": 8, "while": 8, "pars": 8, "l": 8, "index": 8, "54": 8, "cannot": 8, "find": 8, "comma": 8, "separ": 8, "next": 8, "one": 8, "systemd_exporter_unit_denylist": 8, "exclud": 8, "systemd_exporter_web_listen_address": 8, "9558": 8}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"prometheu": [0, 1, 3, 4, 5, 6, 7, 8], "alertmanag": 0, "role": [0, 1, 3, 4, 5, 6, 7, 8], "servic": 0, "entri": [0, 1, 4, 5, 6, 7, 8], "point": [0, 1, 4, 5, 6, 7, 8], "main": [0, 1, 4, 5, 6, 7, 8], "synopsi": [0, 1, 4, 5, 6, 7, 8], "paramet": [0, 1, 4, 5, 6, 7, 8], "author": [0, 1, 4, 5, 6, 7, 8], "collect": [0, 1, 2, 4, 5, 6, 7, 8], "link": [0, 1, 4, 5, 6, 7, 8], "blackbox_export": 1, "deploi": 1, "manag": 1, "blackbox": 1, "export": [1, 4, 5, 7, 8], "index": [2, 3], "all": 2, "environ": 2, "variabl": 2, "descript": 3, "plugin": 3, "mysqld_export": 4, "mysqld": 4, "node_export": 5, "node": 5, "instal": 6, "configur": 6, "snmp_export": 7, "snmp": 7, "systemd_export": 8, "systemd": 8}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"prometheus.prometheus.alertmanager role \u2013 Prometheus Alertmanager service": [[0, "prometheus-prometheus-alertmanager-role-prometheus-alertmanager-service"]], "Entry point main \u2013 Prometheus Alertmanager service": [[0, "entry-point-main-prometheus-alertmanager-service"]], "Synopsis": [[0, "synopsis"], [1, "synopsis"], [4, "synopsis"], [5, "synopsis"], [6, "synopsis"], [7, "synopsis"], [8, "synopsis"]], "Parameters": [[0, "parameters"], [1, "parameters"], [4, "parameters"], [5, "parameters"], [6, "parameters"], [7, "parameters"], [8, "parameters"]], "Authors": [[0, "authors"], [1, "authors"], [4, "authors"], [5, "authors"], [6, "authors"], [7, "authors"], [8, "authors"]], "Collection links": [[0, "collection-links"], [1, "collection-links"], [4, "collection-links"], [5, "collection-links"], [6, "collection-links"], [7, "collection-links"], [8, "collection-links"]], "prometheus.prometheus.blackbox_exporter role \u2013 Deploy and manage Prometheus blackbox exporter": [[1, "prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter"]], "Entry point main \u2013 Deploy and manage Prometheus blackbox exporter": [[1, "entry-point-main-deploy-and-manage-prometheus-blackbox-exporter"]], "Index of all Collection Environment Variables": [[2, "index-of-all-collection-environment-variables"]], "Prometheus.Prometheus": [[3, "prometheus-prometheus"]], "Description": [[3, "description"]], "Plugin Index": [[3, "plugin-index"]], "Role Index": [[3, "role-index"]], "prometheus.prometheus.mysqld_exporter role \u2013 Prometheus MySQLd Exporter": [[4, "prometheus-prometheus-mysqld-exporter-role-prometheus-mysqld-exporter"]], "Entry point main \u2013 Prometheus MySQLd Exporter": [[4, "entry-point-main-prometheus-mysqld-exporter"]], "prometheus.prometheus.node_exporter role \u2013 Prometheus Node Exporter": [[5, "prometheus-prometheus-node-exporter-role-prometheus-node-exporter"]], "Entry point main \u2013 Prometheus Node Exporter": [[5, "entry-point-main-prometheus-node-exporter"]], "prometheus.prometheus.prometheus role \u2013 Installs and configures prometheus": [[6, "prometheus-prometheus-prometheus-role-installs-and-configures-prometheus"]], "Entry point main \u2013 Installs and configures prometheus": [[6, "entry-point-main-installs-and-configures-prometheus"]], "prometheus.prometheus.snmp_exporter role \u2013 Prometheus SNMP exporter": [[7, "prometheus-prometheus-snmp-exporter-role-prometheus-snmp-exporter"]], "Entry point main \u2013 Prometheus SNMP exporter": [[7, "entry-point-main-prometheus-snmp-exporter"]], "prometheus.prometheus.systemd_exporter role \u2013 Prometheus Systemd Exporter": [[8, "prometheus-prometheus-systemd-exporter-role-prometheus-systemd-exporter"]], "Entry point main \u2013 Prometheus Systemd Exporter": [[8, "entry-point-main-prometheus-systemd-exporter"]]}, "indexentries": {}})