Hands-on 6 — Observabilidade

Uma requisição está lenta. Onde?

• Sem dados de dentro de cada serviço, você só pode chutar.
• Você precisa de métricas ao longo do tempo: taxa de requisições, latências, taxa de erros, memória da JVM.
• E elas precisam ser coletadas de todos os serviços, em um só lugar.

Os três pilares

Arquitetura

gateway, auth, account ← scrape ← Prometheus → Grafana

A camada de observabilidade fica ao lado da camada confiável; os clientes continuam entrando pelo balanceador de carga na porta 80.

Os passos

1. Microsserviços — adicionar as dependências do Actuator e do registry do Prometheus, expor o endpoint.
2. Docker Compose — adicionar os serviços prometheus e grafana.
3. Prometheus — prometheus.yml com um job de scrape por serviço.
4. Grafana — provisionar o Prometheus como fonte de dados, importar um dashboard.
5. Executar — reconstruir a stack e conferir se todos os alvos estão UP.

1 · Dependências (em cada serviço)

No pom.xml de gateway-service, auth-service e account-service:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-registry-prometheus</artifactId>
    <scope>runtime</scope>
</dependency>

Actuator: endpoints prontos para produção (health, métricas). Registry do Micrometer: exporta-os no formato de texto do Prometheus.

1 · Expor o endpoint

# gateway-service application.yaml
management:
  endpoints:
    web:
      base-path: /gateway/actuator
      exposure:
        include: ['prometheus']

• Cada serviço usa o seu próprio prefixo: sem conflitos e sem expor portas internas.
• O gateway também define spring.cloud.gateway.metrics.enabled: true.

3 · O Prometheus coleta (pull)

setup/prometheus/prometheus.yml — um job por serviço:

scrape_configs:
  - job_name: 'GatewayMetrics'
    metrics_path: '/gateway/actuator/prometheus'
    scrape_interval: 1s
    static_configs:
      - targets:
        - gateway:8080
        labels:
          application: 'Gateway Application'

O mesmo para AuthMetrics (auth:8080) e AccountMetrics (account:8080).

Os campos que importam

4 · Fonte de dados do Grafana

setup/grafana/provisioning/datasources/datasources.yml:

apiVersion: 1
datasources:
  - name: Prometheus
    type: prometheus
    uid: prometheus
    access: proxy
    url: http://prometheus:9090
    isDefault: true

Carregada automaticamente na inicialização — sem configuração manual. Abra http://localhost:3000, login admin / admin.

4 · Dashboards

• Importe um pronto: Dashboards → Import, ID 4701 (JVM (Micrometer)) ou 12900 (SpringBoot APM).
• Selecione a fonte de dados do Prometheus provisionada.
• Painéis vazios? Dashboard → Edit → Settings → Variables: crie DS_PROMETHEUS, tipo Constant, valor prometheus (o uid em datasources.yml).
• Depois, acompanhe taxa de requisições, memória da JVM, latências e taxa de erros.

Mais dashboards em grafana.com/grafana/dashboards.

5 · Executar e verificar

docker compose up -d --build
docker compose ps -a

• Todos os containers, inclusive prometheus e grafana, devem estar running.
• Interface do Prometheus http://localhost:9090 → Status → Targets: gateway, auth e account todos UP.
• Grafana: importe um dashboard e veja os painéis se preencherem.

Armadilhas comuns

• prometheus não sobe → confira se setup/prometheus/prometheus.yml existe e é um YAML válido.
• Os alvos devem usar os hostnames Docker, não localhost (dentro de um container, é o próprio container).
• Dashboard vazio → a variável DS_PROMETHEUS não aponta para a fonte de dados prometheus.
• Só prometheus está em exposure.include: os demais endpoints do Actuator continuam fechados.

Pontos-chave

1. A observabilidade tem três pilares: logging, monitoramento, rastreamento — aqui, monitoramento.
2. Actuator + Micrometer transformam cada serviço Spring Boot em um endpoint de métricas.
3. Cada serviço expõe /<context>/actuator/prometheus sob o seu próprio prefixo.
4. O Prometheus puxa as métricas periodicamente (scrape_interval), um job por serviço.
5. O Grafana lê o Prometheus por uma fonte de dados provisionada e dashboards prontos.
6. Verifique em Status → Targets: todos os serviços devem estar UP.