Filter Log Events
cloudwatchlogs_filter_log_events | R Documentation |
Lists log events from the specified log group¶
Description¶
Lists log events from the specified log group. You can list all the log events or filter the results using one or more of the following:
-
A filter pattern
-
A time range
-
The log stream name, or a log stream name prefix that matches mutltiple log streams
You must have the logs:FilterLogEvents
permission to perform this
operation.
You can specify the log group to search by using either
logGroupIdentifier
or logGroupName
. You must include one of these
two parameters, but you can't include both.
filter_log_events
is a paginated operation. Each page returned can
contain up to 1 MB of log events or up to 10,000 log events. A returned
page might only be partially full, or even empty. For example, if the
result of a query would return 15,000 log events, the first page isn't
guaranteed to have 10,000 log events even if they all fit into 1 MB.
Partially full or empty pages don't necessarily mean that pagination is
finished. If the results include a nextToken
, there might be more log
events available. You can return these additional log events by
providing the nextToken in a subsequent filter_log_events
operation.
If the results don't include a nextToken
, then pagination is finished.
Specifying the limit
parameter only guarantees that a single page
doesn't return more log events than the specified limit, but it might
return fewer events than the limit. This is the expected API behavior.
The returned log events are sorted by event timestamp, the timestamp
when the event was ingested by CloudWatch Logs, and the ID of the
put_log_events
request.
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.
If you are using log
transformation,
the filter_log_events
operation returns only the original versions of
log events, before they were transformed. To view the transformed
versions, you must use a CloudWatch Logs
query.
Usage¶
cloudwatchlogs_filter_log_events(logGroupName, logGroupIdentifier,
logStreamNames, logStreamNamePrefix, startTime, endTime, filterPattern,
nextToken, limit, interleaved, unmask)
Arguments¶
logGroupName |
The name of the log group to search. You must include either |
logGroupIdentifier |
Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN. You must include either |
logStreamNames |
Filters the results to only logs from the log streams in this list. If you specify a value for both |
logStreamNamePrefix |
Filters the results to include only events from log streams that have names starting with this prefix. If you specify a value for both |
startTime |
The start of the time range, expressed as the number of
milliseconds after |
endTime |
The end of the time range, expressed as the number of
milliseconds after |
filterPattern |
The filter pattern to use. For more information, see Filter and Pattern Syntax. If not provided, all the events are matched. |
nextToken |
The token for the next set of events to return. (You received this token from a previous call.) |
limit |
The maximum number of events to return. The default is 10,000 events. |
interleaved |
If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group. |
unmask |
Specify To use this operation with this parameter, you must be signed into an
account with the |
Value¶
A list with the following syntax:
list(
events = list(
list(
logStreamName = "string",
timestamp = 123,
message = "string",
ingestionTime = 123,
eventId = "string"
)
),
searchedLogStreams = list(
list(
logStreamName = "string",
searchedCompletely = TRUE|FALSE
)
),
nextToken = "string"
)
Request syntax¶
svc$filter_log_events(
logGroupName = "string",
logGroupIdentifier = "string",
logStreamNames = list(
"string"
),
logStreamNamePrefix = "string",
startTime = 123,
endTime = 123,
filterPattern = "string",
nextToken = "string",
limit = 123,
interleaved = TRUE|FALSE,
unmask = TRUE|FALSE
)