AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
The response to this operation is a response stream, over which the server sends live log events and the client receives them.
The following objects are sent over the stream:
A single LiveTailSessionStart object is sent at the start of the session.
Every second, a LiveTailSessionUpdate object is sent. Each of these objects contains an array of the actual log events.
If no new log events were ingested in the past second, the LiveTailSessionUpdate
object will contain an empty array.
The array of log events contained in a LiveTailSessionUpdate can include as
many as 500 log events. If the number of log events matching the request exceeds 500
per second, the log events are sampled down to 500 log events to be included in each
LiveTailSessionUpdate object.
If your client consumes the log events slower than the server produces them, CloudWatch
Logs buffers up to 10 LiveTailSessionUpdate events or 5000 log events, after
which it starts dropping the oldest events.
A SessionStreamingException object is returned if an unknown error occurs on the server side.
A SessionTimeoutException object is returned when the session times out, after it has been kept open for three hours.
You can end a session before it times out by closing the session stream or by closing the client that is receiving the stream. The session also ends if the established connection between the client and the server breaks.
For examples of using an SDK to start a Live Tail session, see Start a Live Tail session using an Amazon Web Services SDK.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartLiveTail and EndStartLiveTail.
Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z
public virtual Task<StartLiveTailResponse> StartLiveTailAsync( StartLiveTailRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the StartLiveTail service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | You don't have sufficient permissions to perform this action. |
| InvalidOperationException | The operation is not valid on the specified resource. |
| InvalidParameterException | A parameter is specified incorrectly. |
| LimitExceededException | You have reached the maximum number of resources that can be created. |
| ResourceNotFoundException | The specified resource does not exist. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5