Caché HTTP de Varnish

La integración con Varnish recopila métricas de caché y sesión. Supervisa la cantidad de objetos que ingresan y salen de la caché, así como la cantidad de sesiones y conexiones de backend. La integración también recopila registros de Varnish y los analiza en una carga útil JSON estandarizada.

Para obtener más información sobre Varnish, consulta la documentación de caché HTTP de Varnish.

Requisitos previos

Para recopilar la telemetría de Varnish, debes instalar el agente de operaciones:

Para las métricas, instala la versión 2.15.0 o una posterior.
Para los registros, instala la versión 2.16.0 o una posterior.

Esta integración es compatible con las versiones 6.x y 7.0.x de Varnish.

Configura tu instancia de Varnish

El procesador de registros Varnish procesa los registros a través de varnishncsa. Varnish puede habilitar el registro de varnishncsa a través de esta guía, según el sistema operativo.

De forma predeterminada, los registros se escriben en /var/log/varnish/varnishncsa.log. Si eliges otro destino, debes actualizar la configuración del receptor. Se espera que los registros tengan el formato predeterminado, y que se deba configurar una rotación del registro.

Configura el agente de operaciones para Varnish

A través de la guía Configura el agente de operaciones, agrega los elementos necesarios para recopilar telemetría de instancias de Varnish y reinicia el agente.

Configuración de ejemplo

El siguiente comando crea la configuración para recopilar y transferir la telemetría de Varnish y reinicia el agente de operaciones en 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

Configura la recopilación de registros

Para transferir registros desde Varnish, debes crear receptores para los registros que produce Varnish y, luego, crear una canalización para los receptores nuevos.

Para configurar un receptor para tus registros varnish, especifica los siguientes campos:

Campo	Predeterminada	Descripción
`exclude_paths`		Una lista de patrones de ruta de acceso del sistema de archivos que se excluirán del conjunto que coincida con include_paths.
`include_paths`	`[/var/log/varnish/varnishncsa.log]`	Una ruta de acceso predeterminada de varnishncsa para leer a través de la visualización del final de cada archivo.
`record_log_file_path`	`false`	Si se configura como `true`, la ruta al archivo específico desde el que se obtuvo el registro aparece en la entrada de registro de salida como el valor de la etiqueta `agent.googleapis.com/log_file_path`. Cuando se usa un comodín, solo se registra la ruta de acceso del archivo del que se obtuvo el registro.
`type`		Este valor debe ser `varnish`.
`wildcard_refresh_interval`	`60s`	El intervalo en el que se actualizan las rutas de acceso de archivos comodín en include_paths. Se expresa como una duración, por ejemplo, 30 s o 2 min. Esta propiedad puede ser útil en el caso de una capacidad de procesamiento de registro alta en la que los archivos de registro se rotan más rápido que el intervalo predeterminado.

¿Qué se registra?

logName se deriva de los ID de receptor especificados en la configuración. Los campos detallados dentro de LogEntry son los siguientes.

Los registros varnish contienen los siguientes campos en el LogEntry:

Campo	Tipo	Descripción
`httpRequest`	objeto	Consulta `HttpRequest`
`jsonPayload.host`	string	Contenido del encabezado del host
`jsonPayload.user`	string	Nombre de usuario autenticado para la solicitud
`severity`	string (`LogSeverity`)	Nivel de entrada de registro (traducido).

Configura la recopilación de métricas

Para transferir métricas desde Varnish, debes crear un receptor para las métricas que produce Varnish y, luego, crear una canalización destinada al receptor nuevo.

Este receptor no admite el uso de varias instancias en la configuración, por ejemplo, para supervisar varios extremos. Todas estas instancias escriben en las mismas series temporales, y Cloud Monitoring no tiene forma de distinguirlas.

Para configurar un receptor para las métricas de varnish, especifica los siguientes campos:

Campo	Predeterminada	Descripción
`cache_dir`		Esto especifica el nombre de la instancia de directorio de caché que se usará cuando se recopilen métricas. Si no se especifica, el valor predeterminado es el host.
`collection_interval`	60 s	Un valor `time.Duration`, como `30s` o `5m`
`exec_dir`		El directorio en el que se encuentran los ejecutables `varnishadm` y `varnishstat`. Si no se proporciona, se usa la configuración `PATH` del usuario.
`type`		Este valor debe ser `varnish`.

Qué se supervisa

En la siguiente tabla, se proporciona una lista de métricas que el agente de operaciones recopila de la instancia Varnish.

