Nginx

La integración de NGINX recoge métricas de conexión y registros de acceso. Las métricas de conexión registran el estado actual de la conexión: activa, lectura o espera. Los registros de acceso se analizan para obtener los detalles de la conexión, que incluyen campos asignados a la solicitud, el cliente, el servidor y el mensaje.

Para obtener más información sobre nginx, consulta la documentación de nginx.

Requisitos previos

Para recoger la telemetría de nginx, debes instalar el Agente de operaciones:

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

Esta integración es compatible con las versiones 1.18 y 1.20 de nginx.

Configurar la instancia de nginx

Debes habilitar el módulo stub_status en el archivo de configuración de nginx para configurar una URL accesible localmente, por ejemplo, http://www.example.com/nginx_status para la página de estado. Para habilitar el módulo stub_status, sigue estos pasos:

  1. Edita el archivo status.conf o créalo si no existe. Puedes encontrar este archivo en el directorio de configuración de nginx, que suele estar en /etc/nginx/conf.d.

  2. Añade las siguientes líneas a la sección server:

    location /nginx_status {
    stub_status on;
    access_log off;
    allow 127.0.0.1;
    deny all;
}

    Tu archivo de configuración podría tener un aspecto similar al siguiente ejemplo:

    server {
   listen 80;
   server_name 127.0.0.1;
   location /nginx_status {
       stub_status on;
       access_log off;
       allow 127.0.0.1;
       deny all;
   }
   location / {
       root /dev/null;
   }
}

  3. Vuelve a cargar la configuración de nginx.

    sudo service nginx reload

Puedes ejecutar el siguiente comando para automatizar los pasos anteriores. Crea un archivo status.conf si no existe o sobrescribe el archivo si ya existe. El comando activa stub_status, vuelve a cargar nginx y verifica que la información esperada se exponga a través del endpoint.

sudo tee /etc/nginx/conf.d/status.conf > /dev/null << EOF
server {
    listen 80;
    server_name 127.0.0.1;
    location /nginx_status {
        stub_status on;
        access_log off;
        allow 127.0.0.1;
        deny all;
    }
    location / {
       root /dev/null;
    }
}
EOF
sudo service nginx reload
curl http://127.0.0.1:80/nginx_status

El resultado de ejemplo es el siguiente:

Active connections: 1
server accepts handled requests
 23 23 74
Reading: 0 Writing: 1 Waiting: 0

También puedes insertar las líneas directamente en el archivo nginx.conf principal, en lugar de usar un archivo status.conf independiente. Este archivo suele estar ubicado en uno de los siguientes directorios: /etc/nginx, /usr/local/nginx/conf o /usr/local/etc/nginx.

Configurar el agente de operaciones para nginx

Sigue la guía para configurar el agente de operaciones, añade los elementos necesarios para recoger telemetría de las instancias de nginx y reinicia el agente.

Configuración de ejemplo

Los siguientes comandos crean la configuración para recoger e ingerir telemetría de nginx:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# 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:
    nginx:
      type: nginx
      stub_status_url: http://127.0.0.1:80/nginx_status
  service:
    pipelines:
      nginx:
        receivers:
          - nginx
logging:
  receivers:
    nginx_access:
      type: nginx_access
    nginx_error:
      type: nginx_error
  service:
    pipelines:
      nginx:
        receivers:
          - nginx_access
          - nginx_error
EOF

Para que estos cambios se apliquen, debes reiniciar el agente de Ops:

Linux

  1. Para reiniciar el agente, ejecuta el siguiente comando en tu instancia: 
    sudo systemctl restart google-cloud-ops-agent
  2. Para confirmar que el agente se ha reiniciado, ejecuta el siguiente comando y verifica que los componentes "Metrics Agent" y "Logging Agent" se han iniciado: 
    sudo systemctl status "google-cloud-ops-agent*"

Windows

  1. Conéctate a tu instancia mediante RDP o una herramienta similar e inicia sesión en Windows.
  2. Abre un terminal de PowerShell con privilegios de administrador haciendo clic con el botón derecho en el icono de PowerShell y seleccionando Ejecutar como administrador.
  3. Para reiniciar el agente, ejecuta el siguiente comando de PowerShell: 
    Restart-Service google-cloud-ops-agent -Force
  4. Para confirmar que el agente se ha reiniciado, ejecuta el siguiente comando y verifica que los componentes "Metrics Agent" y "Logging Agent" se han iniciado: 
    Get-Service google-cloud-ops-agent*

Configurar la recogida de registros

Para ingerir registros de nginx, debe crear un receptor para los registros que genera nginx y, a continuación, crear una canalización para el nuevo receptor.

Para configurar un receptor de tus registros nginx_access, especifica los siguientes campos:

