@aws-sdk/client-cloudwatch-logs

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.

README

@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, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS 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 and 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") 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 CloudWatch metric that you specify.

• Monitor AWS 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 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.

Installing

To install the 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 AssociateKmsKeyCommand:

// ES5 example
const { CloudWatchLogsClient, AssociateKmsKeyCommand } = require("@aws-sdk/client-cloudwatch-logs");

// ES6+ example
import { CloudWatchLogsClient, AssociateKmsKeyCommand } 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.

// a client can be shared by difference commands.
const client = new CloudWatchLogsClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new AssociateKmsKeyCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // 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) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and 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" });

// async/await.
try {
  const data = client.associateKmsKey(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .associateKmsKey(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.associateKmsKey(params, (err, data) => {
  // proccess err and 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);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

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.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

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.

Changelog

3.6.1 (2021-02-22)

Bug Fixes

• update references of default branch from master to main (#2057) (59b8b58)