MCP Sumologic

🚀 MCP Sumo Logic

A log search server integrating the Sumo Logic API for performing log search operations.

✨ Features

• Search Sumo Logic logs using custom queries.
• Conduct searches within a configurable time range.
• Implement comprehensive error handling and detailed logging.
• Support Docker for easy deployment.

📦 Environment Variables

ENDPOINT=https://api.au.sumologic.com/api/v1  # Sumo Logic API endpoint
SUMO_API_ID=your_api_id                       # Sumo Logic API ID
SUMO_API_KEY=your_api_key                     # Sumo Logic API key

📦 Installation and Configuration

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Create a .env file containing the required environment variables.
4. Build the project:

   npm run build
   

5. Start the server:

   npm start
   

📦 Docker Configuration

1. Build the Docker image:

   docker build -t mcp/sumologic .
   

2. Run the container (choose one method): a. Use environment variables directly:

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

   b. Use the .env file:

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

   ⚠️ Important Note

   Ensure that your .env file contains the required environment variables:

   ENDPOINT=your_endpoint
   SUMO_API_ID=your_api_id
   SUMO_API_KEY=your_api_key
   

💻 Usage Examples

Basic Usage

The server provides a search-sumologic tool that accepts the following parameters:

• query (required): Sumo Logic search query.
• from (optional): Start time in ISO 8601 format.
• to (optional): End time in ISO 8601 format.

Example query:

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',
});

🔧 Technical Details

Error Handling

The server includes comprehensive error handling and logging:

• Capture and log API error details.
• Monitor search job status and log it.
• Handle network and authentication issues correctly.

Development

To run in development mode:

npm run dev

To run tests:

npm test