Tipo de métrica
Categoría, tipo Recursos supervisados	Etiquetas
`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`

Verifica la configuración

En esta sección, se describe cómo verificar de forma correcta que hayas configurado el receptor de Varnish. El agente de operaciones puede tardar uno o dos minutos en comenzar a recopilar telemetría.

Para verificar que los registros de Varnish se envíen a Cloud Logging, haz lo siguiente:

En el panel de navegación de la consola de Google Cloud, selecciona Logging y, luego, Explorador de registros:
Ir al Explorador de registros
Ingresa la siguiente consulta en el editor y, luego, haz clic en Ejecutar consulta:
```
resource.type="gce_instance"
log_id("varnish")
```

Para verificar que las métricas de Varnish se envíen a Cloud Monitoring, haz lo siguiente:

En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego, Explorador de métricas:
Ir al Explorador de métricas
En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre sea MQL o PromQL.
Verifica que MQL esté seleccionado en el botón de activación Lenguaje. El botón de activación de lenguaje se encuentra en la misma barra de herramientas que te permite dar formato a tu consulta.

Ingresa la siguiente consulta en el editor y, luego, haz clic en Ejecutar consulta:

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

Ver panel

Para ver tus métricas de Varnish, debes tener configurado un gráfico o un panel. La integración de Varnish incluye uno o más paneles. Cualquier panel se instala de forma automática después de que configuras la integración y de que el agente de operaciones comienza a recopilar datos de métricas.

También puedes ver vistas previas estáticas de los paneles sin instalar la integración.

Para ver un panel instalado, haz lo siguiente:

En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego, Paneles:
Dirígete a Paneles de control
Selecciona la pestaña Lista de paneles y, luego, la categoría Integraciones.
Haz clic en el nombre del panel que quiera ver.

Si configuraste una integración, pero el panel no se instaló, verifica que el agente de operaciones se esté ejecutando. Cuando no hay datos de métricas para un gráfico en el panel, la instalación del panel falla. Una vez que el agente de operaciones comienza a recopilar métricas, el panel se instalará por ti.

Para obtener una vista previa estática del panel, haz lo siguiente:

En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego, Integraciones:
Dirígete a Integraciones
Haz clic en el filtro de la plataforma de implementación Compute Engine.
Ubica la entrada para Varnish y haz clic en Ver detalles.
Selecciona la pestaña Paneles para ver una vista previa estática. Si el panel está instalado, haz clic en Ver panel para navegar a él.

Para obtener más información de los paneles en Cloud Monitoring, consulta Paneles y gráficos.

Para obtener más información del uso de la página Integraciones, consulta Administra integraciones.

Instala políticas de alertas

Las políticas de alertas le indican a Cloud Monitoring que te notifique cuando ocurren condiciones especificadas. La integración de Varnish incluye una o más políticas de alertas para que uses. Puedes ver y también instalar estas políticas de alertas desde la página Integraciones en Monitoring.

Para ver las descripciones de las políticas de alertas disponibles y, luego, instalarlas, haz lo siguiente:

En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego, Integraciones:
Dirígete a Integraciones
Ubica la entrada para Varnish y haz clic en Ver detalles.
Selecciona la pestaña Alertas. En esta pestaña, se proporcionan descripciones de las políticas de alertas disponibles y una interfaz para instalarlas.
Instala las políticas de alertas. Las políticas de alertas deben saber a dónde enviar notificaciones que la alerta se activó, por lo que requieren información de ti para la instalación. Para instalar las políticas de alertas, haz lo siguiente:
1. En la lista de políticas de alertas disponibles, elige las que deseas instalar.
2. En la sección Configura notificaciones, elige uno o más canales de notificaciones. Tienes la opción de inhabilitar el uso de los canales de notificación, pero si lo haces, las políticas de alertas se activarán de forma silenciosa. Puedes verificar su estado en Monitoring, pero no recibirás notificaciones.
  
  Para obtener más información de los canales de notificaciones, consulta Administra canales de notificaciones.
3. Haz clic en Crear políticas.

Para obtener más información de las políticas de alertas en Cloud Monitoring, consulta Introducción a las alertas.

Para obtener más información del uso de la página Integraciones, consulta Administra integraciones.

¿Qué sigue?

Para obtener una explicación sobre cómo usar Ansible para instalar el agente de operaciones, configurar una aplicación de terceros y, luego, instalar un panel de muestra, consulta el video Instala el agente de operaciones para solucionar problemas de apps de terceros.