cloudwatchlogs_start_live_tail: Starts a Live Tail streaming session for one or more log...

View source: R/cloudwatchlogs_operations.R

cloudwatchlogs_start_live_tailR Documentation

Starts a Live Tail streaming session for one or more log groups

Description

Starts a Live Tail streaming session for one or more log groups. A Live Tail session returns a stream of log events that have been recently ingested in the log groups. For more information, see Use Live Tail to view logs in near real time.

See https://www.paws-r-sdk.com/docs/cloudwatchlogs_start_live_tail/ for full documentation.

Usage

cloudwatchlogs_start_live_tail(
  logGroupIdentifiers,
  logStreamNames = NULL,
  logStreamNamePrefixes = NULL,
  logEventFilterPattern = NULL
)

Arguments

logGroupIdentifiers

[required] An array where each item in the array is a log group to include in the Live Tail session.

Specify each log group by its ARN.

If you specify an ARN, the ARN can't end with an asterisk (*).

You can include up to 10 log groups.

logStreamNames

If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

If you specify this field, you can't also specify the logStreamNamePrefixes field.

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

logStreamNamePrefixes

If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

If you specify this field, you can't also specify the logStreamNames field.

You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

logEventFilterPattern

An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of ⁠error 404⁠ causes only log events that include both error and 404 to be included in the Live Tail stream.

Regular expression filter patterns are supported.

For more information about filter pattern syntax, see Filter and Pattern Syntax.


paws.management documentation built on Sept. 12, 2024, 6:19 a.m.