MCP Sumologic

🚀 MCP Sumo Logic

MCP Sumo Logic是一個集成Sumo Logic API的日誌搜索服務器，可幫助用戶輕鬆執行日誌搜索操作，為日誌管理和分析提供便利。

🚀 快速開始

本項目可幫助你利用Sumo Logic API進行日誌搜索。以下是啟動項目的步驟：

1. 克隆倉庫
2. 安裝依賴：

   npm install
   

3. 創建包含所需環境變量的.env文件
4. 構建項目：

   npm run build
   

5. 啟動服務器：

   npm start
   

✨ 主要特性

• 自定義查詢：支持使用自定義查詢搜索Sumo Logic日誌，滿足多樣化的搜索需求。
• 靈活時間範圍：可配置的時間範圍進行搜索，讓你精準定位所需日誌。
• 全面錯誤處理：具備全面的錯誤處理和詳細的日誌記錄，保障系統穩定運行。
• 輕鬆部署：支持Docker，實現輕鬆部署。

📦 安裝指南

常規安裝

1. 克隆倉庫
2. 安裝依賴：

   npm install
   

3. 創建包含所需環境變量的.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密鑰

4. 構建項目：

   npm run build
   

5. 啟動服務器：

   npm start
   

Docker安裝

1. 構建Docker鏡像：

   docker build -t mcp/sumologic .
   

2. 運行容器（選擇一種方法）：

   a. 直接使用環境變量：

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

   b. 使用.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