Umami MCP Server

🚀 Umami

Umami is a powerful and flexible monitoring tool that can meet various performance analysis needs through reasonable configuration and expansion.

🚀 Quick Start

📦 Installation

pip install umami

⚙️ Environment Variable Configuration

Add the following content to the .env file:

UMAMI_DB_TYPE=sqlite
UMAMI_DB_PATH=/var/lib/umami/umami.db
UMAMI_LISTEN_ADDRESS=0.0.0.0
UMAMI_PORT=3000

🚀 Start the Service

umami serve --config ./config.yaml

✨ Features

🔍 Data Collection

• Log Collection: Supports log collection from multiple data sources, including system logs and application logs.
• Metric Monitoring: Monitors server resource usage in real-time, such as CPU, memory, and disk I/O.

💾 Data Storage

CREATE TABLE metrics (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    name TEXT NOT NULL,
    value REAL NOT NULL,
    timestamp DATETIME DEFAULT CURRENT_TIMESTAMP
);

💻 Usage Examples

📊 Performance Analysis

🔧 Create a Monitoring Task

from umami import Monitor

monitor = Monitor()
monitor.start_collection()

📈 Data Visualization

• Dashboard: Provides graphical displays of real-time data, including time series charts and bar charts.
• Report Generation: Automatically generates performance analysis reports, supporting PDF and HTML output formats.

🛠️ Extend Umami Functionality

➕ Add Custom Metrics

from umami import Metric

class CustomMetric(Metric):
    def collect(self):
        return {
            'custom_value': self.get_custom_data()
        }

🔌 Implement a Plugin System

from umami.plugins import Plugin

class MyPlugin(Plugin):
    def on_data_collected(self, data):
        print("New data collected:", data)

🏆 Best Practices

📜 Log Management

• Regularly clean up old logs to avoid excessive storage usage.
• Configure log archiving strategies for long-term analysis and auditing.

⚙️ Performance Tuning

• Adjust the data collection frequency according to actual needs to reduce resource consumption.
• Use efficient database indexes to optimize query performance.

🚑 Troubleshooting

📉 Data Collection Issues

# Check the service status
systemctl status umami

# View logs
journalctl -u umami --since "10 minutes ago"

🔗 Connection Issues

• Ensure the network configuration is correct and the firewall rules allow communication on relevant ports.
• Check if the target server is reachable and confirm network connectivity through a ping test.