HyperDX 开源平台使用指南

---

项目介绍

HyperDX 是一个开源的可观测性平台，旨在帮助工程师迅速定位生产环境中出现的问题。它通过统一session回放、日志、指标、跟踪和错误数据，提供了一个强大的工具集，以Clickhouse作为其高性能的数据存储后端，并支持OpenTelemetry标准。HyperDX是开发者友好的，被视为Datadog和New Relic等商业服务的开源替代方案。

项目快速启动

环境需求

确保你的系统上安装了Docker，并且至少拥有4GB内存和2个CPU核心。

启动步骤

1. 克隆仓库: 使用Git clone命令获取项目到本地。

   git clone https://github.com/hyperdxio/hyperdx.git
   

2. 启动HyperDX: 进入项目目录并使用Docker Compose启动服务。

   cd hyperdx
   docker-compose up -d
   

3. 访问界面: HyperDX的UI可以通过访问http://localhost:8080来查看。如果需要在防火墙内运行，请确保开放8080、8000和4318端口。

自我演示配置（可选）

为了快速体验，你可以设置环境变量启用自我监控及示例日志。

HYPERDX_API_KEY=your-ingestion-key docker-compose up -d

替换 your-ingestion-key 为你创建账户后得到的API密钥。

应用案例和最佳实践

HyperDX可以广泛应用于多种场景：

• 故障排查: 快速从session回放跳转到相关日志和追踪信息，加速问题定位。
• 性能监控: 监控从HTTP请求到数据库查询的整个链路性能。
• 自动事件模式聚类: 高效识别和分析大量日志中的模式。
• 实时告警: 基于日志、指标或跟踪快速设定告警规则。

最佳实践中，建议：

• 利用OpenTelemetry集成，自动化收集不同组件的追踪和度量。
• 定期审查和优化索引以保持查询性能。
• 制定详细的日志策略，利用结构化日志提高检索效率。

典型生态项目

虽然HyperDX本身即是生态的核心部分，但它的开放架构鼓励社区开发各种插件和扩展。例如，使用OpenTelemetry兼容的库，可以在Java、Python、JavaScript等语言的应用中轻松集成HyperDX，增强跨语言和平台的可观测性支持。

对于特定技术栈的最佳实践和插件，推荐查阅HyperDX的官方文档和社区论坛，那里会有更详尽的指导和案例分享。

---

以上就是HyperDX的基本使用和快速入门指南，深入探索更多高级功能，记得查看项目官网和文档。参与贡献和反馈也是推动开源项目成长的重要方式，欢迎加入HyperDX的开发者行列！