Varnish HTTP Cache

A integração com o Varnish coleta as métricas do cache e da sessão. Ele monitora o número de objetos que entram e saem do cache, bem como o número de sessões e conexões de back-end. A integração também coleta registros do Varnish e os analisa em um payload JSON padronizado.

Para mais informações sobre o Varnish, consulte a documentação do cache HTTP do Varnish.

Pré-requisitos

Para coletar a telemetria do Varnish, é preciso instalar o agente de operações:

Para métricas, instale a versão 2.15.0 ou mais recente.
Para registros, instale a versão 2.16.0 ou posterior.

Essa integração é compatível com as versões 6.x e 7.0.x do Varnish.

Configurar a instância do Varnish

O processador de geração de registros Varnish processa os registros usando varnishncsa. Dependendo do sistema operacional, o Varnish pode ativar a geração de registros de varnishncsa neste guia.

Por padrão, os registros são gravados em /var/log/varnish/varnishncsa.log. Se você escolher outro destino, atualize a configuração do receptor. Espera-se que os registros estejam no formato padrão, e uma rotação de registros seja configurada.

Configurar o agente de operações para o Varnish

Seguindo o guia para configurar o agente de operações, adicione os elementos necessários para coletar a telemetria das instâncias do Varnish e reinicie o agente.

Exemplo de configuração

O comando a seguir cria a configuração para coletar e ingerir a telemetria do Varnish e reinicia o agente de operações no Linux.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish
logging:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish

EOF

sudo service google-cloud-ops-agent restart
sleep 30

Configurar a coleta de registros

Para ingerir registros do Varnish, é preciso criar receptores para os registros produzidos pelo Varnish e, em seguida, criar um pipeline para os novos receptores.

varnishPara configurar um receptor para os registros , especifique os seguintes campos:

Campo	Padrão	Descrição
`exclude_paths`		Uma lista de padrões de caminho do sistema de arquivos a serem excluídos do conjunto correspondido por include_paths.
`include_paths`	`[/var/log/varnish/varnishncsa.log]`	Um caminho de registro padrão varnishncsa para leitura de cada arquivo.
`record_log_file_path`	`false`	Se definido como `true`, o caminho para o arquivo específico de que a gravação de registro foi recebida aparecerá na entrada de registro de saída como o valor do rótulo `agent.googleapis.com/log_file_path`. Ao usar um caractere curinga, apenas o caminho do arquivo de que o registro foi recebido é gravado.
`type`		Este valor precisa ser `varnish`.
`wildcard_refresh_interval`	`60s`	O intervalo em que os caminhos de arquivos curinga em include_paths são atualizados. Dado como uma duração, por exemplo, 30s ou 2m. Essa propriedade pode ser útil com capacidades de registro altas em que os arquivos de registro são alternados mais rapidamente do que o intervalo padrão.

O que é registrado

O logName é derivado dos IDs do receptor especificados na configuração. Os campos detalhados dentro de LogEntry são os seguintes.

Os registros varnish contêm os seguintes campos no LogEntry:

Campo	Tipo	Descrição
`httpRequest`	objeto	Consulte `HttpRequest`
`jsonPayload.host`	string	Conteúdo do cabeçalho "Host"
`jsonPayload.user`	string	Nome de usuário autenticado da solicitação
`severity`	string (`LogSeverity`)	Nível de entrada de registro (traduzido).

Configurar a coleta de métricas

Para ingerir métricas do Varnish, crie um receptor para as métricas produzidas pelo Varnish e, em seguida, crie um pipeline para o novo receptor.

Esse receptor não aceita o uso de várias instâncias na configuração, por exemplo, para monitorar vários endpoints. Todas essas instâncias gravam na mesma série temporal, e o Cloud Monitoring não tem como diferenciá-las.

Para configurar um receptor para suas métricas do varnish, especifique os campos a seguir:

Campo	Padrão	Descrição
`cache_dir`		Especifica o nome da instância do dir do cache a ser usado ao coletar métricas. Se não for especificado, o padrão será o host.
`collection_interval`	60s	Um valor de `time.Duration`, como `30s` ou `5m`.
`exec_dir`		O diretório em que os executáveis `varnishadm` e `varnishstat` estão localizados. Se não for fornecida, a configuração `PATH` do usuário será usada.
`type`		Este valor precisa ser `varnish`.

O que é monitorado?

A tabela a seguir fornece a lista de métricas que o agente de operações coleta da instância do Varnish.

