Prometheus Usage Guideline

Overview

Uqbar supports the writing of Prometheus monitoring data into a time-series table through the uqbar-prometheus-adapter. The uqbar-prometheus-adapter serves as middleware bridging Prometheus and Uqbar. Leveraging Prometheus' support for remote storage, it converts external requests, such as PromSQL queries from tools like Grafana and data write requests from monitoring devices, into SQL statements. These SQL statements are then sent to Uqbar for writing monitoring data into the database or for retrieving query results from the database and returning them to Prometheus.

Install Prometheus

To download Prometheus, please visit https://prometheus.io/download/.

Modify The Prometheus Configuration File

Configure the Prometheus YAML file by adding remote storage settings. The minimal configuration is as follows:

global:
scrape_interval: 15s
evaluation_interval: 15s
alerting:
alertmanagers:
 - static_configs:
 - targets:
rule_files:
scrape_configs:
 - job_name: "prometheus"
scheme : "http"
static_configs:
 - targets: [ "localhost:9090"]
remote_write:
 - url: " http://localhost:9201/write"
remote_read:
 - url: "http://localhost:9201/read "
read_recent: true

The url in remote_write and remote_read is configured as the actual address of the uqbar-prometheus-adapter.

The above configuration is without TLS and without auth checking, for using TLS example is as follows:

global:
scrape_interval: 15s
evaluation_interval: 15s
alerting:
alertmanagers:
- static_configs:
- targets:
rule_files:
scrape_configs:
- job_name: "prometheus"
scheme : "http"
static_configs:
- targets: [ "localhost:9090"]
remote_write:
- url: " https://localhost:9201/write"
basic_auth:
username: "hello"
password: "world"
# =====================
# authorization:
# type: "Bearer"
# credentials: "QWxhZGRpbjpvcGVuIHNlc2FtZQ"
# =====================
tls_config:
ca_file: "xx/ca.crt"
cert_file: "xx/server.pem"
key_file: "xx/server.key"
remote_read:
- url: "https://localhost:9201/read"
read_recent: true
basic_auth:
username: "hello"
password: "world"
# =====================
# authorization:
# type: "Bearer"
# credentials: "QWxhZGRpbjpvcGVuIHNlc2FtZQ"
# =====================
tls_config:
ca_file: "xx/ca.crt"
cert_file: "xx/server.pem"
key_file: "xx/server.key"

Please note that the url parameter in remote_read and _remote_write should be set to https to make Prometheus' tsdb component send HTTPS requests to remote storage. Therefore, when using TLS, ensure that the url parameter is configured correctly. Otherwise, you may encounter issues where HTTP requests are sent to an HTTPS server, causing service disruptions.

Start Prometheus

Examples of startup parameters are shown below:

nohup ./prometheus --config.file=prometheus.yml &

The uqbar-prometheus-adapter itself has configurable parameters that can be specified with --xx=xx when starting the service, see the following table for specific parameters and roles.

The minimal startup command is as follows:

./uqbar-prometheus-adapter --db-host="localhost" --db-user=world --db-password="Test@123" --db-port=17680 --db-database="postgres"

This tool also supports launching using a configuration file. The usage is --config=xx.yaml.

The configuration file uses the YAML format but requires a flat hierarchical structure, where all parameters are at the same level. Specifying parameters in both the command line and the configuration file will result in a failure to start and will generate a prompt.

Connect To Uqbar

1. Configure Prometheus monitoring tasks and remote storage.

2. Start the uqbar-prometheus-adapter tool, database password authentication must be in MD5 format.

3. Data successfully written to Uqbar.

4. You can query the data that has been written using the Prometheus web UI (http://localhost:9090/graph).