Campo Predeterminado Descripción
exclude_paths Lista de patrones de rutas del sistema de archivos que se excluirán del conjunto que coincida con include_paths.
include_paths [/var/log/nginx/access.log] Lista de rutas del sistema de archivos que se van a leer siguiendo cada archivo. Se puede usar un comodín (*) en las rutas.
record_log_file_path false Si se asigna el valor true, la ruta al archivo específico del que se ha obtenido el registro de log aparece en la entrada de log de salida como valor de la etiqueta agent.googleapis.com/log_file_path. Cuando se usa un comodín, solo se registra la ruta del archivo del que se ha obtenido el registro.
type Este valor debe ser nginx_access.
wildcard_refresh_interval 60s Intervalo en el que se actualizan las rutas de archivos con comodines en include_paths. Se indica como duración; por ejemplo, 30s o 2m. Esta propiedad puede ser útil cuando el volumen de registros es alto y los archivos de registro se rotan más rápido que el intervalo predeterminado.

Para configurar un receptor de tus registros nginx_error, especifica los siguientes campos:

Campo Predeterminado Descripción
exclude_paths Lista de patrones de rutas del sistema de archivos que se excluirán del conjunto que coincida con include_paths.
include_paths [/var/log/nginx/error.log] Lista de rutas del sistema de archivos que se van a leer siguiendo cada archivo. Se puede usar un comodín (*) en las rutas.
record_log_file_path false Si se asigna el valor true, la ruta al archivo específico del que se ha obtenido el registro de log aparece en la entrada de log de salida como valor de la etiqueta agent.googleapis.com/log_file_path. Cuando se usa un comodín, solo se registra la ruta del archivo del que se ha obtenido el registro.
type Este valor debe ser nginx_error.
wildcard_refresh_interval 60s Intervalo en el que se actualizan las rutas de archivos con comodines en include_paths. Se indica como duración; por ejemplo, 30s o 2m. Esta propiedad puede ser útil cuando el volumen de registros es alto y los archivos de registro se rotan más rápido que el intervalo predeterminado.

Qué se registra

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

Los registros de nginx_access contienen los siguientes campos en LogEntry:

Campo Tipo Descripción
httpRequest objeto Consulta HttpRequest.
jsonPayload.host cadena Contenido del encabezado Host (normalmente no lo comunica nginx)
jsonPayload.level cadena Nivel de entrada de registro
jsonPayload.user cadena Nombre de usuario autenticado de la solicitud
severity cadena (LogSeverity) Nivel de entrada de registro (traducido).

Los registros de nginx_error contienen los siguientes campos en LogEntry:

Campo Tipo Descripción
jsonPayload.client cadena Dirección IP del cliente (opcional)
jsonPayload.connection número ID de conexión
jsonPayload.host cadena Encabezado del host (opcional)
jsonPayload.level cadena Nivel de entrada de registro
jsonPayload.message cadena Mensaje de registro
jsonPayload.pid número ID del proceso que emite el registro.
jsonPayload.referer cadena Encabezado Referer (opcional)
jsonPayload.request cadena Solicitud HTTP original (opcional)
jsonPayload.server cadena Nombre del servidor Nginx (opcional)
jsonPayload.subrequest cadena Subpetición de Nginx (opcional)
jsonPayload.tid número ID de la conversación en la que se originó el registro.
jsonPayload.upstream cadena URI de solicitud upstream (opcional)
severity cadena (LogSeverity) Nivel de entrada de registro (traducido).

Configurar recogida de métricas

Para ingerir métricas de nginx, debe crear un receptor para las métricas que genera nginx y, a continuación, crear una canalización para el nuevo receptor.

Este receptor no admite el uso de varias instancias en la configuración, por ejemplo, para monitorizar varios endpoints. Todas estas instancias escriben en la misma serie temporal y Cloud Monitoring no tiene forma de distinguirlas.

Para configurar un receptor de sus métricas de nginx, especifique los siguientes campos:

Campo Predeterminado Descripción
collection_interval 60s Un valor de duración, como 30s o 5m.
server_status_url http://localhost/status La URL expuesta por el módulo de estado de stub de nginx.
type Este valor debe ser nginx.

Qué se monitoriza

En la siguiente tabla se muestra la lista de métricas que recoge el agente de Ops de la instancia de nginx.

Tipo de métrica 
Tipo
Recursos monitorizados		 Etiquetas
workload.googleapis.com/nginx.connections_accepted
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/nginx.connections_current
GAUGE, INT64
gce_instance 		state
workload.googleapis.com/nginx.connections_handled
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/nginx.requests
CUMULATIVE, INT64
gce_instance 		 

Verificar la configuración

