What is @aws-sdk/client-cloudwatch-logs?
The @aws-sdk/client-cloudwatch-logs npm package allows developers to interact with the Amazon CloudWatch Logs service. This service provides monitoring, storing, and accessing log files from Amazon EC2 instances, AWS CloudTrail, and other sources. The package enables programmatic access to all the features of CloudWatch Logs, such as creating and managing log groups and streams, sending log events, and querying log data.
What are @aws-sdk/client-cloudwatch-logs's main functionalities?
Creating a Log Group
This feature allows you to create a new log group in CloudWatch Logs. A log group is a collection of log streams that share the same retention, monitoring, and access control settings.
const { CloudWatchLogsClient, CreateLogGroupCommand } = require('@aws-sdk/client-cloudwatch-logs');
const client = new CloudWatchLogsClient({ region: 'us-west-2' });
const command = new CreateLogGroupCommand({ logGroupName: 'my-log-group' });
client.send(command);
Creating a Log Stream
This feature allows you to create a log stream within a log group. A log stream represents a sequence of log events that share the same source.
const { CloudWatchLogsClient, CreateLogStreamCommand } = require('@aws-sdk/client-cloudwatch-logs');
const client = new CloudWatchLogsClient({ region: 'us-west-2' });
const command = new CreateLogStreamCommand({ logGroupName: 'my-log-group', logStreamName: 'my-log-stream' });
client.send(command);
Putting Log Events
This feature allows you to send log data to a log stream in CloudWatch Logs. Each log event consists of a timestamp and a message.
const { CloudWatchLogsClient, PutLogEventsCommand } = require('@aws-sdk/client-cloudwatch-logs');
const client = new CloudWatchLogsClient({ region: 'us-west-2' });
const command = new PutLogEventsCommand({
logGroupName: 'my-log-group',
logStreamName: 'my-log-stream',
logEvents: [{ timestamp: Date.now(), message: 'This is a log message.' }]
});
client.send(command);
Searching and Filtering Log Data
This feature allows you to search and filter log data within a log group. You can specify a filter pattern, as well as a time range for the search.
const { CloudWatchLogsClient, FilterLogEventsCommand } = require('@aws-sdk/client-cloudwatch-logs');
const client = new CloudWatchLogsClient({ region: 'us-west-2' });
const command = new FilterLogEventsCommand({
logGroupName: 'my-log-group',
filterPattern: 'ERROR',
startTime: Date.now() - 3600000,
endTime: Date.now()
});
client.send(command);
Other packages similar to @aws-sdk/client-cloudwatch-logs
winston-cloudwatch
winston-cloudwatch is a transport for the popular logging library winston, which allows you to send your logs to Amazon CloudWatch. Unlike @aws-sdk/client-cloudwatch-logs, which is the official AWS SDK for JavaScript, winston-cloudwatch integrates with the winston logging framework and provides a more streamlined way to log directly from your application.
pino-cloudwatch
pino-cloudwatch is a module that streams pino logs to Amazon CloudWatch. Pino is a very low overhead Node.js logger. This package is similar to @aws-sdk/client-cloudwatch-logs in that it allows logging to CloudWatch, but it is specifically designed to work with the pino logging library and focuses on performance.
@aws-sdk/client-cloudwatch-logs
Description
AWS SDK for JavaScript CloudWatchLogs Client for Node.js, Browser and React Native.
You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use
CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch
Logs SDK.
You can use CloudWatch Logs to:
-
Monitor logs from 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. Then,
it can send you a notification whenever the rate of errors exceeds a threshold that 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"). You can also 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
CloudWatch metric that you specify.
-
Monitor CloudTrail logged events: You can
create alarms in CloudWatch and receive notifications of particular API activity as
captured by CloudTrail. You can 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 earlier than this setting are automatically deleted. The CloudWatch
Logs agent helps 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.
Installing
To install this package, simply type add or install @aws-sdk/client-cloudwatch-logs
using your favorite package manager:
npm install @aws-sdk/client-cloudwatch-logs
yarn add @aws-sdk/client-cloudwatch-logs
pnpm add @aws-sdk/client-cloudwatch-logs
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CloudWatchLogsClient
and
the commands you need, for example ListAnomaliesCommand
:
const { CloudWatchLogsClient, ListAnomaliesCommand } = require("@aws-sdk/client-cloudwatch-logs");
import { CloudWatchLogsClient, ListAnomaliesCommand } from "@aws-sdk/client-cloudwatch-logs";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new CloudWatchLogsClient({ region: "REGION" });
const params = {
};
const command = new ListAnomaliesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-cloudwatch-logs";
const client = new AWS.CloudWatchLogs({ region: "REGION" });
try {
const data = await client.listAnomalies(params);
} catch (error) {
}
client
.listAnomalies(params)
.then((data) => {
})
.catch((error) => {
});
client.listAnomalies(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-cloudwatch-logs
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AssociateKmsKey
Command API Reference / Input / Output
CancelExportTask
Command API Reference / Input / Output
CreateDelivery
Command API Reference / Input / Output
CreateExportTask
Command API Reference / Input / Output
CreateLogAnomalyDetector
Command API Reference / Input / Output
CreateLogGroup
Command API Reference / Input / Output
CreateLogStream
Command API Reference / Input / Output
DeleteAccountPolicy
Command API Reference / Input / Output
DeleteDataProtectionPolicy
Command API Reference / Input / Output
DeleteDelivery
Command API Reference / Input / Output
DeleteDeliveryDestination
Command API Reference / Input / Output
DeleteDeliveryDestinationPolicy
Command API Reference / Input / Output
DeleteDeliverySource
Command API Reference / Input / Output
DeleteDestination
Command API Reference / Input / Output
DeleteIndexPolicy
Command API Reference / Input / Output
DeleteIntegration
Command API Reference / Input / Output
DeleteLogAnomalyDetector
Command API Reference / Input / Output
DeleteLogGroup
Command API Reference / Input / Output
DeleteLogStream
Command API Reference / Input / Output
DeleteMetricFilter
Command API Reference / Input / Output
DeleteQueryDefinition
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteRetentionPolicy
Command API Reference / Input / Output
DeleteSubscriptionFilter
Command API Reference / Input / Output
DeleteTransformer
Command API Reference / Input / Output
DescribeAccountPolicies
Command API Reference / Input / Output
DescribeConfigurationTemplates
Command API Reference / Input / Output
DescribeDeliveries
Command API Reference / Input / Output
DescribeDeliveryDestinations
Command API Reference / Input / Output
DescribeDeliverySources
Command API Reference / Input / Output
DescribeDestinations
Command API Reference / Input / Output
DescribeExportTasks
Command API Reference / Input / Output
DescribeFieldIndexes
Command API Reference / Input / Output
DescribeIndexPolicies
Command API Reference / Input / Output
DescribeLogGroups
Command API Reference / Input / Output
DescribeLogStreams
Command API Reference / Input / Output
DescribeMetricFilters
Command API Reference / Input / Output
DescribeQueries
Command API Reference / Input / Output
DescribeQueryDefinitions
Command API Reference / Input / Output
DescribeResourcePolicies
Command API Reference / Input / Output
DescribeSubscriptionFilters
Command API Reference / Input / Output
DisassociateKmsKey
Command API Reference / Input / Output
FilterLogEvents
Command API Reference / Input / Output
GetDataProtectionPolicy
Command API Reference / Input / Output
GetDelivery
Command API Reference / Input / Output
GetDeliveryDestination
Command API Reference / Input / Output
GetDeliveryDestinationPolicy
Command API Reference / Input / Output
GetDeliverySource
Command API Reference / Input / Output
GetIntegration
Command API Reference / Input / Output
GetLogAnomalyDetector
Command API Reference / Input / Output
GetLogEvents
Command API Reference / Input / Output
GetLogGroupFields
Command API Reference / Input / Output
GetLogRecord
Command API Reference / Input / Output
GetQueryResults
Command API Reference / Input / Output
GetTransformer
Command API Reference / Input / Output
ListAnomalies
Command API Reference / Input / Output
ListIntegrations
Command API Reference / Input / Output
ListLogAnomalyDetectors
Command API Reference / Input / Output
ListLogGroupsForQuery
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTagsLogGroup
Command API Reference / Input / Output
PutAccountPolicy
Command API Reference / Input / Output
PutDataProtectionPolicy
Command API Reference / Input / Output
PutDeliveryDestination
Command API Reference / Input / Output
PutDeliveryDestinationPolicy
Command API Reference / Input / Output
PutDeliverySource
Command API Reference / Input / Output
PutDestination
Command API Reference / Input / Output
PutDestinationPolicy
Command API Reference / Input / Output
PutIndexPolicy
Command API Reference / Input / Output
PutIntegration
Command API Reference / Input / Output
PutLogEvents
Command API Reference / Input / Output
PutMetricFilter
Command API Reference / Input / Output
PutQueryDefinition
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
PutRetentionPolicy
Command API Reference / Input / Output
PutSubscriptionFilter
Command API Reference / Input / Output
PutTransformer
Command API Reference / Input / Output
StartLiveTail
Command API Reference / Input / Output
StartQuery
Command API Reference / Input / Output
StopQuery
Command API Reference / Input / Output
TagLogGroup
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
TestMetricFilter
Command API Reference / Input / Output
TestTransformer
Command API Reference / Input / Output
UntagLogGroup
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateAnomaly
Command API Reference / Input / Output
UpdateDeliveryConfiguration
Command API Reference / Input / Output
UpdateLogAnomalyDetector
Command API Reference / Input / Output