Visualização de métricas personalizadas de statsd com o Amazon Managed Service for Prometheus e o Amazon Managed Grafana

curl -sOL https://github.com/prometheus/statsd_exporter/releases/download/v0.22.4/statsd_exporter-0.22.4.linux-amd64.tar.gz
tar -xvf statsd_exporter-0.22.4.linux-amd64.tar.gz

Configurar statsd_exporter

O  statsd_exporter pode ser configurado para traduzir métricas statsd específicas separadas por pontos em métricas rotuladas do Prometheus por meio de uma linguagem de mapeamento simples. Esse mapeamento é salvo em um arquivo YAML e usado para iniciar o statsd_exporter.

1. Abra um novo arquivo chamado statsd-mapping-config.yaml na pasta statsd_exporter-0.22.4.linux-amd64.
2. Copie e cole o seguinte em statsd-mapping-config.yaml

mappings:
- match: "api.*.*.*"
  name: "api_metrics"
  labels:
    path: "$1"
    method: "$2"
    status: "$3"

Esse arquivo de mapeamento pegará uma métrica chamada, por exemplo, api.hello.get.200 e a transformará no formato Prometheus como api_metrics{path=hello,method=GET,status=200}. A métrica api.hello.GET.200 será gerada pela aplicação NodeJS que tem um cliente statsd.

Lance o Amazon Managed Service para o workspace do Prometheus

1. Crie o workspace do Amazon Managed Service for Prometheus, conforme descrito aqui.
2. Copie o ID do workspace criado conforme descrito aqui. Esse ID do workspace será usado na seção para configurar o servidor Prometheus.
3. Crie uma função do IAM com a política AmazonPrometheusRemoteWriteAccess e anexe essa função à instância do Amazon EC2.
4. Adicione o seguinte ao arquivo YAML chamado statsd-prometheus.yaml e faça o upload para o workspace criado. Isso gerará um valor médio de invocações de API em 5 minutos com base no caminho e no código de status.

groups:
  - name: statsd
    rules:
    - record: metric:api_metrics
      expr: sum(rate(api_metrics[5m])) by (path, status)

Instale o servidor Prometheus

1. Abra uma nova janela do terminal.
2. Conecte-se à sua instância Linux usando o Session Manager.
3. Execute os seguintes comandos para instalar o servidor Prometheus.

export PROMETHEUS_VERSION=2.34.0
curl -OL https://github.com/prometheus/prometheus/releases/download/v${PROMETHEUS_VERSION}-rc.0/prometheus-${PROMETHEUS_VERSION}-rc.0.linux-amd64.tar.gz
tar xvzf prometheus-${PROMETHEUS_VERSION}-rc.0.linux-amd64.tar.gz
export PATH=$PATH:$HOME/prometheus-${PROMETHEUS_VERSION}-rc.0.linux-amd64

Configurar o servidor Prometheus

1. Crie um arquivo de configuração chamado prometheus.yaml usando o conteúdo a seguir. Altere regionID conforme aplicável. Altere o WorkspaceID pelo ID do workspace na seção sobre o lançamento do workspace do Amazon Managed Service for Prometheus.

global:
  scrape_interval: 15s
  external_labels:
    monitor: 'statsd_exporter'
scrape_configs:
  - job_name: 'statsd_exporter'
    static_configs:
      - targets: ['localhost:9102']
remote_write:
  -
    url: https://aps-workspaces.<regionId>.amazonaws.com/workspaces/<workspace Id>/api/v1/remote_write
    queue_config:
        max_samples_per_send: 1000
        max_shards: 200
        capacity: 2500
    sigv4:
        region: <regionId>

Inicie o servidor Prometheus

1. Abra uma nova janela do terminal.
2. Conecte-se à sua instância Linux usando o Session Manager.
3. Inicie o servidor Prometheus com o arquivo de configuração prometheus.yaml criado anteriormente usando os seguintes comandos.

export PROMETHEUS_VERSION=2.34.0
export PATH=$PATH:$HOME/prometheus-${PROMETHEUS_VERSION}-rc.0.linux-amd64
prometheus --config.file=prometheus.yaml 

O console deve mostrar uma saída semelhante a esta para indicar que o Amazon Managed Service for Prometheus foi conectado com sucesso pelo servidor Prometheus:

ts=2022-03-04T01:12:25.394Z caller=dedupe.go:112 component=remote level=info remote_name=4b1ae2 url=https://aps-workspaces.regionId.amazonaws.com/workspaces/workspaceId/api/v1/remote_write msg="Starting WAL watcher" queue=4b1ae2
ts=2022-03-04T01:12:25.394Z caller=dedupe.go:112 component=remote level=info remote_name=4b1ae2 url=https://aps-workspaces.regionId.amazonaws.com/workspaces/workspaceId/api/v1/remote_write msg="Starting scraped metadata watcher"
ts=2022-03-04T01:12:25.394Z caller=dedupe.go:112 component=remote level=info remote_name=4b1ae2 url=https://aps-workspaces.regionId.amazonaws.com/workspaces/workspaceId/api/v1/remote_write msg="Replaying WAL" queue=4b1ae2

Inicie um aplicativo NodeJS instrumentado com o cliente statsd

1. Abra uma nova janela do terminal
2. Conecte-se à sua instância Linux usando o Session Manager.
3. Execute os seguintes comandos para criar uma pasta e inicializar:

mkdir app
npm init -y
npm i express node-statsd --save

4. Abra um novo arquivo chamado index.js e cole o seguinte:

const express = require('express')
const StatsD = require('node-statsd')
const statsdClient = new StatsD()
const app = express()
const port = 4000
let incrVar
app.get('/hello', (req, res) => {
  incrVar = `${req.path}.${req.method}.200`
  incrVar = `api.${incrVar.substring(1)}`
  statsdClient.increment(incrVar)
  res.status(200).send('Hello World!')
})
app.use('/', (req, res) => {
  incrVar = `${req.path}.${req.method}.404`
  incrVar = `api.${incrVar.substring(1)}`
  statsdClient.increment(incrVar)
  res.status(404).send('Not found.')
})
app.listen(port, () => {
  console.log(`Example app listening on port ${port}`)
})

Este aplicativo NodeJS expõe um endpoint /hello baseado em ExpressJS na porta 4000 para o GET. Esse endpoint responde com um texto simples “Hello World!” com o código de status 200. Invocar qualquer outro endpoint resultará em uma resposta como “Não encontrado” com um código de status como 404.

Essa aplicação usa o pacote node-statsd para implementar o cliente statsd. A métrica emitida terá o nome de formato api. <requestPath>. <requestMethod>. <statusCode>onde, o requestPath é o endpoint invocado, o requestMethod é o método HTTP e o StatusCode é configurado na resposta. O valor dessa métrica é um contador monotonicamente crescente para rastrear o número de invocações. Por exemplo, quando /hello é invocado com GET, uma métrica será emitida como api.hello.get.200 com o valor incrementado em 1.

Inicie o workspace do Grafana

1. Crie um workspace conforme descrito aqui.
2. Defina o acesso do usuário conforme descrito aqui.

Adicionar fonte de dados Prometheus

1. Adicione a fonte de dados do Amazon Managed Service for Prometheus conforme descrito aqui.

Criar painel

1. Crie um novo painel com a opção Importar conforme descrito aqui.
2. Faça o upload do seguinte documento JSON:

{"__inputs":[],"__requires":[{"type":"grafana","id":"grafana","name":"Grafana","version":"8.2.5"},{"type":"panel","id":"timeseries","name":"Time series","version":""}],"annotations":{"list":[{"builtIn":1,"datasource":"-- Grafana --","enable":true,"hide":true,"iconColor":"rgba(0, 211, 255, 1)","name":"Annotations & Alerts","target":{"limit":100,"matchAny":false,"tags":[],"type":"dashboard"},"type":"dashboard"}]},"editable":true,"fiscalYearStartMonth":0,"gnetId":null,"graphTooltip":0,"id":null,"links":[],"liveNow":true,"panels":[{"datasource":null,"fieldConfig":{"defaults":{"color":{"mode":"palette-classic"},"custom":{"axisLabel":"","axisPlacement":"auto","barAlignment":0,"drawStyle":"line","fillOpacity":0,"gradientMode":"none","hideFrom":{"legend":false,"tooltip":false,"viz":false},"lineInterpolation":"smooth","lineWidth":1,"pointSize":5,"scaleDistribution":{"type":"linear"},"showPoints":"auto","spanNulls":false,"stacking":{"group":"A","mode":"none"},"thresholdsStyle":{"mode":"off"}},"mappings":[],"thresholds":{"mode":"absolute","steps":[{"color":"green","value":null},{"color":"red","value":80}]}},"overrides":[]},"gridPos":{"h":19,"w":24,"x":0,"y":0},"id":2,"options":{"legend":{"calcs":[],"displayMode":"list","placement":"bottom"},"tooltip":{"mode":"single"}},"targets":[{"exemplar":true,"expr":"metric:api_metrics","interval":"","legendFormat":"{{path}}-{{status}}","refId":"A"}],"title":"API metrics (rate)","type":"timeseries"}],"refresh":"","schemaVersion":32,"style":"dark","tags":[],"templating":{"list":[]},"time":{"from":"now-5m","to":"now"},"timepicker":{},"timezone":"browser","title":"statsd","uid":"5fn7dTY7z","version":9}

Instruções para o caso de uso do Repeater

Conforme discutido anteriormente, no caso de uso do Repeater,

1. O processo statsd é configurado com o backend do Repeater.
2. A aplicação não foi alterada.

As instruções a seguir configurarão o caso de uso do Repeater.

Configurar o processo statsd

O processo statsd deve ser reconfigurado com um back-end Repeater com os seguintes comandos:

1. Vá para o terminal em que o statsd é lançado.
2. Crie um arquivo chamado statsd-config.js e cole o seguinte.

