From bf6f94afbb95573a21a4bcf8139bbdff5dba87c4 Mon Sep 17 00:00:00 2001 From: lingniu Date: Wed, 1 Jul 2026 15:42:55 +0800 Subject: [PATCH] chore: trim observability surface docs --- README.md | 4 ++-- docs/module-data-flow.html | 4 ++-- .../ingest/historyapp/MavenModuleProfileTest.java | 13 +++++++++++++ .../lingniu/ingest/api/annotation/TraceSpan.java | 2 +- 4 files changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8b9ffee5..22077cab 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ | MQTT 客户端 | Eclipse Paho 1.2.5 | | 会话索引 | Redis | | 熔断/限流 | Resilience4j 2 | -| 可观测 | Micrometer + Prometheus + OpenTelemetry | +| 可观测 | Micrometer + Prometheus | | 冷存 | S3 / OSS / 本地 | | 构建 | Maven + Spotless + ArchUnit | @@ -38,7 +38,7 @@ lingniu-vehicle-ingest/ │ │ ├── ingest-core/ Pipeline / Dispatcher / Disruptor / Session 桥 │ │ ├── session-core/ 设备会话 + 鉴权 + Token + Redis SessionStore │ │ ├── vehicle-identity/ 跨协议车辆身份解析 + MySQL 外部标识绑定 -│ │ └── observability/ metrics / tracing / health +│ │ └── observability/ metrics / health │ ├── protocols/ │ │ ├── protocol-gb32960/ GB/T 32960 │ │ ├── protocol-jt808/ JT/T 808（统一身份映射 + 事件 metadata 内部 VIN + 注册/鉴权/心跳/注销/位置/批量位置/参数/属性/媒体/透传/未知上行和坏帧兜底/断链清理会话/下行分包） diff --git a/docs/module-data-flow.html b/docs/module-data-flow.html index 5345d098..89d7ba19 100644 --- a/docs/module-data-flow.html +++ b/docs/module-data-flow.html @@ -309,7 +309,7 @@ flowchart TB codec["ingest-codec-common
BCD / CRC / BCC / bit 工具"] session["session-core
设备会话、命令分发接口、会话存储"] identity["vehicle-identity
跨协议身份解析、MySQL 绑定表"] - obs["observability
metrics / tracing / health"] + obs["observability
metrics / health"] api["ingest-api
ProtocolId / RawFrame / VehicleEvent / 注解 SPI"] registry["HandlerRegistry
按协议、命令、infoType 路由"] dispatcher["Dispatcher
RawFrame 到 Handler 到 EventBus"] @@ -535,7 +535,7 @@ flowchart LR modules/core/observability - 监控、指标、追踪、健康检查等横切能力。 + 监控、指标、健康检查等横切能力。 核心管线和 Sink 运行状态。 Micrometer 指标、健康信息。 可用性延迟监控 diff --git a/modules/apps/vehicle-history-app/src/test/java/com/lingniu/ingest/historyapp/MavenModuleProfileTest.java b/modules/apps/vehicle-history-app/src/test/java/com/lingniu/ingest/historyapp/MavenModuleProfileTest.java index 7f5a7827..1c6b75b0 100644 --- a/modules/apps/vehicle-history-app/src/test/java/com/lingniu/ingest/historyapp/MavenModuleProfileTest.java +++ b/modules/apps/vehicle-history-app/src/test/java/com/lingniu/ingest/historyapp/MavenModuleProfileTest.java @@ -267,6 +267,10 @@ class MavenModuleProfileTest { void observabilityBuildSurfaceUsesMicrometerWithoutUnusedOpenTelemetryBom() throws Exception { Document pom = rootPom(); Document observabilityPom = modulePom("modules/core/observability/pom.xml"); + String readme = Files.readString(repositoryRoot().resolve("README.md")); + String moduleDataFlow = Files.readString(repositoryRoot().resolve("docs/module-data-flow.html")); + String traceSpan = Files.readString(repositoryRoot() + .resolve("modules/core/ingest-api/src/main/java/com/lingniu/ingest/api/annotation/TraceSpan.java")); assertThat(hasProjectProperty(pom, "micrometer.version")) .isTrue(); @@ -281,6 +285,15 @@ class MavenModuleProfileTest { .isFalse(); assertThat(productionJavaContains("io.opentelemetry")) .isFalse(); + assertThat(readme) + .contains("| 可观测 | Micrometer + Prometheus |") + .doesNotContain("OpenTelemetry"); + assertThat(moduleDataFlow) + .contains("observability
metrics / health") + .doesNotContain("observability
metrics / tracing / health"); + assertThat(traceSpan) + .doesNotContain("OpenTelemetry") + .doesNotContain("span"); } @Test diff --git a/modules/core/ingest-api/src/main/java/com/lingniu/ingest/api/annotation/TraceSpan.java b/modules/core/ingest-api/src/main/java/com/lingniu/ingest/api/annotation/TraceSpan.java index daf225c0..1dbbb521 100644 --- a/modules/core/ingest-api/src/main/java/com/lingniu/ingest/api/annotation/TraceSpan.java +++ b/modules/core/ingest-api/src/main/java/com/lingniu/ingest/api/annotation/TraceSpan.java @@ -6,7 +6,7 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** - * 为 Handler 方法开启 OpenTelemetry span。 + * 为 Handler 方法标记轻量 traceId 诊断名称。 */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD)