Configurar recopilación de comandos del sistema operativo

Si desea ejecutar scripts de comandos del sistema operativo en el host del agente de gestión y recopilar la salida continua de los comandos en forma de logs en Oracle Log Analytics, cree un script propio.

Temas:

Requisitos para configurar la recopilación de la salida de comandos del sistema operativo

Complete las siguientes tareas de requisitos previos antes de configurar la recopilación de logs:

  • Cree un script personalizado que conste de un comando del sistema operativo, cuya salida se puede recopilar en Oracle Log Analytics como logs. La salida de STDOUT del script se envía como carga útil por parte del agente a la nube. La carga útil STDOUT puede ser una sola entrada de log o varias entradas de log. Asegúrese de que el analizador utilizado en el origen de Oracle Log Analytics pueda analizarlo. Además, la secuencia de comandos debe poder manejar condiciones de error y comprobar los requisitos previos.

    Almacene el script personalizado en la carpeta agent_inst/state/laStorage/os_cmd/scripts de la carpeta de instalación del agente. Por lo tanto, la ruta de acceso absoluta para almacenar el script es:

    • Para Oracle Management Agent: /opt/oracle/mgmt_agent/agent_inst/state/laStorage/os_cmd/scripts
    • Para el plugin de Oracle Cloud Agent- Management Agent: /var/lib/oracle-cloud-agent/plugins/oci-managementagent/polaris/agent_inst/state/laStorage/os_cmd/scripts
  • Es posible que se tengan que proporcionar permisos de archivo especiales para ejecutar comandos concretos en la secuencia de comandos. Configure estos permisos en el host del agente manualmente. La secuencia de comandos y cualquier otro comando/secuencia de comandos que ejecute la secuencia de comandos deben tener el permiso execute para el usuario del agente de gestión.

Flujo general para recopilar logs de comandos del sistema operativo

A continuación, se muestran las tareas de alto nivel para recopilar la salida de una secuencia de comandos del sistema operativo:

  • Instale Management Agent en el host en el que desea ejecutar los scripts de comandos del sistema operativo y generar la salida que se debe recopilar en Oracle Log Analytics. Consulte Configuración de la recopilación continua de logs mediante Management Agent.

  • Cree una entidad para identificar el host de agente en Oracle Log Analytics. La entidad debe estar en el mismo host que el agente de gestión donde se ejecutará el script. No se admite la ejecución remota de comandos del sistema operativo. Normalmente, la entidad se crea automáticamente al instalar Management Agent. Consulte Creación de una entidad para representar el recurso que emite logs.

  • Cree un analizador que pueda analizar la salida del script. Este analizador se debe utilizar en el origen que se identificará en el siguiente paso. Consulte Creación de un analizador.
  • Identifique un origen existente o cree un origen de log del tipo comando del sistema operativo. Consulte Create an OS Command Source.
  • Compruebe si desea configurar la propiedad de recopilación de agentes customized_schedule para definir el intervalo de recopilación de la recopilación de comandos del sistema operativo. El valor por defecto es 30 seconds. Puede actualizar el programa a nivel de agente, de origen, de entidad o de asociación mediante las propiedades de recopilación de agentes. Consulte Propiedades del Agente que Puede Modificar y Modificar Propiedades del Agente.
  • Asocie las entidades al origen que ha creado anteriormente. Consulte Configuración de una nueva asociación origen-entidad.

    Una vez finalizada la asociación, el agente comienza a ejecutar el comando del sistema operativo de forma periódica, el STDOUT del comando se recopila como datos de log y esos datos de log comienzan a fluir a Oracle Log Analytics.

  • Para ver los datos de log en el explorador de logs, seleccione el origen de comandos del sistema operativo que creó anteriormente. Consulte Filtrado de Logs por Atributos de Origen.

Si los datos del log no aparecen en el explorador de logs una vez finalizada la configuración, puede comprobar si hay advertencias de recopilación de agentes para detectar cualquier problema. Las siguientes advertencias están específicamente relacionadas con la recopilación de salida de comandos del sistema operativo:

  • Error de ejecución de aplicación externa: se ha producido un error al ejecutar la secuencia de comandos o el comando del sistema operativo no está soportado.

  • No se ha encontrado la aplicación externa: no se ha encontrado el script, no hay permisos de lectura/ejecución en el script.

Consulte Visualización de las advertencias de recopilación del agente.