En esta sección se describe cómo verificar que ha configurado correctamente el receptor nginx. El agente de Ops puede tardar uno o dos minutos en empezar a recoger datos de telemetría.

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

  1. En la Google Cloud consola, ve a la página Explorador de registros:

    Ve al Explorador de registros.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Registro.

  2. Introduce la siguiente consulta en el editor y haz clic en Ejecutar consulta: 
    resource.type="gce_instance"
(log_id("nginx_access") OR log_id("nginx_error"))

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

  1. En la Google Cloud consola, ve a la página  Explorador de métricas:

    Ve al explorador de métricas.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas del panel de creación de consultas, selecciona el botón cuyo nombre sea  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el interruptor Idioma. El interruptor de idioma se encuentra en la misma barra de herramientas que te permite dar formato a tu consulta.
  4. Introduce la siguiente consulta en el editor y haz clic en Ejecutar consulta: 
    {"workload.googleapis.com/nginx.requests", monitored_resource="gce_instance"}

Ver panel de control

Para ver las métricas de nginx, debe tener configurado un gráfico o un panel de control. La integración de nginx incluye uno o varios paneles de control. Los paneles de control se instalan automáticamente después de configurar la integración y cuando el agente de Ops ha empezado a recoger datos de métricas.

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

Para ver un panel de control instalado, siga estos pasos:

  1. En la Google Cloud consola, ve a la página  Paneles de control:

    Ve a Paneles.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. Seleccione la pestaña Lista de paneles de control y, a continuación, elija la categoría Integraciones.
  3. Haga clic en el nombre del panel de control que quiera ver.

Si has configurado una integración, pero el panel de control no se ha instalado, comprueba que el agente de operaciones se esté ejecutando. Si no hay datos de métricas para un gráfico del panel de control, no se podrá instalar el panel. Una vez que el agente de Ops empiece a recoger métricas, se instalará el panel de control.

Para ver una vista previa estática del panel de control, siga estos pasos:

  1. En la Google Cloud consola, ve a la página  Integraciones:

    Ve a Integraciones.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. Haz clic en el filtro de plataforma de implementación Compute Engine.
  3. Busca la entrada de nginx y haz clic en Ver detalles.
  4. Seleccione la pestaña Paneles para ver una vista previa estática. Si el panel de control está instalado, puedes acceder a él haciendo clic en Ver panel de control.

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

Para obtener más información sobre cómo usar la página Integraciones, consulta el artículo Gestionar integraciones.

Instalar políticas de alertas

Las políticas de alertas indican a Cloud Monitoring que te envíe una notificación cuando se produzcan las condiciones especificadas. La integración de nginx incluye una o varias políticas de alertas que puedes usar. Puedes ver e instalar estas políticas de alertas desde la página Integraciones de Monitoring.

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

  1. En la Google Cloud consola, ve a la página  Integraciones:

    Ve a Integraciones.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. Busca la entrada de nginx y haz clic en Ver detalles.
  3. Selecciona la pestaña Alertas. En esta pestaña se ofrecen descripciones de las políticas de alertas disponibles y se proporciona una interfaz para instalarlas.
  4. Instala las políticas de alertas. Las políticas de alertas necesitan saber dónde enviar las notificaciones de que se ha activado una alerta, por lo que requieren información para la instalación. Para instalar políticas de alertas, haz lo siguiente:
    1. En la lista de políticas de alertas disponibles, selecciona las que quieras instalar.

    2. En la sección Configurar notificaciones, selecciona uno o varios canales de notificación. Puedes inhabilitar el uso de canales de notificación, pero si lo haces, tus políticas de alertas se activarán de forma silenciosa. Puedes consultar su estado en Monitorización, pero no recibirás ninguna notificación.

      Para obtener más información sobre los canales de notificación, consulta el artículo Gestionar canales de notificación.

    3. Haz clic en Crear políticas.

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

Para obtener más información sobre cómo usar la página Integraciones, consulta el artículo Gestionar integraciones.

Solución de problemas

En la mayoría de las distribuciones, nginx viene con ngx_http_stub_status_module habilitado. Para comprobar si el módulo está habilitado, ejecuta el siguiente comando:

sudo nginx -V 2>&1 | grep -o with-http_stub_status_module

El resultado esperado es with-http_stub_status_module, lo que significa que el módulo está habilitado. En casos excepcionales, si el comando no devuelve ningún resultado, debes compilar nginx desde la fuente con -with-http_stub_status_module siguiendo la documentación pública de nginx.

Siguientes pasos

Para ver una guía sobre cómo usar Ansible para instalar el Agente de operaciones, configurar una aplicación de terceros e instalar un panel de control de ejemplo, consulta el vídeo Instalar el Agente de operaciones para solucionar problemas con aplicaciones de terceros.