Monitorando aplicações PHP com Prometheus

Essa semana nosso time de desenvolvimento teve o desafio de buscar ferramentas para monitorar aplicações web, tendo uma visão completa tanto do host quanto dos containers. Além disso, tínhamos que centralizar a visualização de alguns dados da aplicação.

Depois de algumas pesquisas, encontrei esse repositório que me chamou bastante atenção. Trata-se de um conjunto de serviços para monitoramento e alerta. Tudo que precisávamos!

Serviços utilizados:

Prometheus – Repositório e Métricas
Grafana - Visualização
AlertManager - Gerenciador de Alertas
NodeExporter - Coleta de dados do Host
cAdvisor - Coleta de dados dos Containers

Em poucos minutos é possível visualizar os dados do seu host como estes abaixo. Lembrando que o projeto já inclui alguns dashboards bem completos, basta importá-los ao Grafana.

Centralização de informação

A melhor parte é que não ficamos presos a um único host, podendo distribuir os containers e ainda centralizar a visualização dos dados.

O Prometheus é o encarregado dessa mágica. Com ele é possível configurar Scrapers que ficarão observando a sua aplicação e coletando as métricas automaticamente.

scrape_configs:
  - job_name:       'example-random'

    # Override the global default and scrape targets from this job every 5 seconds.
    scrape_interval: 5s

    static_configs:
      - targets: ['localhost:8080', 'localhost:8081']
        labels:
          group: 'production'

      - targets: ['localhost:8082']
        labels:
          group: 'canary'

Enviando dados da aplicação

Para que o Prometheus consiga capturar corretamente os dados da sua aplicação é necessário que a saída seja formatada de uma maneira específica, e para isso temos diversos clients. No nosso caso, vou mostrar um pouco do Client PHP.

Abaixo, nós adicionamos algumas métricas sobre a aplicação:

$registry = PrometheusCollectorRegistry::getDefault();
 
$counter = $registry->getOrRegisterCounter('test', 'some_counter', 'it increases', ['type']);
$counter->incBy(3, ['blue']);
 
$gauge = $registry->getOrRegisterGauge('test', 'some_gauge', 'it sets', ['type']);
$gauge->set(2.5, ['blue']);
 
$histogram = $registry->getOrRegisterHistogram('test', 'some_histogram', 'it observes', ['type'], [0.1, 1, 2, 3.5, 4, 5, 6, 7, 8, 9]);
$histogram->observe(3.5, ['blue']);

E logo após, expomos esses dados para a coleta do Scraper

$registry = PrometheusCollectorRegistry::getDefault();
$registry = CollectorRegistry::getDefault();

$renderer = new RenderTextFormat();
$result = $renderer->render($registry->getMetricFamilySamples());

header('Content-type: ' . RenderTextFormat::MIME_TYPE);
echo $result;

Exporters

Para finalizar, podemos adicionar exporters para quase todos os tipos de serviços que utilizamos, desde dados de deploy do Jenkins, como dados de filas do RabbitMQ.

Basta conferir essa lista de exporters para entender as infinitas possibilidades de monitoramento dessa ferramenta.

Nós, da Kinghost, ficamos bem empolgados com esse potencial, e espero que seja útil para outros Devs também.

O AlertManager merece um capitulo só para ele, abordando configurações de saída e querys de alertas, então, aguardem o próximo artigo!