Grafana Loki MCP

🚀 Grafana-Loki MCP 服務器

Grafana-Loki MCP 服務器是一個基於 FastMCP 的服務器，它允許用戶通過 Grafana 對 Loki 日誌進行查詢操作，為日誌管理和分析提供了便利。

🚀 快速開始

在使用 Grafana-Loki MCP 服務器之前，需要進行相應的配置。以下是 MCP 服務器的配置示例：

{
  "mcpServers": {
    "loki": {
      "command": "uvx",
      "args": [
        "grafana-loki-mcp",
        "-u",
        "GRAFANA_URL",
        "-k",
        "GRAFANA_API_KEY"
      ]
    }
  }
}

• GRAFANA_URL：您的 Grafana 實例 URL。
• GRAFANA_API_KEY：具備相應權限的 Grafana API 密鑰。

✨ 主要特性

• 日誌查詢：支持對 Loki 日誌進行查詢操作。
• 標籤與值獲取：可以獲取日誌中的標籤和對應的值。
• 結果格式化：支持將查詢結果格式化為文本、JSON 和 Markdown 三種形式。
• 雙協議支持：支持 stdio 和 SSE 兩種傳輸協議。

📦 安裝指南

使用 pip 安裝

pip install grafana-loki-mcp

開發環境安裝

1. 克隆倉庫：

git clone https://github.com/tumf/grafana-loki-mcp.git
cd grafana-loki-mcp

2. 安裝依賴項：

pip install -r requirements.txt

3. 運行測試：

python -m pytest tests/

💻 使用示例

基礎用法

環境變量設置

export GRAFANA_URL="http://localhost:3000"
export GRAFANA_API_KEY="your_api_key_here"

命令行啟動服務器

grafana-loki-mcp --config config.yaml

示例配置文件 config.yaml

mcpServers:
  loki:
    command: uvx
    args:
      - grafana-loki-mcp
      - -u
      - http://localhost:3000
      - -k
      - your_api_key_here

高級用法

示例代碼

import asyncio
from pygql import client

async def main():
    # 初始化客戶端
    cli = await client("http://localhost:8090")
    
    # 查詢日誌
    results = await cli.call(
        "query_loki",
        {
            "query": '{app="my-app"} |= "error"',
            "limit": 50,
            "max_per_line": 100,
            "start": "now-6h",
            "end": "now"
        }
    )
    
    # 格式化結果
    formatted = await cli.call(
        "format_loki_results",
        {
            "results": results,
            "format_type": "markdown",
            "max_per_line": 100
        }
    )
    
    print(formatted)

asyncio.run(main())

📚 詳細文檔

可用工具

查詢日誌 (query_loki)

{
    "query": "{app=\"my-app\"} |= \"error\"",
    "limit": 50,
    "max_per_line": 100,
    "start": "now-6h",
    "end": "now"
}

獲取標籤 (get_loki_labels)

{
    "query": "{__name__}"
}

格式化結果 (format_loki_results)

{
    "results": "...",
    "format_type": "markdown",
    "max_per_line": 100
}

開發相關

測試

運行測試套件：

pytest tests/ -v

代碼規範

使用以下工具確保代碼規範：

• black 格式化代碼
• flake8 檢查代碼錯誤
• mypy 靜態類型檢查

文檔查看

查看 官方文檔 瞭解詳細信息。

📄 許可證

本項目遵循 MIT 許可證，具體內容請參見 LICENSE 文件。