{
 backends: [ "./backends/console", "./backends/repeater" ],
 repeater: [ { host: "localhost", port: 9125 } ]
}

O ./backends/console não é estritamente necessário. No entanto, o uso desse back-end mostrará as métricas no console. O Repeater aponta para o host e a porta do statsd_exporter em execução na mesma instância do Amazon EC2 com 9125 como número de porta padrão.

Iniciar o processo statsd

Inicie o processo statsd com o seguinte comando. Verifique se o caminho para  statsd-config.js foi fornecido corretamente.

node stats.js statsd-config.js

Inicie statsd_exporter

1. Vá para o terminal em que o statsd_exporter foi instalado.
2. Inicie-o com o seguinte comando. Verifique se o caminho para statsd-mapping-config.js foi fornecido corretamente.

./statsd_exporter --statsd.mapping-config=statsd-mapping-config.yaml

Simule solicitações HTTP

Execute os seguintes comandos em dois terminais diferentes para simular solicitações HTTP GET no endpoint /hello para gerar a métrica para o código de status 200 e o endpoint /bye para gerar a métrica para o código de status 404. Esses comandos serão executados por cinco minutos. A duração pode ser alterada definindo um valor diferente para o sinalizador -z.

1. Obtenha o endereço IP público da instância do Amazon EC2 em execução.
2. Habilite o tráfego TCP de entrada do seu endereço IP na porta 4000.

hey -z 5m http://ec2-public-ip:4000/hello
hey -z 5m http://ec2-public-ip:4000/bye

Exibir painel

1. Inicie o painel a partir do console Amazon Managed Grafana conforme descrito aqui.
2. O gráfico a seguir é visto. Observe a legenda no canto inferior esquerdo para ver as curvas correspondentes ao caminho e ao status da API.

Instruções para o caso de uso do Relay

Configurar aplicativo

1. Vá até o terminal em que a aplicação está sendo executado.
2. Pare a aplicação com Ctrl-C.
3. Edite index.js alterando a declaração de StatsdClient conforme mostrado a seguir:

const statsdClient = new StatsD({
  host: "localhost",
  port: 9125
})

Iniciar o processo statsd

1. Em geral, para usar o caso de uso do Relay, o processo statsd não exige uma alteração. No entanto, nesta postagem, a configuração foi alterada para adicionar um back-end Repeater que foi adicionado em uma seção anterior. É recomendável que o back-end do Repeater seja removido.

Vá até o terminal em que o processo statsd está sendo executado e edite statsd-config.js com o seguinte conteúdo:

{
 backends: [ "./backends/console" ]
}

Inicie statsd_exporter

1. Vá para o terminal em que o statsd_exporter foi instalado.
2. Inicie-o com o seguinte comando. Verifique se o caminho para statsd-mapping-config.js foi fornecido corretamente.

./statsd_exporter --statsd.mapping-config=statsd-mapping-config.yaml --statsd.relay.address=localhost:8125

Agora, o statsd_exporter está configurado para retransmitir estatísticas para o processo statsd.

Simule solicitações HTTP

Execute os seguintes comandos em dois terminais diferentes para simular solicitações HTTP GET no endpoint /hello para gerar a métrica para o código de status 200 e o endpoint /bye para gerar a métrica para o código de status 404. Esses comandos serão executados por cinco minutos. A duração pode ser alterada definindo um valor diferente para o sinalizador -z.

1. Obtenha o endereço IP público da instância do Amazon EC2 em execução.
2. Habilite o tráfego TCP de entrada do seu endereço IP na porta 4000.

hey -z 5m http://ec2-public-ip:4000/hello
hey -z 5m http://ec2-public-ip:4000/bye

Exibir painel

1. Inicie o painel a partir do console do Amazon Managed Service for Grafana clicando na URL do workspace Grafana.
2. O gráfico a seguir é visto. Observe a legenda no canto inferior esquerdo para ver as curvas correspondentes ao caminho e ao status da API.

Limpeza

Para evitar cobranças futuras, exclua os seguintes recursos:

1. Exclua o workspace do Grafana conforme descrito aqui.
2. Exclua o workspace do Prometheus conforme descrito aqui.
3. Encerre a instância do Amazon EC2 conforme descrito aqui.
4. Remova a política do IAM conforme descrito aqui.

Conclusão

Esta postagem descreve um meio de ingerir, consultar e visualizar métricas personalizadas de aplicativos coletados pelo processo statsd em execução em uma instância Linux do Amazon EC2 usando o Amazon Managed Service for Prometheus e o Amazon Managed Grafana. Dois cenários para usar stasd_exporter foram discutidos — Repeater e Relay — com base nas mudanças a serem feitas com o statsd ou com a aplicação. Dependendo dos requisitos, diferentes métricas personalizadas podem ser criadas, como latência HTTP ou outros valores do caminho da solicitação, parâmetros de consulta etc. Além disso, o Amazon Managed Service for Prometheus e o Amazon Managed Grafana podem ser configurados para gerar alertas conforme necessário.

Este artigo foi traduzido do Blog da AWS em Inglês.

Sobre o autor