Factores importantes que se deben considerar al configurar la recopilación de comandos del sistema operativo

  • Utilice la ruta completa de los comandos en las secuencias de comandos; por ejemplo, utilice /bin/sudo en lugar de sudo.

  • Los scripts se ejecutan como el mismo usuario con el que se ejecuta Management Agent. Esto es importante al leer o escribir archivos en el script.

  • La salida generada por la secuencia de comandos en Standard Out (STDOUT) y Standard Error (STDERR) se recopila como texto para extraer las entradas del log.

  • Las siguientes palabras o prefijos no están soportados en el comando del sistema operativo ni en el nombre del script: sh, bash, csh, zsh, ksh, dash, cmd

  • Los siguientes caracteres no están soportados en el comando del sistema operativo ni en el nombre del script: |, &, ;, >, <

  • Las siguientes secuencias transversales de directorio principal no están soportadas en el comando del sistema operativo ni en el nombre del script: /../ o \..\. Además, el comando del sistema operativo no puede terminar con /.. ni \...

  • La siguiente variable de entorno se transfiere a los scripts desde el agente. Puede utilizar la variable en las secuencias de comandos.

    • LA_SOURCE_COMMAND_ID: ID de patrón generado internamente del comando en el origen de log. Se puede utilizar para diferenciar entre instancias de script si el mismo script se proporciona en varios comandos.

Creación de un origen de comandos del sistema operativo

Cree este tipo de origen para configurar una recopilación continua de salida mediante la ejecución de scripts de comandos del sistema operativo en el host del agente, en forma de logs.

  1. Abra el menú de navegación y haga clic en Observación y gestión. En Log Analytics, haga clic en Administración.

  2. Los recursos de administración se muestran en el panel en Administración en la izquierda. Haga clic en Orígenes.

    Se abre la página Orígenes. Haga clic en Crear origen.

  3. En el campo Nombre, introduzca el nombre del origen.

    También puede agregar una descripción.

  4. En la lista Tipo de origen, seleccione comando del sistema operativo.

  5. Haga clic en el campo Tipo de entidad y seleccione el tipo de entidad para este origen de log. Más adelante, cuando asocie este origen a una entidad para activar la recopilación de logs a través del agente de gestión, solo las entidades de este tipo estarán disponibles para la asociación. Un origen puede tener uno o más tipos de entidad. Tenga en cuenta que la entidad debe estar en el mismo host que el agente de gestión donde se ejecutará el script. No se admite la ejecución remota de comandos del sistema operativo.

  6. Haga clic en el campo Analizador y seleccione el nombre del analizador relevante que mejor capture los campos en los logs.

    No se admiten las siguientes funciones del analizador:

    • La función Detalles de cabecera no está soportada en casos en los que el tamaño del bloque JSON o XML sea superior a 1 MB y la cabecera se encuentre al final del bloque o la cabecera ajuste el cuerpo.
    • Desplazamiento de Tiempo
  7. Utilice el separador Comandos para incluir las secuencias de comandos de comandos del sistema operativo y sus detalles que se deben ejecutar en el host del agente para recopilar la salida en forma de logs.

    • Comando: proporcione la ruta de la secuencia de comandos del sistema operativo que se almacena en el host del agente. La ruta debe ser relativa a la carpeta de script personalizada. El campo Comando no puede contener secuencias de recorrido de directorio principal /../ o \..\. El comando no puede terminar con /.. o \...

      Ruta de acceso de ejemplo:

      Si la ruta absoluta del script personalizado es /opt/oracle/mgmt_agent/agent_inst/state/laStorage/os_cmd/scripts/user1scripts/my_script1.sh, proporcione la ruta user1scripts/my_script1.sh en este campo.

      Para obtener detalles sobre la secuencia de comandos personalizada del comando del sistema operativo y la ubicación para almacenarla en el host del agente, consulte Prerequisites for Setting Up Collection of OS Command Output.

    • Argumentos: si lo desea, puede especificar argumentos para el script y separar cada argumento por un carácter de espacio en blanco.

    • Descripción: opcionalmente, proporcione una descripción significativa para este comando y juego de argumentos.

    Después de proporcionar detalles de la secuencia de comandos del sistema operativo, active la casilla de control correspondiente a su fila para activar la configuración.

  8. Agregue filtros de datos. Consulte Uso de filtros de datos en los orígenes.

  9. Agregue campos ampliados. Consulte Uso de campos ampliados en los orígenes.

  10. Configure opciones de enriquecimiento de campos. Consulte Configuración de opciones de enriquecimiento de campos.

  11. Agregue etiquetas. Consulte Uso de etiquetas en los orígenes.

  12. Haga clic en Guardar.