机器翻译正文由机器翻译自项目原始文档（英文），排版经程序统一处理，可能存在偏差，请以原项目仓库为准。

HyperDX

HyperDX，作为 ClickStack 的核心组件，帮助工程师快速找出生产环境出问题的原因，它通过在任何 ClickHouse 集群上轻松搜索和可视化日志与追踪（想象一下 Kibana，但用于 ClickHouse）来实现这一点。

文档 • 在 Discord 聊天 • 实时演示 • 错误报告 • 贡献 • 网站

• 🕵️ 在一个地方关联/搜索日志、指标、会话重放和追踪
• 📝 与模式无关，可在现有 ClickHouse 模式之上工作
• 🔥 为 ClickHouse 优化的超快速搜索与可视化
• 🔍 直观的全文搜索和属性搜索语法（例如 level:err），SQL 可选！
• 📊 通过事件增量分析异常趋势
• 🔔 只需几次点击即可设置警报
• 📈 在无需复杂查询语言的情况下，仪表板显示高基数事件
• { 本地 JSON 字符串查询
• ⚡ 实时尾部查看日志和追踪，以获取最新事件
• 🔭 开箱即用支持 OpenTelemetry
• ⏱️ 从 HTTP 请求到数据库查询（APM）监控健康状况和性能

启动 HyperDX

HyperDX 可以作为 ClickStack 的一部分进行部署，ClickStack 包括 ClickHouse、HyperDX、OpenTelemetry Collector 和 MongoDB。

docker run -p 8080:8080 -p 4317:4317 -p 4318:4318 docker.hyperdx.io/hyperdx/hyperdx-all-in-one

之后，您可以访问 http://localhost:8080 以访问 HyperDX 用户界面。

如果您已经有现有的 ClickHouse 实例，想在本地使用单个容器，或在寻找生产环境部署说明，您可以在我们的 部署文档 中查看不同的部署选项。

如果您的服务器在防火墙后面，您需要在防火墙上打开/转发端口 8080，
分别用于用户界面、API 和 OTel 收集器的端口 8000 和 4318。

我们建议测试环境至少使用 4GB 内存和 2 个核心。

托管 ClickHouse 云

您也可以使用 ClickHouse Cloud 部署 HyperDX，您可以免费注册并在几分钟内开始使用。

为您的应用程序添加监控

为了将日志、指标、追踪、会话回放等发送到 HyperDX，您需要对您的应用程序进行监控，使其收集并发送遥测数据到您的 HyperDX 实例。

我们提供一套 SDK 和集成选项，以便更容易开始使用 HyperDX，例如 浏览器、Node.js 和 Python。

您可以在 我们的文档 中找到完整列表。

开放遥测

此外，HyperDX 兼容 OpenTelemetry，这是由 CNCF 支持的用于应用程序监控的供应商中立标准。支持的语言/平台包括：

• Kubernetes
• JavaScript
• Python
• Java
• 去
• 红宝石
• PHP
• .NET
• 灵丹
• 锈

(完整列表 请点击这里)

一旦 HyperDX 运行，你可以将你的 OpenTelemetry SDK 指向在 http://localhost:4318 启动的 OpenTelemetry 收集器。

HyperDX 命令行工具

更喜欢终端吗？ @hyperdx/cli 提供一个交互式 TUI 和 CLI ( hdx )，让你在不离开 shell 的情况下操作 HyperDX 数据：

npm install -g @hyperdx/cli
hdx auth login
hdx tui

• 🖥️ 交互式 TUI — 使用 vim 风格快捷键搜索、实时追踪日志和瀑布图
• 📊 在终端中以 ANSI 输出呈现仪表盘模块和临时图表
• 🤖 适合代理：原生 SQL 查询、NDJSON 输出，以及用于脚本和 AI 代理的 Drain 日志模式挖掘

请参阅 CLI README 获取完整命令参考。

贡献

我们欢迎所有贡献！参与项目的方式有很多，包括但不限于：

• 打开一个 PR（贡献指南）
• 提交功能请求或错误
• 改进我们的产品或贡献文档
• 开放问题 投票或为功能请求提交使用案例

拉取请求。 问题、错误报告和讨论对所有人开放。对于代码，我们现在使用 Vouch：维护者必须在您的第一次拉取请求被审核之前为您担保。AI 工具可以轻松生成看似合理但没有实际理解的拉取请求，这样的审查会抢占我们想要投入时间的贡献。获得担保只需一个问题 — 打个招呼并告诉我们您想从事的工作。请参阅 获取担保。

动机

我们的使命是帮助工程师交付可靠的软件。为了实现这一目标，我们相信每位工程师都需要能够轻松利用生产环境的遥测数据，快速解决紧急生产问题。

然而，根据我们的经验，我们使用的现有工具在几个方面往往不足：

1. 它们价格昂贵，而且价格未能随着 TB 级遥测数据的普及而扩展，导致团队不得不大幅削减可收集的数据量。
2. 它们难以使用，需要全职 SRE 进行设置，并且需要领域专家才能自信使用。
3. 它们需要在不同工具之间切换（日志、会话重放、APM、异常等）来自己拼接线索。

我们希望您尝试 ClickStack 中的 HyperDX，并告诉我们您的使用体验！

联系方式

• 打开问题
• Discord
• 电子邮件

HyperDX 使用数据

HyperDX 会为开源部署收集匿名使用数据。这些数据支持我们的使命，使任何团队都能获得可观测性，同时帮助支持我们的开源产品在各种不同环境中运行。虽然我们希望您继续以这种方式支持我们的使命，但您可以通过将 USAGE_STATS_ENABLED 环境变量设置为 false 来选择退出使用数据收集。感谢您支持 HyperDX 的开发！

许可证

MIT