/AWS1/CL_CWL=>GETLOGGROUPFIELDS()
¶
About GetLogGroupFields¶
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.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_LOGGROUPNAME
TYPE /AWS1/CWLLOGGROUPNAME
/AWS1/CWLLOGGROUPNAME
¶
The name of the log group to search.
You must include either
logGroupIdentifier
orlogGroupName
, but not both.
IV_TIME
TYPE /AWS1/CWLTIMESTAMP
/AWS1/CWLTIMESTAMP
¶
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 omittime
, 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 sinceJanuary 1, 1970, 00:00:00 UTC
.
IV_LOGGROUPIDENTIFIER
TYPE /AWS1/CWLLOGGROUPIDENTIFIER
/AWS1/CWLLOGGROUPIDENTIFIER
¶
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.
You must include either
logGroupIdentifier
orlogGroupName
, but not both.