Como configurar API de métricas Digibee com Prometheus

Aprenda como integrar API de métricas.

Prometheus é uma plataforma de monitoramento que fornece uma visão abrangente sobre o desempenho e a integridade de vários aspectos da infraestrutura, aplicativos e serviços de TI de uma organização.

Requisitos

• A funcionalidade deve estar habilitada para seu realm.

• Nome de usuário, senha e chave de API gerados no menu Digibee APIs.

• Conexão entre seu Prometheus e seu realm na Digibee Integration Platform.

Exemplos de uso

Configuração

No arquivo de configuração do trabalho do Prometheus, adicione uma configuração de trabalho como demonstrado abaixo:

...
scrape_configs:
...
- job_name: digibee_platform_<ENVIRONMENT>
  scheme: https
  targets:
    - <DIGIBEE_SERVICES_API_URL>
  metrics_path: /metrics/openmetrics_raw?environment=<ENVIRONMENT>
  params:
    environment:
      - <ENVIRONMENT>
    apikey:
      - {DIGIBEE_SERVICES_API_APIKEY}
    metric:
      - <METRIC_NAME>

  basic_auth:
    username: <DIGIBEE_SERVICES_API_USERNAME>
    password: <DIGIBEE_SERVICES_API_PASSWORD>
  honor_timestamps: true
  scrape_interval: 5m
  scrape_timeout: 60s
  follow_redirects: true

Insira seu nome de usuário seguindo o formato <realm>-<nomedeusuario> mostrado no menu Digibee APIs.

Configuração de VPN

...
scrape_configs:
...
- job_name: digibee_platform
  scheme: https
  targets:
    - <DIGIBEE_SERVICES_API_URL>
  metrics_path: /metrics/openmetrics_raw?
  params:
    apikey:
      - {DIGIBEE_SERVICES_API_APIKEY}
    metric:
      - <METRIC_NAME>

  basic_auth:
    username: <DIGIBEE_SERVICES_API_USERNAME>
    password: <DIGIBEE_SERVICES_API_PASSWORD>
  honor_timestamps: true
  scrape_interval: 5m
  scrape_timeout: 60s
  follow_redirects: true

Variáveis

#	Nome da variável	Descrição
1	HOST	HOST da URL gerada na página de credenciais de API após configurar uma credencial.
2	REALM	O nome de seu realm
3	ENVIRONMENT	Ambiente onde as métricas são coletadas
4	DIGIBEE_SERVICES_API_APIKEY	Gerado após configurar um nome de usuário e senha na página de Gerenciamento de API.
5	DIGIBEE_SERVICES_API_USERNAME	Nome de usuário criado/configurado na página de Gerenciamento de API.
6	DIGIBEE_SERVICES_API_PASSWORD	Senha criada/configurada na página de Gerenciamento de API.
7	METRIC_NAME	Lista os nomes das métricas (uma por linha) de acordo com a tabela abaixo.

Visualizar seus dados no Prometheus com Grafana

Nome da métrica	Descrição	Tipo
jvm_memory_bytes_committed	Committed (bytes) de uma determinada área de memória JVM.	Gauge
jvm_memory_bytes_init	Bytes iniciais de uma determinada área de memória JVM.	Gauge
jvm_memory_bytes_max	Máximo (bytes) de uma determinada área de memória JVM.	Gauge
jvm_memory_bytes_used	Bytes usados de uma determinada área de memória JVM.	Gauge
jvm_memory_pool_bytes_committed	Bytes committed de um determinado conjunto de memória JVM.	Gauge
jvm_memory_pool_bytes_init	Bytes iniciais de um determinado conjunto de memória JVM.	Gauge
jvm_memory_pool_bytes_max	Máximo (bytes) de um determinado conjunto de memória JVM.	Gauge
jvm_memory_pool_bytes_used	Bytes usados de um determinado conjunto de memória JVM.	Gauge
pipeline_all_hung	Booleano que indica se todos os consumidores do pipeline estão travados.	Gauge
pipeline_cached_bytes	Total de bytes armazenados em cache.	Summary
pipeline_component_executions_total	O número total de execuções por componente.	Counter
pipeline_component_processi_latency_seconds	Latência de processamento de componentes em segundos.	Summary
pipeline_inflight	Número de pipelines atualmente em execução (em andamento).	Gauge
pipeline_inflight_reported_by_camel	Número de pipelines em execução (inflights) relatados pelo Camel.	Gauge
pipeline_jvm_memory_bytes_max	Máximo (bytes) de uma determinada área de memória JVM.	Gauge
pipeline_jvm_memory_bytes_used	Bytes usados de uma determinada área de memória JVM.	Gauge
pipeline_message_error_rate_in_sec	Taxa de erros de mensagens por segundos (número inteiro).	Gauge
pipeline_message_monitoring_processor_latency_seconds	Latência do processador de monitoramento de mensagens em segundos.	Summary
pipeline_message_processing_latency_seconds	Duração que uma mensagem é executada dentro de uma réplica (Pipeline response time).	Summary
pipeline_message_rate_in_sec	Taxa de mensagens por segundos (número inteiro).	Gauge
pipeline_message_size_bytes	Tamanho da mensagem em bytes.	Summary
pipeline_process_cpu_seconds_total	Tempo total de CPU do usuário e do sistema gasto em segundos.	Counter
pipeline_redeliveries	Número total de mensagens reenviadas.	Counter
rabbitmq_queue_messages	Número de mensagens da fila em um determinado intervalo de tempo.	Gauge

Métricas de VPN

Nome da métrica	Descrição	Tipo
ipsec_tunnel_bytes_in	Quantidade total de dados recebidos pelo túnel em bytes.	Counter
ipsec_tunnel_bytes_out	Quantidade total de dados enviados pelo túnel em bytes.	Counter
ipsec_tunnel_nat_status	Indica o status do Network Address Translation (NAT).	Gauge
ipsec_tunnel_status	Status atual do túnel (ativo ou inativo).	Gauge
ipsec_tunnel_status_last_run	Data/hora da última execução da verificação de status do túnel.	Counter
ipsec_tunnel_vpncheck_status	Indica o status do serviço que coleta métricas de VPN.	Gauge