Skip to content
OpenTelemetry 接入文档

项目创建与管理

在 Uptrace 平台中，项目是数据组织和权限管理的基本单位。每个项目有独立的 DSN、数据存储和权限控制。本文将介绍如何创建新项目、加入现有项目以及管理项目设置。

项目概述

什么是项目？

项目是 Uptrace 平台中用于组织和管理可观测性数据的基本单元：

  • 数据隔离：不同项目的数据完全隔离
  • 权限控制：每个项目有独立的权限管理
  • 独立 DSN：每个项目有唯一的 DSN
  • 资源配额：可以设置每个项目的资源限制

项目用途

  • 环境隔离：开发、测试、生产环境使用不同项目
  • 团队隔离：不同团队使用不同项目
  • 服务分组：相关服务可以放在同一个项目中

创建新项目

通过工单创建

有道内部使用工单系统来创建新的 APM 项目，确保项目创建的规范性和可追溯性。

工单链接

新建 APM 项目工单： https://ticket.site.youdao.com/subapp/ticket/create?processId=17633693760062728787845627

工单填写说明

创建工单时，请提供以下信息：

  1. 项目名称

    • 建议格式：按照产品或者业务线来命名，如 词典、企业发展
    • 名称应具有描述性，便于识别

  2. 项目描述

    • 说明项目的用途和包含的服务
    • 例如："词典服务生产环境监控项目"

  3. 负责人和成员信息

    • 项目负责人rd

审批流程

  1. 提交工单：填写完整信息后提交工单
  2. 管理员审核：APM 平台管理员审核工单信息
  3. 项目创建：审核通过后，管理员创建项目
  4. 获取 DSN：工单审批完成后，工单系统评论会有对应入口，复制入口导浏览器可以看到对应DSN或者直接登录平台查看项目 DSN

加入现有项目

如果您需要访问已存在的项目，需要通过工单申请加入。

工单链接

加入 APM 项目工单： https://ticket.site.youdao.com/subapp/ticket/create?processId=17633729540052918353087804

工单填写说明

申请加入项目时，请提供：

  1. 项目名称

    • 要加入的项目名称
    • 如果不确定，可以描述项目用途

  2. 申请原因

    • 说明为什么需要访问该项目
    • 例如："负责该项目的开发和运维工作"

  3. 所需权限

    • 只读权限：仅查看数据，不能修改配置
    • 成员权限：可以查看数据和修改配置
    • 管理员权限：完全控制项目（需要项目负责人同意）

  4. RD用户名

权限说明

只读权限

  • ✅ 查看 Trace、Metrics、Logs
  • ✅ 查看服务拓扑图
  • ✅ 查看告警历史
  • ❌ 修改项目配置
  • ❌ 创建告警规则
  • ❌ 修改 DSN

读写权限

  • ✅ 所有只读权限
  • ✅ 创建和修改告警规则
  • ✅ 创建 Dashboard
  • ✅ 修改部分项目设置
  • ❌ 删除项目
  • ❌ 修改 DSN

管理员权限

  • ✅ 所有权限
  • ✅ 删除项目
  • ✅ 修改 DSN
  • ✅ 管理项目成员
  • ✅ 修改项目设置

项目列表查看

登录平台

  1. 访问 https://uptrace.inner.youdao.com/
  2. 使用企业账号登录
  3. 登录成功后，进入项目列表页面

查看项目

在项目列表页面，您可以：

  • 查看所有项目：显示您有权限访问的所有项目
  • 搜索项目：通过项目名称搜索
  • 筛选项目：按环境、团队等维度筛选

项目设置

访问项目设置

  1. 登录平台
  2. 选择要设置的项目
  3. 点击右上角的"设置"按钮
  4. 进入项目设置页面

成员管理

添加成员

  1. 进入"成员管理"页面
  2. 点击"添加成员"按钮
  3. 输入成员的企业账号
  4. 选择权限级别
  5. 确认添加

修改权限

  1. 找到要修改的成员
  2. 点击"编辑"按钮
  3. 修改权限级别
  4. 保存更改

移除成员

  1. 找到要移除的成员
  2. 点击"移除"按钮
  3. 确认移除操作

注意：只有项目管理员可以管理成员。

DSN 管理

查看 DSN

  1. 进入"连接详情"页面
  2. 查看项目的 DSN
  3. 复制 DSN 用于配置

详细说明请参考DSN 配置与查看。

重置 DSN

如果需要重置 DSN（例如 DSN 泄露）：

  1. 进入"连接详情"页面
  2. 点击"重置 DSN"按钮
  3. 确认重置操作
  4. 重要：重置后需要更新所有使用该 DSN 的应用配置

项目权限管理

权限级别

Uptrace 平台提供三种权限级别：

  1. 只读（Viewer）：只能查看数据
  2. 编辑（Editor）：可以查看和编辑配置
  3. 管理员（Admin）：完全控制权限

权限矩阵

操作只读编辑管理员
查看 Trace✅✅✅
查看 Metrics✅✅✅
查看 Logs✅✅✅
创建 Dashboard❌✅✅
创建告警规则❌✅✅
修改项目设置❌部分✅
管理成员❌❌✅
删除项目❌❌✅
重置 DSN❌❌✅

最佳实践

  1. 最小权限原则：只授予必要的权限
  2. 定期审查：定期审查项目成员和权限
  3. 权限分离：开发人员使用只读权限，运维人员使用编辑权限
  4. 管理员限制：限制管理员数量，通常只有项目负责人是管理员

下一步

参考资源

在Gitlab上编辑本文档