返回 MCP 目录
public公开dns本地运行

otelcol-mcp

OpenTelemetry Collector的MCP配置服务器实现

article

README

🚀 OpenTelemetry Collector MCP 服务器

本项目是一个用于配置 OpenTelemetry 收集器的 MCP 服务器实现,可实现动态配置与组件管理,为 OpenTelemetry 收集器的使用提供便利。

🚀 快速开始

这是 OpenTelemetry 配置的本地 MCP 服务器实现。使用方法如下:

  1. 克隆仓库
  2. 使用提供的构建脚本构建项目
  3. 配置你的 MCP 客户端以使用该本地服务器实现

✨ 主要特性

  • 动态 OpenTelemetry 配置:通过 MCP 工具配置 OpenTelemetry 收集器
  • 组件管理:添加、移除和配置接收器、处理器和导出器

📦 安装指南

与 mcp 客户端一起使用

在你的 mcp.json 中添加以下内容:

{
    "mcpServers": {
      "otelcol": {
        "url": "http://localhost:3001/sse"
      }
    }
}

💻 使用示例

基础用法

更新资源

使用最新组件信息从 GitHub 更新本地资源文件,无输入参数要求,返回已更新组件的统计信息(接收器、处理器、导出器)。

资源获取

  • 接收器 (receivers://receivers):列出所有可用 OpenTelemetry 接收器,返回接收器元数据,包括名称、描述和稳定性。
  • 处理器 (processors://processors):列出所有可用 OpenTelemetry 处理器,返回处理器元数据,包括名称、描述和稳定性。
  • 导出器 (exporters://exporters):列出所有可用 OpenTelemetry 导出器,返回导出器元数据,包括名称、描述和稳定性。
  • 组件模式 (component://{type}/{name}):获取特定组件的配置模式,支持列出所有可用模式或获取特定组件的模式。
    • 参数:
      • type: 组件类型("receiver", "processor", 或 "exporter")
      • name: 特定组件的名称(可选)

📚 详细文档

资源操作

| 属性 | 详情 | |------|------| | 接收器 | 列出所有可用 OpenTelemetry 接收器,并返回其元数据,包括名称、描述和稳定性 | | 处理器 | 列出所有可用 OpenTelemetry 处理器,并返回其元数据,包括名称、描述和稳定性 | | 导出器 | 列出所有可用 OpenTelemetry 导出器,并返回其元数据,包括名称、描述和稳定性 | | 组件模式 | 获取特定组件的配置模式,支持列出所有可用模式或获取特定组件的模式,需指定组件类型("receiver", "processor", 或 "exporter"),特定组件名称可选 |

配置说明

mcp.json 中添加如下配置,可与 mcp 客户端一起使用:

{
    "mcpServers": {
      "otelcol": {
        "url": "http://localhost:3001/sse"
      }
    }
}

开发流程

本项目是 OpenTelemetry 配置的本地 MCP 服务器实现,使用时需克隆仓库,使用提供的构建脚本构建项目,并配置 MCP 客户端以使用该本地服务器实现。

📄 许可证

此 MCP 服务器根据 GPL-3.0 许可证发布。这意味着你可以自由地使用、修改和分发软件,但需遵守 GPL-3.0 许可证的条款和条件。有关详细信息,请参阅项目存储库中的 LICENSE 文件。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端