JinDaGe - mcp-sumologic MCP Details

article

README

🚀 MCP Sumo Logic

MCP Sumo Logic是一个集成Sumo Logic API的日志搜索服务器，可用于执行日志搜索操作，为用户提供便捷的日志查询体验。

✨ 主要特性

自定义查询：支持使用自定义查询搜索Sumo Logic日志，满足多样化的搜索需求。
可配置时间范围：允许用户设置可配置的时间范围进行搜索，精准定位所需日志。
全面错误处理：具备全面的错误处理机制，同时提供详细的日志记录，方便问题排查。
Docker支持：支持Docker部署，实现轻松部署和环境隔离。

📦 安装指南

手动安装配置

克隆仓库：将项目仓库克隆到本地。
安装依赖：
```
npm install
```

创建环境变量文件：创建包含所需环境变量的.env文件。

ENDPOINT=https://api.au.sumologic.com/api/v1  # Sumo Logic API端点
SUMO_API_ID=your_api_id                       # Sumo Logic API ID
SUMO_API_KEY=your_api_key                     # Sumo Logic API密钥

构建项目：
```
npm run build
```
启动服务器：
```
npm start
```

Docker 配置

构建Docker镜像：
```
docker build -t mcp/sumologic .
```

运行容器：可选择以下两种方法之一运行容器。

直接使用环境变量：

docker run -e ENDPOINT=your_endpoint -e SUMO_API_ID=your_api_id -e SUMO_API_KEY=your_api_key mcp/sumologic

使用.env文件：

docker run --env-file .env mcp/sumologic

注意：确保你的.env文件包含所需的环境变量：

ENDPOINT=your_endpoint
SUMO_API_ID=your_api_id
SUMO_API_KEY=your_api_key

💻 使用示例

基础用法

服务器提供了一个search-sumologic工具，接受以下参数：

query（必填）：Sumo Logic搜索查询
from（可选）：起始时间，ISO 8601格式
to（可选）：结束时间，ISO 8601格式

示例查询：

const query = '_index=app_pro_fiat_cont | json auto | fields log_identifier';
const results = await search(sumoClient, query, {
  from: '2024-02-23T00:00:00Z',
  to: '2024-02-24T00:00:00Z',
});

🔧 技术细节

错误处理

服务器包含全面的错误处理和日志记录：

捕获并记录API错误细节，方便后续分析和修复。
监控搜索作业状态并记录，让用户随时了解搜索进展。
正确处理网络和身份验证问题，确保服务的稳定性。

开发模式

要在开发模式下运行：

npm run dev

测试

进行测试：

npm test

mcp-sumologic