Como configurar API de métricas Digibee com Prometheus

Aprenda como integrar API de métricas.

A funcionalidade de API de métricas com Prometheus está atualmente em fase beta. Entenda mais sobre o Programa Beta.

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 feature deve estar habilitada para seu realm.

• Nome de usuário e senha gerados pelo usuário na página Gerenciamento de API.

• Chave de API a ser gerada após configurar as credenciais de API mencionadas acima.

• 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:
    apikey:
      - {DIGIBEE_SERVICES_API_APIKEY}
  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	DIGIBEE_SERVICES_API_URL	URL gerado na página de Gerenciamento 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.

Visualizar seus dados no Prometheus com Grafana

Nome da métrica	Descrição	Tipo
jvm_memory_bytes_committed	Committed (bytes) of a given JVM memory area.	Gauge
jvm_memory_bytes_init	Initial bytes of a given JVM memory area.	Gauge
jvm_memory_bytes_max	Maximum (bytes) of a given JVM memory area.	Gauge
jvm_memory_bytes_used	Used bytes of a given JVM memory area.	Gauge
jvm_memory_pool_bytes_committed	Committed bytes of a given JVM memory pool.	Gauge
jvm_memory_pool_bytes_init	Initial bytes of a given JVM memory pool.	Gauge
jvm_memory_pool_bytes_max	Maximum bytes of a given JVM memory pool.	Gauge
jvm_memory_pool_bytes_used	Used bytes of a given JVM memory pool.	Gauge
pipeline_all_hung	Boolean indicating if all pipeline consumers are hung.	Gauge
pipeline_cached_bytes	Total cached bytes.	Summary
pipeline_component_executions_total	The total number of executions per component.	Counter
pipeline_component_processi_latency_seconds	Component processing latency in seconds.	Summary
pipeline_inflight	Number of currently running (inflight) pipelines.	Gauge
pipeline_inflight_reported_by_camel	Number of currently running (inflight) pipelines reported by Camel.	Gauge
pipeline_jvm_memory_bytes_max	Maximum (bytes) of a given JVM memory area.	Gauge
pipeline_jvm_memory_bytes_used	Used bytes of a given JVM memory area.	Gauge
pipeline_jvm_memory_bytes_used	Used bytes of a given JVM memory area.	Gauge
pipeline_message_error_rate_in_sec	Message error rate per seconds (integer number).	Gauge
pipeline_message_monitoring_processor_latency_seconds	Message monitoring processor latency in seconds.	Counter
pipeline_message_rate_in_sec	Message rate per seconds (integer number).	Gauge
pipeline_message_size_bytes	Message size in bytes.	Summary
pipeline_process_cpu_seconds_total	Total user and system CPU time spent in seconds.	Counter
pipeline_redeliveries	Total number of messages redelivered.	Counter