Prometheus Settings and Configurations
The Prometheus integration can be adjusted based on the specific platform needs using the dedicated settings and component’s configuration files:
Prometheus Monitoring Settings
All the Prometheus-related monitoring settings can be found in the Virtuozzo Application Management admin panel. Go to the System Settings section and activate Expert Mode at the top-right corner. You can find all the related parameters by entering “prometheus” to the search bar:
Note: To receive notifications from Prometheus, you need to specify at least one of the notification channels (email or Slack) via the corresponding prometheus.alerting.email.* or prometheus.alerting.slack.* settings. However, we recommend reviewing all the available settings to ensure that the monitoring is configured according to your needs.
| Setting | Description |
|---|---|
| PROMETHEUS_ENABLED | Displays/hides the Prometheus links in the admin panel |
| prometheus.alerting.email | Enables/disables email notifications via Alertmanager |
| prometheus.alerting.email.addresses | A semicolon-separated list of email addresses to receive notifications via Alertmanager |
| prometheus.alerting.repeat.interval | Sets a delay (minutes) before sending a repeat notification via Alertmanager for a firing (ongoing) alert |
| prometheus.alerting.report.resolved | Enables/disables notifications about resolved alerts |
| prometheus.alerting.resolve.timeout | Sets the time (minutes) after which an alert is declared resolved if it has not been updated |
| prometheus.alerting.severity.level | Selects minimal severity level of the reported alerts: INFO - all alerts (critical, warning, info); WARNING – critical and warning alerts; CRITICAL – only critical alerts |
| prometheus.alerting.slack | Enables/disables Slack notifications via Alertmanager |
| prometheus.alerting.slack.channel | Slack channel name for reporting alerts |
| prometheus.alerting.slack.url | Slack webhook URL. |
| prometheus.alerting.status | Enables/disables all alerting notifications. Automatically disabled when maintenance mode is enabled for the admin panel. |
| prometheus.data.retention.period | Sets a period (days) to keep Prometheus monitoring data. After applying this setting, all outdated data will be removed immediately |
| prometheus.data.retention.size | Sets the maximum size (GB) of the Prometheus monitoring data to keep. If exceeded, the oldest data will be deleted first. Set as “0” to disable |
Monitoring Components Configurations
Below, we prepared parameters descriptions for the main configuration files of the Prometheus monitoring components:
- Prometheus
| Section | Property | Description |
|---|---|---|
| Default | jelastic_settings | Path to the Virtuozzo Application Management configuration file (/etc/jelastic/settings.conf). |
| Default | update_interval | Time in seconds after which the service will start a new cycle of internal checks, config generations, etc. |
| Default | alertmanager_prefix | A prefix added to the Alertmanager web path (alertmanager by default). E.g., Prometheus accesses Alertmanager with the http://127.0.0.1/alertmanager URL. |
| Databases | mysql_connection_timeout | Timeout in seconds for prometheus-monitor to connect to Virtuozzo Application Management databases. |
| Databases | vap_general_db | Options for the hivext_jelastic Virtuozzo Application Management database. |
| Databases | vap_config_db | Options for the hivext_configuration Virtuozzo Application Management database. |
| Databases | alerts_database | Path to the internal sqlite3 database, used by prometheus-monitor to store some triggers’ information, hosts and custom hosts data. |
| Exporter | exporter_label_filter | A list of metrics from the Prometheus exporters (App-Management-Exporter) required to generate alerts. If a label specified in the current option is found in the exporter - data from the metric will be processed and a trigger generated. |
| Exporter | exporter_get_timeout | Timeout in seconds to get data from App-Management-Exporter. |
| Exporter | vap_exporter_port | The App-Management-Exporter port. |
| Exporter | additional_exporter_ports | Comma-separated string of additional Prometheus exporter ports. Only App-Management-Exporter is used for trigger generation, but for targets generation the platform needs to know all exporters. |
| Templates | alert_template | Template for Prometheus alert generation. |
| Templates | target_template | Template for Prometheus target generation. |
| Templates | prometheus_template | Template for Prometheus main configuration file. |
| Templates | web_template | Template for Prometheus basic auth. |
| Templates | prometheus_service_template | Template for the prometheus.service systemd service. |
| Configs | prometheus_service_conf | Path to the prometheus.service systemd service (required for template generation). |
| Configs | prometheus_conf | Path to the prometheus.yaml main configuration file (required for template generation). |
| Configs | web_conf | Path the web.yaml configuration file (required for template generation). |
| Configs | targets_dir | Path to the directory where Prometheus will generate targets |
| Configs | alerts_dir | Path to the directory where Prometheus will generate alerts |
| Logging | log_level | Minimal severity level for issues logging. Supported values: INFO, WARNING, ERROR. |
| Logging | logfile | Path to the log file location. |
- Alertmanager
| Section | Property | Description |
|---|---|---|
| Default | jelastic_settings | Path to the Virtuozzo Application Management configuration file (/etc/jelastic/settings.conf). |
| Default | update_interval | Time in seconds after which the service will start a new cycle of internal checks, config generations, etc. |
| Default | dashboard_url_prefix | A prefix added to the Alertmanager web path (alertmanager by default). E.g., Prometheus accesses Alertmanager with the http://127.0.0.1/alertmanager URL. |
| Databases | mysql_connection_timeout | Timeout in seconds for prometheus-monitor to connect to Virtuozzo Application Management databases. |
| Databases | vap_general_db | Options for the hivext_jelastic Virtuozzo Application Management database. |
| Databases | vap_config_db | Options for the hivext_configuration Virtuozzo Application Management database. |
| Databases | alerts_database | Path to the internal sqlite3 database, used by prometheus-monitor to store some triggers’ information, hosts and custom hosts data. |
| Templates | alertmanager_temlate | Template for Alertmanager main configuration file generation. |
| Templates | alertmanager_service_temlate | Template for Alertmanager systemd service generation. |
| Configs | alertmanager_conf | Path to the alertmanager.yaml main configuration file (required for template generation). |
| Configs | htpasswd_file | Path to the .alertmanager-htpasswd configuration file (required for template generation). |
| Configs | alertmanager_service_conf | Path to the alertmanager.service configuration file (required for template generation). |
| Logging | log_level | Minimal severity level for issues logging. Supported values: INFO, WARNING, ERROR. |
| Logging | logfile | Path to the log file location. |
- Grafana
| Section | Property | Description |
|---|---|---|
| Default | jelastic_settings | Path to the Virtuozzo Application Management configuration file (/etc/jelastic/settings.conf). |
| Default | update_interval | Time in seconds after which the service will start a new cycle of internal checks, config generations, etc. |
| Default | dashboards_dir | Path to the directory, where Grafana infrastructure dashboard templates are stored. |
| Default | user_dashboards_dir | Path to the directory, where Grafana user dashboard templates are stored (preserved during the redeploy process). |
| Databases | mysql_connection_timeout | Timeout in seconds for prometheus-monitor to connect to Virtuozzo Application Management databases. |
| Databases | vap_general_db | Options for the hivext_jelastic Virtuozzo Application Management database. |
| Databases | vap_config_db | Options for the hivext_configuration Virtuozzo Application Management database. |
| Databases | alerts_database | Path to the internal sqlite3 database, used by prometheus-monitor to store some triggers’ information, hosts and custom hosts data. |
| Grafana | grafana_url_prefix | A prefix added to the Grafana web path (grafana by default). E.g., Prometheus accesses Grafana with the http://127.0.0.1/grafana URL. |
| Grafana | grafana_login | Grafana administration account login (admin by default). |
| Grafana | grafana_port | The grafana-server service port (3000 by default). |
| Grafana | grafana_host | The grafana-server service host (127.0.0.1 by default). |
| Configs | alertmanager_service_conf | Path to the alertmanager.service configuration file (required for template generation). |
| Prometheus | prometheus_url_prefix | Used to specify a prefix that is prepended to prometheus web paths. Default value - prometheus. |
| Prometheus | prometheus_login | The Prometheus administration account login (admin by default). |
| Prometheus | prometheus_port | The Prometheus service port (9090 by default). |
| Prometheus | prometheus_host | The Prometheus service host (127.0.0.1 by default). |
| Prometheus | prometheus_datasource | The name for the Prometheus datastore in Grafana (Prometheus by default). |
| Logging | log_level | Minimal severity level for issues logging. Supported values: INFO, WARNING, ERROR. |
| Logging | logfile | Path to the log file location. |
