Referencia del agente de CloudWatch Logs

Especifica dónde se almacena el archivo de estado.

(Opcional) Especifica la ubicación del archivo de configuración de registro del agente. Si no especifica aquí un archivo de configuración de registro de agente, se utiliza el archivo de configuración. La ubicación predeterminada del archivo es /var/awslogs/etc/awslogs.conf si instaló el agente con un script y es /etc/awslogs/awslogs.conf si instaló el agente con rpm. El archivo se encuentra en formato de archivo de configuración de Python (https://docs.python.org/2/library/logging.config.html#logging-config-fileformat). Las funciones de registro con los nombres siguientes se pueden personalizar.

cwlogs.push
cwlogs.push.reader
cwlogs.push.publisher
cwlogs.push.event
cwlogs.push.batch
cwlogs.push.stream
cwlogs.push.watcher

El ejemplo siguiente cambia el nivel de lector y editor a WARNING mientras el valor por defecto es INFO.

[loggers]
keys=root,cwlogs,reader,publisher
            
[handlers]
keys=consoleHandler
            
[formatters]
keys=simpleFormatter
           
[logger_root]
level=INFO
handlers=consoleHandler
            
[logger_cwlogs]
level=INFO
handlers=consoleHandler
qualname=cwlogs.push
propagate=0
            
[logger_reader]
level=WARNING
handlers=consoleHandler
qualname=cwlogs.push.reader
propagate=0
            
[logger_publisher]
level=WARNING
handlers=consoleHandler
qualname=cwlogs.push.publisher
propagate=0
            
[handler_consoleHandler]
class=logging.StreamHandler
level=INFO
formatter=simpleFormatter
args=(sys.stderr,)
            
[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(process)d - %(threadName)s - %(message)s

Cuando se establece en VERDADERO (predeterminado), permite la codificación de contenido gzip http para enviar cargas comprimidas a CloudWatch Logs. Esto reduce la utilización de la CPU, reduce NetworkOut y reduce la latencia de Put. Para desactivar esta característica, agregue use_gzip_http_content_encoding = false a la sección [general] del archivo de configuración del agente de CloudWatch Logs y, a continuación, reinicie el agente.

Especifica el grupo de registro de destino. Un grupo de registro se crea automáticamente si no existe todavía. Los nombres de grupo de registros puede tener de 1 a 512 caracteres de longitud. Entre los caracteres permitidos se incluyen a-z, A-Z, 0-9, "_" (carácter de subrayado), "-" (guion), "/" (barra diagonal) y "." (punto).

Especifica el flujo de registro de destino. Puede usar una cadena literal, variables predefinidas ({instance_id}, {hostname} y {ip_address}), o una combinación de ellas para definir el nombre del flujo de registro. Un flujo de registro se crea automáticamente si no existe todavía.

Especifica cómo se extrae la marca temporal de los registros. La marca temporal se utiliza para recuperar eventos de registro y generar métricas. Se utiliza la hora actual para cada evento de registro si no se proporciona datetime_format. Si el valor de datetime_format proporcionado no es válido para un mensaje de registro determinado, se utiliza la marca temporal (analizada correctamente) del último evento de registro. Si no existen eventos de registro anteriores, se utiliza la hora actual.

Los códigos datetime_format comunes se enumeran a continuación. También puede utilizar cualquier código datetime_format que admita Python, datetime.strptime (). El desfase de la zona horaria (%z) también se admite aunque no se ha admitido hasta python 3.2, [+ -] HHMM sin dos puntos (:). Para obtener más información, consulte strftime() and strptime() Behavior.

%y: año sin siglo como número decimal rellenado con ceros. 00, 01, ..., 99

%Y: año con siglo como número decimal. 1970, 1988, 2001, 2013

%b: mes como nombre abreviado de configuración regional. Ene, Feb, ..., Dic (es_ES);

%B: mes como nombre completo de configuración regional. enero, febrero,..., diciembre (es_ES);

%m: mes como número decimal rellenado con ceros. 01, 02, ..., 12

%d: día del mes como número decimal rellenado con ceros. 01, 02, ..., 31

%H: hora (formato de 24 horas) como número decimal rellenado con ceros. 00, 01, ..., 23

%I: hora (formato de 12 horas) como número decimal rellenado con ceros. 01, 02, ..., 12

%p: equivalente de la configuración regional a AM o PM.

%M: minutos como número decimal rellenado con ceros. 00, 01, ..., 59

%S: segundos como número decimal rellenado con ceros. 00, 01, ..., 59

%f: microsegundos como número decimal, rellenado con ceros a la izquierda. 000000, ..., 999999

%z: desplazamiento UTC en la forma +HHMM o -HHMM. +0000, -0400, +1030

Formatos de ejemplo:

Syslog: '%b %d %H:%M:%S', e.g. Jan 23 20:59:29

Log4j: '%d %b %Y %H:%M:%S', e.g. 24 Jan 2014 05:00:00

ISO8601: '%Y-%m-%dT%H:%M:%S%z', e.g. 2014-02-20T05:20:20+0000

Especifica la zona horaria de la marca temporal de evento de registro. Los dos valores admitidos son UTC y LOCAL. El valor predeterminado es LOCAL, que se utiliza en caso de que la zona horaria no se pueda determinar a partir de datetime_format.

Especifica los archivos de registro que desea enviar a CloudWatch Logs. File puede apuntar a un archivo específico o a varios archivos (utilizando comodines como /var/log/system.log*). Solo se envía el último archivo a CloudWatch Logs en función de la hora de modificación del archivo. Le recomendamos que utilice comodines para especificar una serie de archivos del mismo tipo, como access_log.2014-06-01-01, access_log.2014-06-01-02, etc., pero no varios tipos de archivos, como por ejemplo access_log_80 y access_log_443. Para especificar varios tipos de archivos, agregue otra entrada de flujo de registro al archivo de configuración para que cada tipo de archivo de registro vaya a un flujo de registros distinto. Los archivos comprimidos no son compatibles.

Especifica el intervalo de líneas para identificar un archivo. Los valores admitidos son un número o dos números delimitados por guion, como, por ejemplo, "1", "2-5". El valor predeterminado es "1" de modo que se utiliza la primera línea para calcular la huella. Las líneas de huella no se envían a CloudWatch Logs, a menos que todas las líneas especificadas estén disponibles.

Especifica el patrón para identificar el inicio de un mensaje de registro. Un mensaje de registro consta de una línea que coincide con el patrón y de líneas siguientes que no coinciden con el patrón. Los valores válidos son expresiones regulares o {datetime_format}. Cuando se utiliza {datetime_format}, se debe especifica la opción datetime_format. El valor predeterminado es "^[^\s]" de modo que cualquier línea que comience con un carácter sin espacios en blanco cierra el mensaje de registro anterior y comienza un nuevo mensaje de registro.

Especifica dónde empezar a leer datos (start_of_file o end_of_file). El valor predeterminado es start_of_file. Se utiliza únicamente si no se almacena de forma persistente ningún estado para dicho flujo de registro.

Especifica la codificación del archivo de registro, de modo que el archivo se pueda leer correctamente. El valor predeterminado es utf_8. Se pueden utilizar aquí las codificaciones compatibles con Python codecs.decode().

A continuación se muestran las codificaciones comunes:

ascii, big5, big5hkscs, cp037, cp424, cp437, cp500, cp720, cp737, cp775, cp850, cp852, cp855, cp856, cp857, cp858, cp860, cp861, cp862, cp863, cp864, cp865, cp866, cp869, cp874, cp875, cp932, cp949, cp950, cp1006, cp1026, cp1140, cp1250, cp1251, cp1252, cp1253, cp1254, cp1255, cp1256, cp1257, cp1258, euc_jp, euc_jis_2004, euc_jisx0213, euc_kr, gb2312, gbk, gb18030, hz, iso2022_jp, iso2022_jp_1, iso2022_jp_2, iso2022_jp_2004, iso2022_jp_3, iso2022_jp_ext, iso2022_kr, latin_1, iso8859_2, iso8859_3, iso8859_4, iso8859_5, iso8859_6, iso8859_7, iso8859_8, iso8859_9, iso8859_10, iso8859_13, iso8859_14, iso8859_15, iso8859_16, johab, koi8_r, koi8_u, mac_cyrillic, mac_greek, mac_iceland, mac_latin2, mac_roman, mac_turkish, ptcp154, shift_jis, shift_jis_2004, shift_jisx0213, utf_32, utf_32_be, utf_32_le, utf_16, utf_16_be, utf_16_le, utf_7, utf_8, utf_8_sig

Especifica la duración para agrupar en lotes eventos de registro. El valor mínimo es 5000ms y valor predeterminado es 5000ms.

Especifica el número máximo de eventos de registro en un lote, hasta 10 000. El valor predeterminado es 10 000.

Especifica el tamaño máximo de eventos de registro en un lote, en bytes, hasta 1 048 576 bytes. El valor predeterminado es de 1 048 576 bytes. Este tamaño se calcula como la suma de todos los mensajes de eventos en UTF-8, más 26 bytes para cada evento de registro.

Se admiten los siguientes mecanismos de rotación de archivos:

La huella (ID de origen) del archivo se calcula mediante el hash de la clave del flujo de registro y la primera línea de contenido del archivo. Para omitir este comportamiento, se puede utilizar la opción file_fingerprint_lines. Cuando se produce la rotación de archivos, el nuevo archivo se supone que tiene nuevo contenido y el archivo antiguo no se supone que tenga contenido añadido; el agente envía el nuevo archivo una vez que termine la lectura del antiguo.

Si utilizó un script de configuración para instalar el agente de CloudWatch Logs, puede utilizar /var/awslogs/bin/awslogs-version.sh para verificar la versión del agente que utiliza. Imprime la versión del agente y sus dependencias principales. Si utilizó yum para instalar el agente de CloudWatch Logs, puede utilizar “yum info awslogs” y “yum info aws-cli-plugin-cloudwatch-logs” para verificar la versión del complemento y del agente de CloudWatch Logs.

Los eventos de registro contienen dos propiedades: la marca temporal de cuando se produjo el evento y el mensaje de registro sin procesar. De forma predeterminada, cualquier línea que comience con un carácter sin espacios en blanco cierra el mensaje de registro anterior si lo hay y comienza un nuevo mensaje de registro. Para anular este comportamiento, se puede usar multi_line_start_pattern y todas las líneas que coincidan con el patrón inician un nuevo mensaje de registro. El patrón podría ser cualquier regex o "{datetime_format}". Por ejemplo, si la primera línea de cada mensaje de registro contiene una marca temporal como “2014-01-02T13:13:01Z”, multi_line_start_pattern se puede establecer en “\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z”. Para simplificar la configuración, la variable "{datetime_format}" variable se puede utilizar si se especifica datetime_format option. Para el mismo ejemplo, si datetime_format se establece en "%Y-%m-%dT%H:%M:%S%z", entonces el patrón multi_line_start_pattern podría ser sencillamente "{datetime_format}".

Se utiliza la hora actual para cada evento de registro si no se proporciona datetime_format. Si el valor de datetime_format proporcionado no es válido para un mensaje de registro determinado, se utiliza la marca temporal (analizada correctamente) del último evento de registro. Si no existen eventos de registro anteriores, se utiliza la hora actual. Se registra un mensaje de advertencia cuando un evento de registro utiliza la hora actual o la hora del evento de registro anterior.

Las marcas temporales se utilizan para recuperar eventos de registro y generar métricas, por lo que si especifica el formato equivocado, los eventos de registro no podrían recuperarse y podrían generar métricas erróneas.

Un lote se completa y se publica cuando cumple alguna de las siguientes condiciones:

Para seguir la restricción de la operación PutLogEvents, los siguientes problemas podrían provocar la omisión de un evento de registro o lote.

No siempre y cuando el archivo de estado esté disponible y no se haya producido la rotación de ningún archivo desde la última ejecución. El agente de CloudWatch Logs puede iniciarse desde donde se paró y continuar enviando los datos de registro.

No se admite configurar varias fuentes de registro para enviar datos a un único flujo de registro.

El agente de CloudWatch Logs requiere las operaciones CreateLogGroup, CreateLogStream, DescribeLogStreams y PutLogEvents. Si está utilizando el último agente, no es necesario DescribeLogStreams. Consulte la política de IAM de ejemplo a continuación.

{
"Version": "2012-10-17",
"Statement": [
  {
    "Effect": "Allow",
    "Action": [
      "logs:CreateLogGroup",
      "logs:CreateLogStream",
      "logs:PutLogEvents",
      "logs:DescribeLogStreams"
    ],
    "Resource": [
      "arn:aws:logs:*:*:*"
    ]
  }
 ]
}

En la política de IAM, puede limitar el agente solo a las siguientes operaciones: DescribeLogStreams, PutLogEvents.

Antes de revocar los permisos CreateLogStream y CreateLogGroup del agente, asegúrese de crear los grupos de registro y las secuencias de registro que desee que utilice el agente. El agente de registros no puede crear secuencias de registro en un grupo de registros que haya creado a menos que tenga los permisos CreateLogStream y CreateLogGroup.

El registro del agente de instalación se encuentra en /var/log/awslogs-agent-setup.log y el registro del agente, en /var/log/awslogs.log.