MCP Cloudwatch Tracker

🚀 CloudWatch Log Tracker

An MCP (Model Context Protocol) server for analyzing and debugging AWS CloudWatch logs.

🚀 Quick Start

The CloudWatch Log Tracker is an MCP server designed for analyzing and debugging AWS CloudWatch logs. It offers a range of features to help you search, view, and analyze logs efficiently.

✨ Features

• Search for specific strings in CloudWatch log groups.
• View the context before and after log entries.
• Summarize log analysis results.
• Analyze error logs and troubleshoot the causes.

📦 Installation

Run with NPX

npx -y @juri-dev-lab/mcp-cloudwatch-tracker@latest \
  --aws-access-key-id your_AWS_access_key_ID \
  --aws-secret-access-key your_AWS_secret_key \
  --aws-region your_AWS_region

Run with Docker

# Pull the image from Docker Hub
docker pull juridevlab/mcp-cloudwatch-tracker

# Set environment variables and run
docker run --rm -i \
  -e AWS_ACCESS_KEY_ID=your_AWS_access_key_ID \
  -e AWS_SECRET_ACCESS_KEY=your_AWS_secret_key \
  -e AWS_REGION=your_AWS_region \
  juridevlab/mcp-cloudwatch-tracker

AWS Credential Setup

You can configure AWS credentials using any of the following methods:

1. Use a .env file (recommended for development environments)

# Create a .env file in the project root directory
AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret_key
AWS_REGION=ap-northeast-2

2. Use system environment variables

export AWS_ACCESS_KEY_ID=your_AWS_access_key_ID
export AWS_SECRET_ACCESS_KEY=your_AWS_secret_key
export AWS_REGION=ap-northeast-2

3. Configure credentials using the AWS CLI

aws configure

⚠️ Important Note

• When using a .env file, make sure to add it to .gitignore.
• Never include AWS credentials in your source code or version control system.
• Use separate AWS account credentials.
• It is recommended to use AWS IAM roles in production environments.

Recommended IAM Policy

The minimum permission policy required to access CloudWatch logs:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "logs:GetLogEvents",
        "logs:FilterLogEvents",
        "logs:DescribeLogGroups",
        "logs:DescribeLogStreams"
      ],
      "Resource": "arn:aws:logs:*:*:*"
    }
  ]
}

💻 Usage Examples

Basic Usage

Search Logs

# Search for entries containing a keyword
$ tracker search --keyword "keyword" --log-group /var/log/myapp.log

# Filter logs by conditions
$ tracker filter --start-time "2023-10-01" --end-time "2023-10-02"

View Recent Logs

# View the latest 10 log entries
$ tracker latest --limit 10

📚 Documentation

Development Environment Setup

Clone the Repository

git clone https://github.com/your-repository/mcp-cloudwatch-tracker.git
cd mcp-cloudwatch-tracker

Install Dependencies

npm install

Run the Server

node index.js

Testing

Unit Tests

npm test

Watch Mode

npm run watch

📄 License

MIT