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.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon Elastic Compute Cloud (Amazon EC2) instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.
You can use CloudWatch Logs to:
Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.
Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.
Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.
Namespace: Amazon.CloudWatchLogs
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonCloudWatchLogsClient : AmazonServiceClient IAmazonCloudWatchLogs, IDisposable
The AmazonCloudWatchLogsClient type exposes the following members
Name | Description | |
---|---|---|
![]() |
AmazonCloudWatchLogsClient() |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(RegionEndpoint) |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(AmazonCloudWatchLogsConfig) |
Constructs AmazonCloudWatchLogsClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials) | Constructs AmazonCloudWatchLogsClient with AWS Credentials |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials, RegionEndpoint) | Constructs AmazonCloudWatchLogsClient with AWS Credentials |
![]() |
AmazonCloudWatchLogsClient(AWSCredentials, AmazonCloudWatchLogsConfig) | Constructs AmazonCloudWatchLogsClient with AWS Credentials and an AmazonCloudWatchLogsClient Configuration object. |
![]() |
AmazonCloudWatchLogsClient(string, string) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, RegionEndpoint) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, AmazonCloudWatchLogsConfig) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. |
![]() |
AmazonCloudWatchLogsClient(string, string, string) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, string, RegionEndpoint) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudWatchLogsClient(string, string, string, AmazonCloudWatchLogsConfig) | Constructs AmazonCloudWatchLogsClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudWatchLogsClient Configuration object. |
Name | Description | |
---|---|---|
![]() |
CancelExportTask(CancelExportTaskRequest) |
Cancels an export task if it is in PENDING or RUNNING state.
|
![]() |
CancelExportTaskAsync(CancelExportTaskRequest, CancellationToken) | Initiates the asynchronous execution of the CancelExportTask operation. |
![]() |
CreateExportTask(CreateExportTaskRequest) |
Creates an ExportTask which allows you to efficiently export data from
a Log Group to your Amazon S3 bucket.
This is an asynchronous call. If all the required information is provided, this API
will initiate an export task and respond with the task Id. Once started, You can export logs from multiple log groups or multiple time ranges to the same Amazon S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects. |
![]() |
CreateExportTaskAsync(CreateExportTaskRequest, CancellationToken) | Initiates the asynchronous execution of the CreateExportTask operation. |
![]() |
CreateLogGroup(CreateLogGroupRequest) |
Creates a new log group with the specified name. The name of the log group must be
unique within a region for an AWS account. You can create up to 500 log groups per
account.
You must use the following guidelines when naming a log group:
|
![]() |
CreateLogGroupAsync(CreateLogGroupRequest, CancellationToken) | Initiates the asynchronous execution of the CreateLogGroup operation. |
![]() |
CreateLogStream(CreateLogStreamRequest) |
Creates a new log stream in the specified log group. The name of the log stream must
be unique within the log group. There is no limit on the number of log streams that
can exist in a log group.
You must use the following guidelines when naming a log stream:
|
![]() |
CreateLogStreamAsync(CreateLogStreamRequest, CancellationToken) | Initiates the asynchronous execution of the CreateLogStream operation. |
![]() |
DeleteDestination(DeleteDestinationRequest) | Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. |
![]() |
DeleteDestinationAsync(DeleteDestinationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDestination operation. |
![]() |
DeleteLogGroup(DeleteLogGroupRequest) | Deletes the log group with the specified name and permanently deletes all the archived log events associated with it. |
![]() |
DeleteLogGroupAsync(DeleteLogGroupRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteLogGroup operation. |
![]() |
DeleteLogStream(DeleteLogStreamRequest) | Deletes a log stream and permanently deletes all the archived log events associated with it. |
![]() |
DeleteLogStreamAsync(DeleteLogStreamRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteLogStream operation. |
![]() |
DeleteMetricFilter(DeleteMetricFilterRequest) | Deletes a metric filter associated with the specified log group. |
![]() |
DeleteMetricFilterAsync(DeleteMetricFilterRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteMetricFilter operation. |
![]() |
DeleteRetentionPolicy(DeleteRetentionPolicyRequest) | Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. |
![]() |
DeleteRetentionPolicyAsync(DeleteRetentionPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteRetentionPolicy operation. |
![]() |
DeleteSubscriptionFilter(DeleteSubscriptionFilterRequest) | Deletes a subscription filter associated with the specified log group. |
![]() |
DeleteSubscriptionFilterAsync(DeleteSubscriptionFilterRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSubscriptionFilter operation. |
![]() |
DescribeDestinations(DescribeDestinationsRequest) |
Returns all the destinations that are associated with the AWS account making the
request. The list returned in the response is ASCII-sorted by destination name.
By default, this operation returns up to 50 destinations. If there are more destinations
to list, the response would contain a |
![]() |
DescribeDestinationsAsync(DescribeDestinationsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDestinations operation. |
![]() |
DescribeExportTasks(DescribeExportTasksRequest) |
Returns all the export tasks that are associated with the AWS account making the
request. The export tasks can be filtered based on TaskId or TaskStatus .
By default, this operation returns up to 50 export tasks that satisfy the specified
filters. If there are more export tasks to list, the response would contain a |
![]() |
DescribeExportTasksAsync(DescribeExportTasksRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeExportTasks operation. |
![]() |
DescribeLogGroups() |
Returns all the log groups that are associated with the AWS account making the request.
The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more log groups
to list, the response would contain a |
![]() |
DescribeLogGroups(DescribeLogGroupsRequest) |
Returns all the log groups that are associated with the AWS account making the request.
The list returned in the response is ASCII-sorted by log group name.
By default, this operation returns up to 50 log groups. If there are more log groups
to list, the response would contain a |
![]() |
DescribeLogGroupsAsync(DescribeLogGroupsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLogGroups operation. |
![]() |
DescribeLogStreams(DescribeLogStreamsRequest) |
Returns all the log streams that are associated with the specified log group. The
list returned in the response is ASCII-sorted by log stream name.
By default, this operation returns up to 50 log streams. If there are more log streams
to list, the response would contain a |
![]() |
DescribeLogStreamsAsync(DescribeLogStreamsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeLogStreams operation. |
![]() |
DescribeMetricFilters(DescribeMetricFiltersRequest) |
Returns all the metrics filters associated with the specified log group. The list
returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 metric filters. If there are more metric
filters to list, the response would contain a |
![]() |
DescribeMetricFiltersAsync(DescribeMetricFiltersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeMetricFilters operation. |
![]() |
DescribeSubscriptionFilters(DescribeSubscriptionFiltersRequest) |
Returns all the subscription filters associated with the specified log group. The
list returned in the response is ASCII-sorted by filter name.
By default, this operation returns up to 50 subscription filters. If there are more
subscription filters to list, the response would contain a |
![]() |
DescribeSubscriptionFiltersAsync(DescribeSubscriptionFiltersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSubscriptionFilters operation. |
![]() |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
FilterLogEvents(FilterLogEventsRequest) |
Retrieves log events, optionally filtered by a filter pattern from the specified
log group. You can provide an optional time range to filter the results on the event
timestamp . You can limit the streams searched to an explicit
list of logStreamNames .
By default, this operation returns as much matching log events as can fit in a response
size of 1MB, up to 10,000 log events, or all the events found within a time-bounded
scan window. If the response includes a |
![]() |
FilterLogEventsAsync(FilterLogEventsRequest, CancellationToken) | Initiates the asynchronous execution of the FilterLogEvents operation. |
![]() |
GetLogEvents(GetLogEventsRequest) |
Retrieves log events from the specified log stream. You can provide an optional time
range to filter the results on the event timestamp .
By default, this operation returns as much log events as can fit in a response size
of 1MB, up to 10,000 log events. The response will always include a |
![]() |
GetLogEventsAsync(GetLogEventsRequest, CancellationToken) | Initiates the asynchronous execution of the GetLogEvents operation. |
![]() |
PutDestination(PutDestinationRequest) |
Creates or updates a Destination . A destination encapsulates a physical
resource (such as a Kinesis stream) and allows you to subscribe to a real-time stream
of log events of a different account, ingested through PutLogEvents
requests. Currently, the only supported physical resource is a Amazon Kinesis stream
belonging to the same account as the destination.
A destination controls what is written to its Amazon Kinesis stream through an access
policy. By default, PutDestination does not set any access policy with the destination,
which means a cross-account user will not be able to call |
![]() |
PutDestinationAsync(PutDestinationRequest, CancellationToken) | Initiates the asynchronous execution of the PutDestination operation. |
![]() |
PutDestinationPolicy(PutDestinationPolicyRequest) |
Creates or updates an access policy associated with an existing Destination .
An access policy is an IAM
policy document that is used to authorize claims to register a subscription filter
against a given destination.
|
![]() |
PutDestinationPolicyAsync(PutDestinationPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the PutDestinationPolicy operation. |
![]() |
PutLogEvents(PutLogEventsRequest) |
Uploads a batch of log events to the specified log stream.
Every PutLogEvents request must include the The batch of events must satisfy the following constraints:
|
![]() |
PutLogEventsAsync(PutLogEventsRequest, CancellationToken) | Initiates the asynchronous execution of the PutLogEvents operation. |
![]() |
PutMetricFilter(PutMetricFilterRequest) |
Creates or updates a metric filter and associates it with the specified log group.
Metric filters allow you to configure rules to extract metric data from log events
ingested through PutLogEvents requests.
The maximum number of metric filters that can be associated with a log group is 100. |
![]() |
PutMetricFilterAsync(PutMetricFilterRequest, CancellationToken) | Initiates the asynchronous execution of the PutMetricFilter operation. |
![]() |
PutRetentionPolicy(PutRetentionPolicyRequest) | Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group. |
![]() |
PutRetentionPolicyAsync(PutRetentionPolicyRequest, CancellationToken) | Initiates the asynchronous execution of the PutRetentionPolicy operation. |
![]() |
PutSubscriptionFilter(PutSubscriptionFilterRequest) |
Creates or updates a subscription filter and associates it with the specified log
group. Subscription filters allow you to subscribe to a real-time stream of log events
ingested through PutLogEvents requests and have them delivered
to a specific destination. Currently, the supported destinations are:
Currently there can only be one subscription filter associated with a log group. |
![]() |
PutSubscriptionFilterAsync(PutSubscriptionFilterRequest, CancellationToken) | Initiates the asynchronous execution of the PutSubscriptionFilter operation. |
![]() |
TestMetricFilter(TestMetricFilterRequest) | Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern. |
![]() |
TestMetricFilterAsync(TestMetricFilterRequest, CancellationToken) | Initiates the asynchronous execution of the TestMetricFilter operation. |
Name | Description | |
---|---|---|
![]() |
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5