Parámetros del complemento de salida para enviar datos a una instancia IBM Cloud Logs

Lista de parámetros que puede utilizar para configurar el complemento de salida para enviar datos a una instancia de IBM Cloud Logs en Agente de registro.

Parámetros FluentBit

Parámetros Fluentbit
Clave Descripción Valor predeterminado Opciones de valor Obligatorio
Name Nombre del plug-in. Debe ajustarse a logger-icl-output-plugin n/d logger-icl-output-plugin true
Id ID único para el plug-in. n/d Cualquier serie true
Match Se utiliza para especificar cómo hacer coincidir los eventos. n/d Cualquier serie true
Retry_Limit Reintentar el procesamiento si el complemento no consigue enviar datos a Cloud Logs.
Establezca False si desea reintentar para siempre, de lo contrario establezca un valor Entero.
Para obtener más información sobre cómo configurar los reintentos, consulte aquí		 1 False o N >= 1 true
Workers El número de subprocesos de trabajador concurrentes que envían a IBM Cloud Logs.
Para aumentar el rendimiento de los registros enviados a IBM Cloud Logs, puede aumentar el número de hilos concurrentes que envían desde cada agente.
Más información		 1 1 o más falso

Parámetros de conexión

Parámetros de conexión
Clave Descripción Valor predeterminado Opciones de valor Obligatorio
Target_Host Nombre de host de ingesta que se utilizará para la conexión n/d cualquier punto final url true
Target_Port Puerto de ingesta que se utilizará para la conexión 443 cualquier número de puerto falso
Target_Path Ruta URL que se utilizará para la conexión /logs/v1/singles Cualquier serie falso

Parámetros de registro

Parámetros de registro
Clave Descripción Valor predeterminado Opciones de valor Obligatorio
Logging_Level Especifique el nivel de registro que se utilizará en el complemento info debug
info
error		 falso
Package_Size Especifique el tamaño del paquete en KB o MB 2 cualquier número seguido de una unidad, por ejemplo, 2MB, 10KB. Debe ser inferior a 2MB falso

Parámetros de autenticación

Parámetros de autenticación
Clave Descripción Valor predeterminado Opciones de valor Obligatorio
Authentication_Mode Especifique el modo de autenticación TrustedProfile TrustedProfile
IAMAPIKey		 falso
IAM_Environment Especifique el entorno IAM para la autenticación Production 'Production especifica el punto final público ' iam.cloud.ibm.com '

' PrivateProduction ' especifica el punto final privado ' private.iam.cloud.ibm.com '

' Custom especifica un punto final especificado por el parámetro ' IAM_Host

 falso
IAM_Host El nombre de host IAM para un entorno IAM personalizado n/d El nombre completo del host IAM, por ejemplo: " private.eu-de.iam.cloud.ibm.com Sólo se utiliza cuando " IAM_Environment " es igual a " Custom
CR_Token_Mount_Path Ruta donde se encuentra el CRToken /var/run/secrets/tokens/vault-token Cualquier serie false - Sólo se utiliza cuando Authentication_Mode está establecido en TrustedProfile
Trusted_Profile_ID ID del perfil de confianza que se va a utilizar n/d Cualquier serie true - Sólo se utiliza cuando Authentication_Mode está configurado como TrustedProfile
IAM_API_key La clave api que se utilizará; véase la nota siguiente para más información sobre la especificación de una clave api n/d Cualquier serie falso

Cuando Authentication_Mode está configurado como IAMAPIKey, la clave api debe especificarse de una de las tres maneras siguientes. Estos son, por orden de precedencia, los siguientes:

  1. Mediante el campo IAM_API_key de la configuración
    • Se recomienda encarecidamente no insertar una clave api directamente en el archivo de configuración. En su lugar, se puede utilizar un valor de la forma ${CUSTOM_ENVIRONMENT_VARIABLE} para recuperar variables de entorno distintas de las mencionadas a continuación
  2. Utilizando una variable de entorno denominada IAM_API_KEY_<output_ID>
    • Donde <output_ID> es el ID dado al plug-in de salida como se especifica en el parámetro Id, con los guiones (-) sustituidos por guiones bajos (_)
  3. Utilizando una variable de entorno denominada IAM_API_KEY

Si no se proporciona ningún valor en ninguna de las opciones anteriores, la inicialización del complemento fallará.

Consideraciones sobre la configuración de Fluentbit Agent Workers

Un ' worker' , en el contexto del ' Agente de registro, representa un hilo de CPU que está disponible para el ' Agente de registro ' para manejar los registros.

Puede configurar el número de trabajadores disponibles en la configuración del plugin de salida.

  • En la configuración por defecto de fluent-bit, ' Workers=1 ' es la configuración por defecto y esto funcionará para cargas de trabajo que generen volúmenes de registro inferiores a 1MB/sec
  • En un entorno con mayores volúmenes de logs, más de 1 MB/seg, puede ser necesario aumentar la configuración de ' Workers ' para que el plugin de salida pueda procesar los logs que se están consumiendo.
  • El gráfico " Helm " para los despliegues " Openshift y " Kubernetes " se configura con 4 trabajadores, ya que suele ser una buena configuración para la mayoría de las cargas de trabajo " Kubernetes ".

Utilice la variable outputWorkers Helm para gestionar la configuración de Trabajadores para el plugin de salida si está utilizando el gráfico Helm.

Estas son algunas consideraciones a tener en cuenta a la hora de establecer el valor ' Workers ' en su entorno:

  • Reducir el número de trabajadores de 4 a 2 podría reducir los requisitos de CPU para el Agente de registro.

  • Aumentar el número de trabajadores a más de 4 sin aumentar también el límite de CPU en un entorno Kubernetes normalmente no resultará en más registros procesados por el Agente de registro. Hay un punto en el que la CPU limitará el rendimiento y deberá aumentarse también.

  • Si ve mensajes en los registros Agente de registro que informan de ' [input] pausing tail seguido de ' [input] resume tail, esto indica que el plugin de salida que envía los registros no puede mantener el volumen de registros generados. Si el uso de la CPU no ha alcanzado el límite de CPU definido, el aumento del número de trabajadores normalmente aumentará el rendimiento. Si el uso de la CPU está cerca del límite, entonces puede ser necesario aumentar el límite de la CPU además de aumentar el número de trabajadores. No pasa nada si el mensaje " [input] pausing tail " se emite varias veces por hora. Si este mensaje aparece muchas veces por minuto, debería considerar un cambio de configuración.

  • Si aparece el mensaje ' [ warn] [input:tail:tail.0] purged rotated file while data ingestion is paused, consider increasing rotate_wait, suele ser una indicación de que el volumen de entrada es significativamente más rápido de lo que el agente es capaz de procesar. Si no se aumenta el número de trabajadores o la CPU (o ambos), faltarán registros, ya que los archivos rotados ya no se están procesando debido a la rotación de archivos y la ingesta está en pausa. Debe aumentar los límites de trabajadores o de CPU (o ambos) si se encuentra con este error.