Skip to content

Repository files navigation

GISO · 玑源

License: Apache 2.0 Version Maven SDK Flutter SDK

GIDO 的数据源头 — Schema 驱动的移动端 + Web 行为分析平台。

事件收敛、参数继承、注册表强校验、Kafka → Doris 可插拔管道。方法论参考腾讯大同;可自托管、可 fork,适合强规范多业务线 App。

版本 1.0.5(Flutter SDK 自动设备采集 · 长视频双端 Demo)
协议 Apache License 2.0 · NOTICE
维护者 Felix Zhu <troyzhujingbin@163.com>
源码 github.com/cloud-gido/giso

特性

  • 10 个标准事件 — SDK 统一触发时机,业务差异用 pgid / eid / biz.code + params 表达
  • 五端 SDK — Web (TS) · Android (Java) · iOS (Swift) · Flutter (Dart) · Server (Kafka 事实流)
  • 注册表驱动 — PostgreSQL 运行时权威 + schema/*.yaml Git 审计 → CI 生成常量 → 网关强校验
  • 接入网关 — 鉴权 / 限流 / 三分类校验 / 远程配置 / 多副本热更新 / Prometheus
  • 管理控制台 v2 — 登录与会话 · 多空间 · 注册表 CRUD/审批/批量/CSV 导入 · 可视化圈选 · 实时联调 · 接入助手 · 质量统计 · 中英切换
  • 数据落地 — Kafka → Doris Routine Load → DWD/ADS 看板 SQL + Metabase

架构(当前)

                    ┌─────────────────────────────────────┐
                    │  PostgreSQL(RDS 库 giso)            │
                    │  注册表运行时权威 · 审计 · 多 Pod 同步   │
                    └──────────────▲──────────────────────┘
                                   │ 读写
  schema/*.yaml ──CI codegen──► SDK  │     ┌── Gateway ×N ──┐
  (Git 审计镜像)                    └────►│ 校验 / 管理台   │
                                          └───┬────────────┘
                                              │ POST /v1/track
                    ┌─────────────────────────┼─────────────────────────┐
                    ▼                         ▼                         ▼
           giso_events_raw          giso_events_raw_test      giso_events_quarantine
              (env=prod)                 (env=test)                 (校验失败)
                    │                         │
                    └────────────► Doris ODS ──► Metabase / BI
组件 说明
注册表 生产:管理台 → PostgreSQL;空库时 Gateway 自动迁表 + 种子导入;定时导出 YAML 供 codegen
鉴权 X-App-Key 白名单(Doppler INFRA_GISO_APP_KEYS
分流 env=test → 测试 Topic;env=prod → 生产 Topic
入口 公网仅 /v1/track/v1/config;管理台内网

外部 App 对接常见问题见 08-接入常见问题FAQ。English: docs/en/.

管理控制台一览

v1.0.1 管理台 v2:五栏侧栏 + GIDO 风格顶栏,覆盖联调、登记、审批、质量、平台治理。完整截图说明见 15-管理控制台产品介绍

实时联调 实时联调 — SSE 推送,绿/黄/红三分类,按 did 过滤
注册表 注册表 — 四池登记、批量/CSV、PostgreSQL 持久化
接入助手 接入助手 — FAQ 语料 + 可选 LLM,接入答疑

更多界面(待审批、质量统计、空间/账号/系统设置、产品导航)见 15-管理控制台产品介绍

快速开始

本地开发(Docker Compose)

cd deploy && docker compose up -d --build
# 管理台 http://localhost:8123/admin/  (admin / admin123)
# 上报 Key: demo-key
# 注册表: 内置 PostgreSQL,Gateway 自动迁表 + 种子

测试 / 生产(EKS + deployment 仓)

  1. RDS:一次性 CREATE DATABASE giso(与 GIDO/DataEase 同实例,库名独立)
  2. DopplerINFRA_GISO_DB_*INFRA_GISO_APP_KEYS、Kafka、管理台密码
  3. 推送 giso main → GHCR 镜像 → deployment main → ArgoCD

详见 deploy/DEPLOYMENT.md · deploy/PRODUCTION.md

构建镜像

bash scripts/build-images.sh
# push main 后 CI: ghcr.io/cloud-gido/giso/giso-gateway:latest

裸跑网关(开发)

pip install pyyaml && python3 tools/codegen/generate.py
cd server/gateway && mvn package -DskipTests
java -jar target/giso-gateway.jar --config gateway.yaml --port 8123

文档

文档 说明
16-长视频双端Demo对照 Android / Flutter 同一注册表 · 埋点差异 · 联调
08-接入常见问题FAQ App 对接 QA:session_id、登记、App Key、隔离区、SSE 联调
13-SDK分发与版本 外部 App 拿包、Maven/npm 坐标、Key、endpoint
14-Flutter接入指南 Flutter / Dart 跨端 App 直连接入
07-外部视频App接入问卷 外部 App 登记清单
06-接入指南 业务方六步接入
10-空间与多租户 空间路由、App Key 映射、Kafka 单写
09-账号与权限体系 管理台登录、角色、审批
02-上报协议规范 信封、session_id、pt 透传
00-开源产品全景方案 模块清单 · 路线图 · 文档索引
15-管理控制台产品介绍 管理台 v2 截图与功能说明
11-建设路线图 分阶段交付与验收
CHANGELOG.md 版本说明(1.0.0 / 1.0.1)
deploy/DEPLOYMENT 测试环境 · ArgoCD · Doppler
deploy/PRODUCTION 生产 checklist
tools/registry/README 注册表 DB 脚本

English: docs/en/.

仓库结构

schema/                    注册表 Git 镜像(codegen / 种子)
tools/registry/            RDS 建库 · 导入 · 导出脚本
tools/codegen/             五端常量生成(TS / Java / Swift / Dart)
sdk/                       web · android · ios · flutter/giso_tracker · server
examples/                  android-video-demo · flutter-video-demo(长视频联调样例)
server/gateway/            接入网关 + 管理台(PostgreSQL 注册表 · Session 鉴权)
server/doris/              Doris DDL + Routine Load
server/paimon/             Flink + Paimon 湖仓 SQL
deploy/                    Docker Compose(含 Postgres)
k8s/ · helm/giso/          Gateway K8s / Helm 清单
docs/tracking/             00–16 产品文档 · FAQ · 接入指南 · 长视频双端对照
docs/images/admin/         管理控制台界面截图(文档引用)
docs/en/                   英文核心文档

许可证与版本

文档 说明
CHANGELOG.md 版本说明与发布记录
LICENSE Apache License 2.0
NOTICE 版权与第三方组件声明
AUTHORS.md 维护者与联系方式

核心服务端(server/gateway)与三端 SDK(sdk/)源码均遵循 Apache-2.0
外部 App 集成 SDK 二进制包时,请保留 NOTICE 并在产品说明中注明 GISO SDK 许可。

集成 SDK 见 13-SDK分发与版本

About

GISO(玑源) 是 GIDO 的数据源头(GISO = G i Is the Source Of data),一套可自托管、可 Fork 的 Schema 驱动埋点治理全栈。 它将多端行为数据收敛为 9 个标准事件,通过 schema/*.yaml 注册表统一参数、页面、元素与业务事件;接入网关对每条上报做强校验(正常 / 缺失 / 错误分流),错误数据进入隔离区可回放。提供 Web / Android / iOS / Server 四端 SDK、实时联调管理台、用例断言与 Prometheus 质量监控,数据经 Kafka 落地 Doris,可接 Metabase 做分析。 方法论参考腾讯大同,适合 强规范、多业务线 App 团队;非开箱 SaaS,而是「治理内核 + 可插拔数仓」。

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages