CloudWatchLogs / Client / get_log_group_fields

get_log_group_fields#

CloudWatchLogs.Client.get_log_group_fields(**kwargs)#

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can’t specify both.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event. For more information about the fields that are generated by CloudWatch logs, see Supported Logs and Discovered Fields.

The response results are sorted by the frequency percentage, starting with the highest percentage.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

See also: AWS API Documentation

Request Syntax

response = client.get_log_group_fields(
    logGroupName='string',
    time=123,
    logGroupIdentifier='string'
)
Parameters:

  • logGroupName (string) –

    The name of the log group to search.

    Note

    You must include either logGroupIdentifier or logGroupName, but not both.

  • time (integer) –

    The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

    The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

  • logGroupIdentifier (string) –

    Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

    Note

    You must include either logGroupIdentifier or logGroupName, but not both.

Return type:

dict

Returns:

Response Syntax

{
    'logGroupFields': [
        {
            'name': 'string',
            'percent': 123
        },
    ]
}

Response Structure

  • (dict) –

    • logGroupFields (list) –

      The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

      • (dict) –

        The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.

        • name (string) –

          The name of a log field.

        • percent (integer) –

          The percentage of log events queried that contained the field.

Exceptions