chore: trim observability surface docs

This commit is contained in:
lingniu
2026-07-01 15:42:55 +08:00
parent 4d9779e088
commit bf6f94afbb
4 changed files with 18 additions and 5 deletions

View File

@@ -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<br/>metrics / health")
.doesNotContain("observability<br/>metrics / tracing / health");
assertThat(traceSpan)
.doesNotContain("OpenTelemetry")
.doesNotContain("span");
}
@Test

View File

@@ -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)