Configuración de Prometheus

Prometheus es un sistema de monitorización de código abierto que ofrece características interesantes para la monitorización de eventos y las alertas. Puede encontrar una descripción más detallada en https://prometheus.io/.

Se incluye en OpenKM desde la versión 7.1.21. Para habilitarlo, debe incluir estas dos líneas en el fichero de configuración openkm.properties:

management.endpoint.prometheus.enabled=true
management.metrics.export.prometheus.enabled=true

Una vez modificado, debe reiniciar OpenKM y el endpoint http://127.0.0.1:8080/openkm/actuator/prometheus estará disponible. Este endpoint está protegido y solo será accesible para los usuarios con el rol ROLE_ACTUATOR.

Validación de la configuración

Para verificar que el acceso es válido, abra un terminal y ejecute este comando:

$ http --auth actuator:s3cr3t0 http://localhost:8080/openkm/actuator/prometheus

Si el usuario y la contraseña coinciden, y el usuario tiene el rol ROLE_ACTUATOR, la salida será similar a esta:

# HELP tomcat_global_request_max_seconds
# TYPE tomcat_global_request_max_seconds gauge
tomcat_global_request_max_seconds{name="http-nio-0.0.0.0-8080",} 0.449
tomcat_global_request_max_seconds{name="ajp-nio-127.0.0.1-8009",} 0.0
# HELP jvm_threads_peak_threads The peak live thread count since the Java virtual machine started or peak was reset
# TYPE jvm_threads_peak_threads gauge
jvm_threads_peak_threads 128.0
# HELP system_cpu_usage The "recent cpu usage" for the whole system
# TYPE system_cpu_usage gauge
system_cpu_usage 0.04721888755502201

Ejecución de Prometheus con Docker

La forma más sencilla de poner en marcha Prometheus es utilizar la imagen de Docker, por lo que debemos obtenerla:

$ docker pull prom/prometheus

Una vez que tengamos la imagen, debemos crear el fichero de configuración prometheus.yml:

global:
  scrape_interval:     15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
  evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
  # scrape_timeout is set to the global default (10s).

# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
  # - "first_rules.yml"
  # - "second_rules.yml"

# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  - job_name: 'prometheus'
    # metrics_path defaults to '/metrics'
    # scheme defaults to 'http'.
    static_configs:
    - targets: ['127.0.0.1:9090']

  - job_name: 'spring-actuator'
    metrics_path: '/openkm/actuator/prometheus'
    scrape_interval: 5s
    static_configs:
    - targets: ['172.17.0.1:8080']
    basic_auth:
      username: 'actuator'
      password: 's3cr3t0'

Creemos el fichero de Docker Compose adecuado:

version: '3.2'

services:

  prometheus:
    image: prom/prometheus
    container_name: prometheus
    hostname: prometheus
    command:
      - "--config.file=/etc/prometheus/prometheus.yml"
    ports:
      - 9090:9090
    volumes:
      - ./prometheus.yaml:/etc/prometheus/prometheus.yml

Y puede iniciarlo ejecutando:

$ docker-compose up -d

Para obtener más información, consulte la documentación de Prometheus.