Esta página se ha traducido con Cloud Translation API.

MongoDB

La integración de MongoDB recoge principalmente métricas de bases de datos, como el número de operaciones y objetos, así como el uso de recursos. La integración también recoge registros y los analiza para convertirlos en una carga útil de JSON. El resultado incluye campos para el contexto, el componente, el nivel y el mensaje.

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

Requisitos previos

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

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

Esta integración es compatible con las versiones 2.6, 3.x, 4.x, 5.0 y 6.0 de MongoDB.

Configurar el agente de operaciones para MongoDB

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

Configuración de ejemplo

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

# 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:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
EOF

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

Linux

Para reiniciar el agente, ejecuta el siguiente comando en tu instancia:
```
sudo systemctl restart google-cloud-ops-agent
```
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

Conéctate a tu instancia mediante RDP o una herramienta similar e inicia sesión en Windows.
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.
Para reiniciar el agente, ejecuta el siguiente comando de PowerShell:
```
Restart-Service google-cloud-ops-agent -Force
```
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 MongoDB, debes crear un receptor para los registros que genera MongoDB y, a continuación, crear una canalización para el nuevo receptor.

Para configurar un receptor de tus registros mongodb, 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/mongodb/mongod.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. Por ejemplo, `/var/log/mongodb/.log`.
`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 `mongodb`.
`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 mongodb contienen los siguientes campos en LogEntry:

Campo	Tipo	Descripción
`jsonPayload.attributes`	objeto (opcional)	Objeto que contiene uno o varios pares clave-valor para los atributos adicionales proporcionados
`jsonPayload.component`	cadena	Categorización del mensaje de registro. Puedes consultar la lista completa en la documentación de MongoDB.
`jsonPayload.context`	cadena
`jsonPayload.ctx`	cadena	Nombre del hilo que emite la instrucción de registro.
`jsonPayload.id`	número	ID de registro
`jsonPayload.message`	cadena	Mensaje de registro
`jsonPayload.severity`	cadena	Nivel de entrada de registro
`severity`	cadena (`LogSeverity`)	Nivel de entrada de registro (traducido).

Configurar recogida de métricas

Para ingerir métricas de MongoDB, debe crear un receptor para las métricas que genera MongoDB 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 mongodb, especifique los siguientes campos:

Campo	Predeterminado	Descripción
`ca_file`		Ruta al certificado de la AC. Como cliente, esto verifica el certificado del servidor. Si está vacío, el receptor usa la CA raíz del sistema.
`cert_file`		Ruta al certificado TLS que se va a usar en las conexiones que requieren mTLS.
`collection_interval`	`60s`	Un valor de duración, como `30s` o `5m`.
`endpoint`	`localhost:27017`	Nombre de host, dirección IP o socket de dominio UNIX. Un puerto se puede especificar como `<hostname>:<port>`. Si no se especifica ningún puerto, se usará el puerto predeterminado 27017.
`insecure`	`true`	Define si se debe usar una conexión TLS segura. Si se le asigna el valor `false`, TLS se habilita.
`insecure_skip_verify`	`false`	Define si se debe omitir la verificación del certificado. Si `insecure` se define como `true`, no se utiliza el valor de `insecure_skip_verify`.
`key_file`		Ruta a la clave TLS que se va a usar en las conexiones que requieren mTLS. Por ejemplo, la clave que se usa en `--tlsCertificateKeyFile`.
`password`		Contraseña para la autenticación con la instancia de MongoDB. Es obligatorio si se especifica `username`.
`type`		Este valor debe ser `mongodb`.
`username`		Nombre de usuario para la autenticación con la instancia de MongoDB. Es obligatorio si se especifica `password`.

Qué se monitoriza

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

Tipo de métrica
Tipo Recursos monitorizados	Etiquetas
`workload.googleapis.com/mongodb.cache.operations`
`CUMULATIVE`, `INT64` gce_instance	`type`
`workload.googleapis.com/mongodb.collection.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.connection.count`
`GAUGE`, `INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.cursor.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.cursor.timeout.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.data.size`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.database.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.document.operation.count`
`GAUGE`, `INT64` gce_instance	`database` `operation`
`workload.googleapis.com/mongodb.global_lock.time`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.index.access.count`
`GAUGE`, `INT64` gce_instance	`collection` `database`
`workload.googleapis.com/mongodb.index.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.index.size`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.memory.usage`
`GAUGE`, `INT64` gce_instance	`database` `type`
`workload.googleapis.com/mongodb.network.io.receive`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.network.io.transmit`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.network.request.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.object.count`
`GAUGE`, `INT64` gce_instance	`database`
`workload.googleapis.com/mongodb.operation.count`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.operation.time`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/mongodb.session.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/mongodb.storage.size`
`CUMULATIVE`, `INT64` gce_instance	`database`

Verificar la configuración

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

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

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.
Introduce la siguiente consulta en el editor y haz clic en Ejecutar consulta:
```
resource.type="gce_instance"
log_id("mongodb")
```

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

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.
En la barra de herramientas del panel de creación de consultas, selecciona el botón cuyo nombre sea MQL o PromQL.
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.

Introduce la siguiente consulta en el editor y haz clic en Ejecutar consulta:

{"workload.googleapis.com/mongodb.memory.usage", monitored_resource="gce_instance"}

Ver panel de control

Para ver las métricas de MongoDB, debe haber configurado un gráfico o un panel de control. La integración de MongoDB 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:

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.
Seleccione la pestaña Lista de paneles de control y, a continuación, elija la categoría Integraciones.
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:

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.
Haz clic en el filtro de plataforma de implementación Compute Engine.
Busca la entrada de MongoDB y haz clic en Ver detalles.
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 MongoDB 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:

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.
Busca la entrada de MongoDB y haz clic en Ver detalles.
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.
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.