Tipo de métrica
Tipo, tipo Recursos monitorados	Rótulos
`workload.googleapis.com/varnish.backend.connection.count`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/varnish.backend.request.count`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/varnish.cache.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/varnish.client.request.count`
`CUMULATIVE`, `INT64` gce_instance	`state`
`workload.googleapis.com/varnish.client.request.error.count`
`CUMULATIVE`, `INT64` gce_instance	`status_code`
`workload.googleapis.com/varnish.object.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/varnish.object.expired`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/varnish.object.moved`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/varnish.object.nuked`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/varnish.session.count`
`CUMULATIVE`, `INT64` gce_instance	`kind`
`workload.googleapis.com/varnish.thread.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`operation`

Verificar a configuração

Nesta seção, descrevemos como verificar se você configurou corretamente o receptor Varnish. Pode levar um ou dois minutos para que o agente de operações comece a coletar telemetria.

Para verificar se os registros do Varnish estão sendo enviados para o Cloud Logging, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Logging e, depois, Explorador de registros:
Acessar o Explorador de registros
Digite a consulta a seguir no Editor e clique em Executar consulta:
```
resource.type="gce_instance"
log_id("varnish")
```

Para verificar se as métricas do Varnish estão sendo enviadas para o Cloud Monitoring, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Metrics Explorer:
Acesse o Metrics explorer
Na barra de ferramentas do painel do criador de consultas, selecione o botão MQL ou PromQL.
Verifique se MQL está selecionado na opção de ativar/desativar Idioma. A alternância de idiomas está na mesma barra de ferramentas que permite formatar sua consulta.

Digite a consulta a seguir no Editor e clique em Executar consulta:

fetch gce_instance
| metric 'workload.googleapis.com/varnish.backend.connection.count'
| every 1m

Ver painel

Para visualizar as métricas do Varnish, é necessário ter um gráfico ou um painel configurado. A integração do Varnish inclui um ou mais painéis para você. Todos os painéis são instalados automaticamente depois que você configura a integração e o Agente de operações começa a coletar dados de métricas.

Também é possível ver visualizações estáticas de painéis sem instalar a integração.

Para ver um painel instalado, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Painéis:
Ir para Painéis
Selecione a guia Lista de painéis e escolha a categoria Integrações.
Clique no nome do painel que você quer visualizar.

Se você configurou uma integração, mas o painel não foi instalado, verifique se o agente de operações está em execução. Quando não há dados de métricas para um gráfico no painel, a instalação do painel falha. Depois que o Agente de operações começar a coletar métricas, o painel será instalado para você.

Para acessar uma visualização estática do painel, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Integrações:
Acessar Integrações
Clique no filtro de plataforma de implantação do Compute Engine.
Localize a entrada do Varnish e clique em Ver detalhes.
Selecione a guia Painéis para uma visualização estática. Se o painel estiver instalado, navegue até ele clicando em Ver painel.

Para mais informações sobre painéis no Cloud Monitoring, consulte Painéis e gráficos.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

Instalar políticas de alertas

As políticas de alertas orientam o Cloud Monitoring a notificar você quando ocorrerem condições especificadas. A integração do Varnish inclui uma ou mais políticas de alertas para você usar. É possível ver e instalar essas políticas de alertas na página Integrações no Monitoring.

Para visualizar e descrever as descrições de políticas de alertas disponíveis, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Integrações:
Acessar Integrações
Localize a entrada do Varnish e clique em Ver detalhes.
Selecione a guia Alertas. Essa guia apresenta descrições das políticas de alertas disponíveis e mostra uma interface para instalá-las.
Instalar políticas de alertas. As políticas de alertas precisam saber para onde enviar as notificações de que o alerta foi acionado. Portanto, elas exigem informações para instalação. Para instalar políticas de alertas, faça o seguinte:
1. Na lista de políticas de alertas disponíveis, selecione aquelas que você quer instalar.
2. Na seção Configurar notificações, selecione um ou mais canais de notificação. Você pode desativar o uso dos canais de notificação, mas, se isso acontecer, as políticas de alertas vão ser disparadas silenciosamente. É possível verificar o status no Monitoring, mas não receber notificações.
  
  Para saber mais sobre canais de notificação, consulte Gerenciar canais de notificação.
3. Clique em Criar políticas.

Para mais informações sobre políticas de alertas no Cloud Monitoring, consulte Introdução a alertas.

Para mais informações sobre como usar a página Integrações, consulte Gerenciar integrações.

A seguir

Para ver um tutorial sobre como usar o Ansible para instalar o agente de operações, configurar um aplicativo de terceiros e instalar um painel de amostra, consulte o vídeo Instalação do agente de operações para resolver problemas de aplicativos de terceiros.