Monitoramento & Alertas

Recomendamos o uso de ferramentas de monitoramento como o Prometheus para monitorar os processos e filas de trabalhos em seu ambiente de produção.

Métricas de Fila

Se estiver utilizando a Interface Web, você pode habilitar a integração com o Prometheus fornecendo dois parâmetros:

• --enable-metrics-exporter: Habilita a coleta de métricas da fila e as exporta para o endpoint /metrics.
• --prometheus-addr: Habilita a visualização das métricas da fila na Interface Web.

A página de métricas da fila parece com esta:

Se não estiver utilizando a Interface Web, o Asynq vem com um arquivo binário que pode ser executado para exportar métricas da fila. Também inclui um pacote x/metrics para coletar métricas da fila.

Métricas de Processo de Trabalho

A interface Handler e ServeMux do Asynq podem ser instrumentadas com métricas para observabilidade.

Aqui está um exemplo de exportação de métricas do processo de trabalho utilizando o Prometheus. Podemos instrumentar nosso código dentro da aplicação para rastrear métricas específicas da aplicação, bem como métricas padrão (como memória e CPU) rastreadas pelo Prometheus.

Aqui está uma lista de métricas específicas da aplicação rastreadas no código de exemplo:

• O número total de tarefas processadas pelo processo de trabalho (incluindo tarefas bem-sucedidas e falhadas).
• O número de tarefas falhadas processadas pelo processo de trabalho.
• O número atual de tarefas em processamento pelo processo de trabalho.

package main

import (
    "context"
    "log"
    "net/http"
    "os"
    "os/signal"
    "runtime"

    "github.com/hibiken/asynq"
    "github.com/hibiken/asynq/examples/tasks"
    "github.com/prometheus/client_golang/prometheus"
    "github.com/prometheus/client_golang/prometheus/promauto"
    "github.com/prometheus/client_golang/prometheus/promhttp"
    "golang.org/x/sys/unix"
)

// Variáveis de Métrica.
var (
    processedCounter = promauto.NewCounterVec(
        prometheus.CounterOpts{
            Name: "processed_tasks_total",
            Help: "Número total de tarefas processadas",
        },
        []string{"task_type"},
    )

    failedCounter = promauto.NewCounterVec(
        prometheus.CounterOpts{
            Name: "failed_tasks_total",
            Help: "Número total de tarefas falhadas processadas",
        },
        []string{"task_type"},
    )

    inProgressGauge = promauto.NewGaugeVec(
        prometheus.GaugeOpts{
            Name: "in_progress_tasks",
            Help: "Número atual de tarefas sendo processadas",
        },
        []string{"task_type"},
    )
)

func metricsMiddleware(next asynq.Handler) asynq.Handler {
    return asynq.HandlerFunc(func(ctx context.Context, t *asynq.Task) error {
        inProgressGauge.WithLabelValues(t.Type()).Inc()
        err := next.ProcessTask(ctx, t)
        inProgressGauge.WithLabelValues(t.Type()).Dec()
        if err != nil {
            failedCounter.WithLabelValues(t.Type()).Inc()
        }
        processedCounter.WithLabelValues(t.Type()).Inc()
        return err
    })
}

func main() {
    httpServeMux := http.NewServeMux()
    httpServeMux.Handle("/metrics", promhttp.Handler())
    metricsSrv := &http.Server{
        Addr:    ":2112",
        Handler: httpServeMux,
    }
    done := make(chan struct{})

    // Iniciar o servidor de métricas.
    go func() {
        err := metricsSrv.ListenAndServe()
        if err != nil && err != http.ErrServerClosed {
            log.Printf("Erro: servidor de métricas com erro: %v", err)
        }
        close(done)
    }()

    srv := asynq.NewServer(
        asynq.RedisClientOpt{Addr: ":6379"},
        asynq.Config{Concurrency: 20},
    )

    mux := asynq.NewServeMux()
    mux.Use(metricsMiddleware)
    mux.HandleFunc(tasks.TypeEmail, tasks.HandleEmailTask)

    // Iniciar o servidor do trabalhador.
    if err := srv.Start(mux); err != nil {
        log.Fatalf("Falha ao iniciar o servidor de trabalhador: %v", err)
    }

    // Aguardar sinais de término.
    sigs := make(chan os.Signal, 1)
    signal.Notify(sigs, unix.SIGTERM, unix.SIGINT)
}