Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/albertolinde/cloudwatch-logs-cli
A CLI tool to read and stream AWS CloudWatch logs directly from your terminal. 🚀 Simplify monitoring and debugging with real-time log streaming and easy navigation through log groups. 📊🔍
https://github.com/albertolinde/cloudwatch-logs-cli
Last synced: about 2 months ago
JSON representation
A CLI tool to read and stream AWS CloudWatch logs directly from your terminal. 🚀 Simplify monitoring and debugging with real-time log streaming and easy navigation through log groups. 📊🔍
- Host: GitHub
- URL: https://github.com/albertolinde/cloudwatch-logs-cli
- Owner: AlbertoLinde
- License: mit
- Created: 2024-08-15T17:40:30.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-15T22:48:21.000Z (5 months ago)
- Last Synced: 2024-09-15T21:26:27.922Z (4 months ago)
- Language: JavaScript
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CloudWatch Logs CLI 📊
Tired of logging into CloudWatch via the web or using AWS commands to view logs? 😓 Want a simpler, faster way to do it?
Introducing **CloudWatch Logs CLI**! 🚀 This CLI tool lets you read and stream CloudWatch logs directly from your terminal. Just select the log group and stream logs in real-time. Perfect for quick monitoring and debugging, all from your terminal.
## Features ✨
- **AWS Configuration Check**: Ensures your AWS credentials are set and valid before proceeding.
- **Region Selection**: Choose your AWS region for fetching logs.
- **Log Group Navigation**: Easily navigate through your log groups, including sub-groups.
- **Date Filtering**: Filter log groups by creation date (all, this year, this month, today).
- **Real-Time Streaming**: Stream logs in real-time, updating every 2 seconds.
- **Back Navigation**: Seamlessly navigate back to previous menus.
- **Credentials Handling**: Handles expired or invalid tokens, prompting for new credentials when needed.
- **User-Friendly Interface**: Simple and intuitive prompts to guide you through the process.
## Installation 📦
Make sure you have [Node.js](https://nodejs.org/) (version 18 or higher) installed.
```bash
npm install -g cloudwatch-logs-cli
```
## Usage 🚀
### Start the CLI:
```bash
cwlogs logs
```
### Follow the prompts to:
- Ensure your AWS credentials are configured.
- Select your AWS region.
- Navigate through log groups.
- Stream logs in real-time.
### Stop Streaming:
Press `q` to stop streaming logs and navigate back.
## Prerequisites 🛠
- AWS credentials (Access Key ID, Secret Access Key, and optionally Session Token)
- AWS IAM permissions to access CloudWatch logs
## Example Commands 🌟
```bash
# Start the CLI tool
cwlogs logs
```
## Important Notes 📌
Ensure your AWS credentials are configured. You can provide these when prompted or set them as environment variables:
```bash
export AWS_ACCESS_KEY_ID="your-access-key-id"
export AWS_SECRET_ACCESS_KEY="your-secret-access-key"
export AWS_SESSION_TOKEN="your-session-token" # if applicable
```
## Dependencies 📚
- [Node.js 18+](https://nodejs.org/)
- [AWS SDK for JavaScript (v3)](https://github.com/aws/aws-sdk-js-v3)
- [Inquirer](https://github.com/SBoudrias/Inquirer.js)
- [Chalk](https://github.com/chalk/chalk)
- [Ora](https://github.com/sindresorhus/ora)
## License 📄
This project is licensed under the MIT License.
## Author 👨💻
Developed with ❤️ by [Alberto Linde](https://www.albertolinde.com)
For any queries, you can reach me at [[email protected]](mailto:[email protected])
---
Remember: Monitoring your logs is crucial for maintaining robust and reliable systems. Keep coding and keep improving! 🖥️💪