Skip to content

Commit 7983eb3

Browse files
bryceitoc9bryceitoc9
authored
Updating extension-readme for CloudWatch Logs functionality (#1253)
1 parent 6d7215a commit 7983eb3

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

‎extension-readme.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@ See [Setup](#additional-setup-steps) for installation requirements, or [Get help
99

1010
- [AWS Explorer](#ui-components-aws-expl)
1111
- CloudFormation stacks
12+
- CloudWatch Logs
1213
- EventBridge schemas
1314
- Lambda functions
1415
- S3 explorer
1516
- Step Functions
1617
- [CDK Explorer](#ui-components-cdk-expl)
1718
- [AWS Serverless Applications (SAM)](#sam-and-lambda)
19+
- [Amazon CloudWatch Logs](#cloudwatchlogs)
1820
- [Amazon EventBridge Schemas](#eventbridge)
1921
- [Amazon ECS task definition files](#ecs-files)
2022
- [AWS Step Functions](#sfn-files)
@@ -99,6 +101,29 @@ For more information see [Working with AWS Serverless Applications](https://docs
99101

100102
---
101103

104+
## <a id="cloudwatchlogs"></a>Amazon CloudWatch Logs
105+
106+
The AWS Toolkit provides support for [Amazon CloudWatch Logs](https://aws.amazon.com/cloudwatch/). Using the [AWS Explorer](#ui-components-aws-expl) of the Toolkit, you can perform the following operations on Log Groups:
107+
108+
- List CloudWatch Log Groups
109+
- View Log Streams for a Log Group
110+
111+
Viewing a Log Stream will immediately load the most recent 10,000 lines or 1 MB of data (whichever is smaller), and their timestamps. From this view, users can access the following actions:
112+
113+
- Load older or newer log events
114+
- Save currently-loaded Log Stream to a log file
115+
- Copy Log Stream name
116+
117+
Example:
118+
119+
![View Log Groups](./resources/marketplace/cloudwatch-logs.png)
120+
121+
For full details, see [Working with CloudWatch Logs](https://docs.aws.amazon.com/console/toolkit-for-vscode/latest/userguide/cloudwatchlogs.html) in the Toolkit's user guide.
122+
123+
{ [Return to Top](#top) }
124+
125+
---
126+
102127
## <a id="eventbridge"></a>Amazon EventBridge Schemas
103128

104129
The AWS Toolkit provides support for [Amazon EventBridge](https://aws.amazon.com/eventbridge) schemas. Using the [AWS Explorer](#ui-components-aws-expl) of the Toolkit, you can perform the following operations on these schemas:
@@ -161,6 +186,7 @@ palette_, available by selecting _View > Command Palette_ or by typing
161186
| :--------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
162187
| `AWS: About AWS Toolkit` | Displays information about the AWS Toolkit. |
163188
| `AWS: Connect to AWS` | Connects the Toolkit to an AWS account. For more information, see [Connecting to AWS](https://docs.aws.amazon.com/console/toolkit-for-vscode/connect) in the user guide. |
189+
| `AWS: Copy Log Stream Name` | Copies the name of the active CloudWatch Log Stream |
164190
| `AWS: Create a new Step Functions state machine` | Generates a new Amazon States Language definition to use as the definition for a new Step Functions state machine. For more information, see [State Machine Templates](https://docs.aws.amazon.com//toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#templates-stepfunctions) in the user guide. |
165191
| `AWS: Create a new Issue on Github` | Opens the AWS Toolkit's [New Issue page on Github](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
166192
| `AWS: Create Credentials Profile` | Creates an AWS credentials profile. For more information, see [Setting Up Your AWS Credentials](https://docs.aws.amazon.com/console/toolkit-for-vscode/setup-credentials) in the user guide. |
@@ -172,6 +198,7 @@ palette_, available by selecting _View > Command Palette_ or by typing
172198
| `AWS: Publish state machine to Step Functions` | Creates or updates a remote state machine using the local Amazon States Language definition file. For more information, see [Work With State Machines in VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#starting-stepfunctions) in the user guide. |
173199
| `AWS: Render state machine graph` | Renders the state machine definition into a graph visualization. For more information, see [State Machine Graph Visualization](https://docs.aws.amazon.com//toolkit-for-vscode/latest/userguide/bulding-stepfunctions.html#bulding-stepfunctions-visualizations) in the user guide. |
174200
| `AWS: Report an Issue` | In the [GitHub repository](https://github.com/aws/aws-toolkit-vscode) for the Toolkit, opens the page to [create a new issue](https://github.com/aws/aws-toolkit-vscode/issues/new/choose). |
201+
| `AWS: Save Current Log Content To File` | Saves currently-loaded CloudWatch Log Stream data to a local `.log` file. |
175202
| `AWS: Show region in the Explorer` | Displays an AWS Region in the **AWS Explorer**. |
176203
| `AWS: Sign out` | Disconnects the Toolkit from the currently-connected AWS account. |
177204
| `AWS: Submit Quick Feedback...` | Submit a private, one-way message and sentiment to the AWS Toolkit dev team. For larger issues that warrant conversations or bugfixes, please submit an issue in Github with the **AWS: Create a New Issue on Github** command. |

‎resources/marketplace/cloudwatch-logs.png‎

80.7 KB
Loading

0 commit comments

Comments
 (0)