La integración de Jetty recopila métricas de uso de subprocesos y sesiones. La integración también recopila registros de sistema y acceso. Los registros de acceso se analizan en una carga útil JSON centrada en los detalles de la solicitud.
Para obtener más información sobre Jetty, consulta la documentación de Jetty.
Requisitos previos
Para recopilar la telemetría de Jetty, debes instalar el agente de operaciones:
- Para los registros, instala la versión 2.16.0 o una posterior.
- Para las métricas, instala la versión 2.17.0 o una posterior.
Esta integración es compatible con las versiones 9.4.x, 10.x y 11.x de Jetty.
Configura el agente de operaciones para Jetty
Mediante la guía Configura el agente de operaciones, agrega los elementos necesarios para recopilar telemetría de instancias de Jetty y reinicia el agente.
Para recopilar métricas de esta integración, también debes exponer un extremo de Java Management Extensions (JMX).
Para exponer un extremo de JMX, debes configurar la propiedad del sistema com.sun.management.jmxremote.port
cuando inicies la JVM. También te recomendamos configurar la propiedad del sistema com.sun.management.jmxremote.rmi.port
en el mismo puerto.
De forma predeterminada, estas propiedades se establecen en el archivo /etc/jetty-jmx.xml
de Jetty.
Para exponer un extremo JMX de forma remota, también debes configurar la propiedad del sistema java.rmi.server.hostname
.
Para configurar las propiedades del sistema mediante argumentos de la línea de comandos, agrega el nombre de la propiedad con -D
cuando inicies la JVM. Por ejemplo, para configurar la propiedad com.sun.management.jmxremote.port
en el puerto 1099, especifica lo siguiente cuando inicies JVM:
-Dcom.sun.management.jmxremote.port=1099
Configuración de ejemplo
El siguiente comando crea la configuración para recopilar y transferir la telemetría de Jetty y reinicia el agente de operaciones en Linux.
Configura la recopilación de registros
A fin de transferir registros desde Jetty, debes crear receptores para los registros que produce Jetty y, luego, crear una canalización para los receptores nuevos.
A fin de configurar un receptor para tus registros jetty_access
, 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 |
["/opt/logs/*.request.log"] |
Una lista de rutas de acceso del sistema de archivos que se leerán mediante la visualización del final de cada archivo. Se puede usar un comodín (*) en las rutas. |
type |
El valor debe ser jetty_access . |
|
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. |
wildcard_refresh_interval |
60s |
El intervalo en el que se actualizan las rutas de acceso de archivos comodín en include_paths. Se proporciona como una duración, por ejemplo, 30s o 2m . 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 jetty_access
contienen los siguientes campos en LogEntry
:
Campo | Tipo | Descripción |
---|---|---|
httpRequest.protocol |
string | Protocolo que se usa para la solicitud |
httpRequest.remoteIp |
string | Dirección IP de cliente. |
httpRequest.requestMethod |
string | Método HTTP. |
httpRequest.requestUrl |
string | URL de la solicitud (por lo general, es solo la parte de la ruta de acceso de la URL) |
httpRequest.responseSize |
string | Tamaño de la respuesta |
httpRequest.status |
string | Código de estado HTTP. |
httpRequest.userAgent |
string | Contenido del encabezado User-Agent |
Los registros syslog
contienen los siguientes campos en LogEntry
:
Campo | Tipo | Descripción |
---|---|---|
jsonPayload.message |
string | Mensaje del registro. |
Configura la recopilación de métricas
A fin de transferir métricas de Jetty, debes crear un receptor para las métricas que produce Jetty 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 jetty
, especifica los siguientes campos:
Campo | Predeterminada | Descripción |
---|---|---|
collect_jvm_metrics |
true |
Configura el receptor para que también recopile las métricas de JVM compatibles. |
collection_interval |
60s |
Un valor time.Duration, como 30s o 5m . |
endpoint |
localhost:1099 |
La URL de servicio de JMX, o el host y el puerto que se usan para construir la URL de servicio. Este valor debe tener el formato service:jmx:<protocol>:<sap> o host:port . Los valores en formato host:port se usan para crear una URL de servicio de service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi . |
password |
La contraseña configurada si JMX está configurado para requerir autenticación. | |
type |
Este valor debe ser jetty . |
|
username |
El nombre de usuario configurado si JMX está configurado para requerir autenticación. |
Qué se supervisa
En la siguiente tabla, se proporciona una lista de métricas que el Agente de operaciones recopila de la instancia Jetty.
Tipo de métrica | |
---|---|
Categoría, tipo Recursos supervisados |
Etiquetas |
workload.googleapis.com/jetty.select.count
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/jetty.session.count
|
|
CUMULATIVE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.session.time.max
|
|
GAUGE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.session.time.total
|
|
GAUGE , INT64 gce_instance |
resource
|
workload.googleapis.com/jetty.thread.count
|
|
GAUGE , INT64 gce_instance |
state
|
workload.googleapis.com/jetty.thread.queue.count
|
|
GAUGE , INT64 gce_instance |
Verifica la configuración
En esta sección, se describe cómo verificar que hayas configurado correctamente el receptor de Jetty. El agente de operaciones puede tardar uno o dos minutos en comenzar a recopilar telemetría.
Para verificar que los registros de Jetty 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:
- Ingresa la siguiente consulta en el editor y, luego, haz clic en Ejecutar consulta:
resource.type="gce_instance" log_id("jetty_access")
Para verificar que las métricas de Jetty se envían a Cloud Monitoring, haz lo siguiente:
-
En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego, leaderboard Explorador de métricas:
- En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre sea code MQL o code PromQL.
- Verifica que MQL esté seleccionado en el botón de activación Idioma. 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/jetty.select.count' | every 1m
Ver panel
Para ver tus métricas de Jetty, debes tener configurado un gráfico o un panel. La integración de Jetty 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:
- 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:
- Haz clic en el filtro de la plataforma de implementación Compute Engine.
- Localiza la entrada de Jetty 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 Jetty incluye una o más políticas de alertas para que uses. Puedes ver e 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:
- Localiza la entrada de Jetty 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:
- En la lista de políticas de alertas disponibles, elige las que deseas instalar.
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.
- 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.