article
README
🚀 云Watch日志跟踪器
云Watch日志跟踪器是一个用于对AWS CloudWatch日志进行分析和调试的MCP(模型上下文协议)服务器,能够帮助用户高效地从日志中获取关键信息,进行错误排查与分析。
🚀 快速开始
云Watch日志跟踪器可帮助您对AWS CloudWatch日志进行分析和调试。您可以按照以下步骤进行安装和使用。
✨ 主要特性
- 🔍 从CloudWatch日志组中搜索特定字符串。
- 👀 查看日志前后上下文。
- 📊 日志分析结果摘要。
- 🐞 错误日志分析及原因排查。
📦 安装指南
使用NPX运行
npx -y @juri-dev-lab/mcp-cloudwatch-tracker@latest \
--aws-access-key-id 您的 AWS 访问密钥 ID \
--aws-secret-access-key 您的 AWS 密钥\
--aws-region 您的 AWS 区域
使用Docker运行
# 从 Docker Hub 下载镜像
docker pull juridevlab/mcp-cloudwatch-tracker
# 设置环境变量并运行
docker run --rm -i \
-e AWS_ACCESS_KEY_ID=您的 AWS 访问密钥 ID \
-e AWS_SECRET_ACCESS_KEY=您的 AWS 密钥\
-e AWS_REGION=您的 AWS 区域 \
juridevlab/mcp-cloudwatch-tracker
📚 详细文档
AWS凭证设置
请使用以下任一方法配置AWS凭证:
- 使用.env文件(推荐开发环境)
# 在项目根目录下创建 .env 文件
AWS_ACCESS_KEY_ID=your_access_key
AWS_SECRET_ACCESS_KEY=your_secret_key
AWS_REGION=ap-northeast-2
- 使用系统环境变量
export AWS_ACCESS_KEY_ID=您的 AWS 访问密钥 ID
export AWS_SECRET_ACCESS_KEY=您的 AWS 密钥\
export AWS_REGION=ap-northeast-2
- 使用AWS CLI配置凭证
aws configure
⚠️ 重要提示
- 使用.env文件时,请务必将其添加到.gitignore中。
- 切勿将AWS凭证包含在源代码或版本控制系统中。
- 请使用各自独立的AWS账户凭证。
- 建议生产环境使用AWS IAM角色。
推荐的IAM策略
访问CloudWatch日志所需的最小权限策略:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "允许",
"Action": [
"logs:GetLogEvents",
"logs:FilterLogEvents",
"logs:DescribeLogGroups",
"logs:DescribeLogStreams"
],
"Resource": "arn:aws:logs:*:*:*"
}
]
}
💻 使用示例
基础用法
搜索日志
# 搜索包含关键字的条目
$ tracker search --keyword "关键词" --log-group /var/log/myapp.log
# 按条件筛选日志
$ tracker filter --start-time "2023-10-01" --end-time "2023-10-02"
查看最近日志
# 查看最新的 10 条日志
$ tracker latest --limit 10
🔧 技术细节
开发环境设置
克隆代码库
git clone https://github.com/your-repository/mcp-cloudwatch-tracker.git
cd mcp-cloudwatch-tracker
安装依赖项
npm install
运行服务器
node index.js
测试
单元测试
npm test
监视模式
npm run watch
📄 许可证
本项目采用MIT许可证。
微信扫一扫