官方文档参考

Uptrace 是开源的 APM 和可观测性平台,本文档汇总了 Uptrace 官方文档的重要链接和资源,帮助您深入了解 Uptrace 的功能和使用方法。

官方文档入口

主要文档页面

1. 快速开始(Get Started)

链接:https://uptrace.dev/get

内容:

  • 快速开始指南
  • DSN 配置说明
  • 各语言 SDK 接入方法
  • 示例代码和配置

适用场景:

  • 首次使用 Uptrace
  • 需要快速接入应用
  • 查找语言特定的接入方法

2. 数据接入(Ingest)

链接:https://uptrace.dev/ingest

内容:

  • 支持的数据接入方式
  • OpenTelemetry SDK 接入
  • OpenTelemetry Collector 配置
  • Prometheus、CloudWatch 等数据源接入
  • 日志收集工具(Vector、Fluent Bit)配置

适用场景:

  • 需要了解数据接入方法
  • 配置 OpenTelemetry Collector
  • 接入非 OpenTelemetry 数据源

3. 功能特性(Features)

链接:https://uptrace.dev/features

内容:

  • 告警和通知配置
  • 图表标注功能
  • Dashboard 创建
  • 数据转换和过滤
  • 服务拓扑图
  • Grafana 集成
  • JSON API 使用

适用场景:

  • 深入了解平台功能
  • 配置告警规则
  • 创建自定义 Dashboard
  • 集成其他工具

功能特性详解

告警和通知(Alerts and Notifications)

文档:https://uptrace.dev/features/alerting

功能:

  • 基于 Metrics 和错误的告警
  • 多种通知渠道(邮件、Slack、Telegram 等)
  • 告警规则配置
  • 告警抑制和恢复

内部平台说明:

  • 内部平台支持相同的告警功能
  • 通知渠道可能有所不同,请参考平台设置

图表标注(Chart Annotations)

文档:https://uptrace.dev/features/annotations

功能:

  • 在图表上添加标注
  • 记录重要事件和变更
  • 提供上下文信息

Dashboard

文档:https://uptrace.dev/features/dashboards

功能:

  • 创建自定义 Dashboard
  • 使用 PromQL 查询数据
  • 多种图表类型
  • Dashboard 共享

数据转换(Transformations)

文档:https://uptrace.dev/features/transformations

功能:

  • 重命名和删除属性
  • 解析和转换属性值
  • 数据过滤和路由

服务拓扑(Service Graph)

文档:https://uptrace.dev/features/service-graph

功能:

  • 可视化服务依赖关系
  • 性能指标展示
  • 服务健康状态监控

Grafana 集成

文档:https://uptrace.dev/features/grafana

功能:

  • 配置 Grafana 使用 Uptrace 作为数据源
  • Prometheus 兼容性
  • 在 Grafana 中查询 Uptrace 数据

JSON API

文档:https://uptrace.dev/features/json-api

功能:

  • 通过 API 查询数据
  • 程序化访问 Uptrace 功能
  • API 认证和使用

数据接入方法

OpenTelemetry SDK

文档:https://uptrace.dev/ingest/opentelemetry

支持的语言:

  • Go
  • Python
  • Java
  • JavaScript/Node.js
  • .NET
  • Ruby
  • Rust
  • PHP
  • Erlang/Elixir

内部平台说明:

  • 内部平台完全支持 OpenTelemetry SDK
  • 使用内部端点:uptrace-grpc.yodao.cn:4317(gRPC)或 uptrace-grpc.yodao.cn(HTTP)
  • DSN 格式与官方文档一致

OpenTelemetry Collector

文档:https://uptrace.dev/ingest/collector

功能:

  • 统一数据收集和转发
  • 数据转换和过滤
  • 多数据源支持

Prometheus

文档:https://uptrace.dev/ingest/prometheus

功能:

  • 直接导出 Prometheus Metrics
  • 使用 PromQL 查询
  • 与 Prometheus 生态集成

AWS CloudWatch

文档:https://uptrace.dev/ingest/cloudwatch

功能:

  • 接入 CloudWatch Metrics
  • 接入 CloudWatch Logs
  • AWS 服务监控

日志收集工具

Vector

文档:https://uptrace.dev/ingest/logs/vector

功能:

  • 高性能日志收集
  • 日志过滤和转换
  • 转发到 Uptrace

Fluent Bit

文档:https://uptrace.dev/ingest/logs/fluentbit

功能:

  • 轻量级日志转发
  • 容器和边缘节点支持
  • 日志过滤和路由

Loki

文档:https://uptrace.dev/ingest/logs/loki

功能:

  • Loki 日志接入
  • 日志查询和搜索

查询功能

Spans 和 Logs

文档:https://uptrace.dev/features/spans-logs

功能:

  • Trace 和 Span 查询
  • 日志搜索和过滤
  • 查询语法说明

Metrics

文档:https://uptrace.dev/features/metrics

功能:

  • Metrics 查询
  • PromQL 兼容性
  • 指标聚合和计算

搜索功能

文档:https://uptrace.dev/features/searching

功能:

  • 全文搜索
  • 字段搜索
  • 搜索语法

分组和系统

文档:https://uptrace.dev/features/grouping-systems

功能:

  • 数据分组
  • 系统识别
  • 服务识别

语义属性

文档:https://uptrace.dev/features/semantic-attributes

功能:

  • OpenTelemetry 语义约定
  • 标准属性使用
  • 自定义属性

单点登录(SSO)

Google SSO

文档:https://uptrace.dev/features/sso/google

Okta SSO

文档:https://uptrace.dev/features/sso/okta

Keycloak SSO

文档:https://uptrace.dev/features/sso/keycloak

Cloudflare SSO

文档:https://uptrace.dev/features/sso/cloudflare

内部平台说明:

  • 内部平台可能使用不同的认证方式
  • 请参考内部平台的认证配置

与内部平台的差异

相同点

  • 功能特性:内部平台支持官方文档中的所有核心功能
  • API 兼容:API 和配置方式与官方文档一致
  • 数据格式:使用相同的 OpenTelemetry 数据格式

差异点

1. 访问地址

  • 官方:api.uptrace.dev
  • 内部:uptrace.inner.youdao.com(Web 控制台)
  • 内部:uptrace-grpc.yodao.cn(数据接入端点)

2. 认证方式

  • 官方:可能支持多种 SSO 方式
  • 内部:使用企业账号登录

3. 项目创建

  • 官方:可能通过 Web 界面直接创建
  • 内部:通过工单系统创建项目

4. 通知渠道

  • 官方:支持邮件、Slack、Telegram、Webhook 等

5. 数据保留

  • 官方:可能有不同的数据保留策略
  • 内部:根据内部策略设置数据保留时间(14day)

使用建议

1. 参考官方文档

  • 官方文档提供了详细的功能说明和示例
  • 大部分配置和使用方法与内部平台一致
  • 可以作为内部平台使用的参考

2. 注意差异

  • 访问地址使用内部域名
  • 项目创建通过工单系统
  • 认证方式可能不同

3. 结合内部文档

  • 优先参考本文档(内部平台使用文档)
  • 官方文档作为功能参考
  • 遇到问题时联系内部平台管理员

相关资源

OpenTelemetry 文档

CNCF 资源

内部资源

下一步

在Gitlab上编辑本文档