Agent Skills › MapleTechLabs/maple › maple-telemetry-conventions

maple-telemetry-conventions

GitHub

定义Maple项目跨语言的OpenTelemetry规范,涵盖自定义属性键、状态码格式及资源属性。用于指导代码编写、审查及OTLP配置,确保遥测数据兼容Tinybird MV和仪表盘。

.agents/skills/maple-telemetry-conventions/SKILL.md MapleTechLabs/maple

Trigger Scenarios

编写或审查涉及OpenTelemetry插桩的代码 配置OTLP导出器或Tracer Provider 添加新的span属性或设置span状态

Install

npx skills add MapleTechLabs/maple --skill maple-telemetry-conventions -g -y
More Options

Non-standard path

npx skills add https://github.com/MapleTechLabs/maple/tree/main/.agents/skills/maple-telemetry-conventions -g -y

Use without installing

npx skills use MapleTechLabs/maple@maple-telemetry-conventions

指定 Agent (Claude Code)

npx skills add MapleTechLabs/maple --skill maple-telemetry-conventions -a claude-code -g -y

安装 repo 全部 skill

npx skills add MapleTechLabs/maple --all -g -y

预览 repo 内 skill

npx skills add MapleTechLabs/maple --list

SKILL.md

Frontmatter
{
    "name": "maple-telemetry-conventions",
    "version": "1.0.0",
    "description": "Maple's OpenTelemetry conventions: custom span attribute keys (`maple.*` vendor namespace, `query.context`, `db.query.*`, `result.*`, `cache.*`, `tenant.*`), Title Case status codes (`Ok`\/`Error`\/`Unset`), resource attribute dual-emit (`deployment.environment` + `deployment.environment.name`), span kinds, Tinybird MV pre-extracted columns, loop-prevention filters, and sampling. Use whenever writing or reviewing instrumentation code in any language (TypeScript, Rust, Python) in this repo: adding `setAttribute`\/`setAttributes`\/`record`\/`#[instrument(fields(...))]` calls, setting span status, configuring an OTLP exporter, defining a new resource attribute, or wiring a new query through `WarehouseQueryService.compiledQuery()`."
}

Maple Telemetry Conventions

Reference for the language-agnostic OpenTelemetry conventions Maple uses across TypeScript (apps/api and the other Workers, via @maple-dev/effect-sdk in packages/effect-sdk/), Rust (apps/ingest), and any future Python service. These conventions are load-bearing. Tinybird materialized views pre-extract some attribute keys into columns, dashboards filter on Title Case status strings, and throughput math depends on the SampleRate column. Use the exact attribute spellings here in every language.

When to apply

  • Adding setAttribute / Effect.annotateCurrentSpan / Span::current().record(...) / #[instrument(fields(...))] to any code path
  • Setting span status (Ok / Error / Unset)
  • Wiring a new query through WarehouseQueryService.compiledQuery() (the context and profile options become span attributes)
  • Configuring an OTLP exporter, tracer provider, or resource builder
  • Introducing a new pre-extracted MV column or a new vendor attribute under maple.*
  • Reviewing a PR that touches packages/query-engine/src/execution/executor.ts, apps/ingest/src/main.rs, apps/ingest/src/otel.rs, apps/api/src/http/api-observability.ts, packages/effect-sdk/src/cloudflare/, packages/infra/src/cloudflare/worker-telemetry.ts, or packages/domain/src/tinybird/materializations.ts

Index

  • rules/span-attributes.md: the main custom attribute keys Maple emits, grouped by namespace, with the file that sets each.
  • rules/status-and-kind.md: Title Case status codes (Ok/Error/Unset), the server-span 4xx rule, and span kinds (Server / Client / Internal).
  • rules/resource-attributes.md: service.* identity, deployment.environment.name resolution order, the deprecated deployment.environment dual-emit and read-side coalesce, and maple_org_id.
  • rules/language-bindings.md: parallel TypeScript / Rust / Python snippets that emit the same attribute keys.
  • rules/mv-first-class-columns.md: which span and resource attributes Tinybird MVs pre-extract into columns, and the rule for adding new ones.
  • rules/service-map-attribution.md: what the service map needs to draw service edges, database nodes, runtime icons, and platform badges, plus the peer.service naming registry.
  • rules/loop-prevention.md: the guards that keep Maple's self-traffic from feeding back on itself: the API TracerDisabledWhen filter, the ingest loopback guard, and sampling.

Quick reference

Topic Rule
Status codes Always Title Case: "Ok", "Error", "Unset". Never OK, ERROR, SUCCESS, FAILED.
Vendor namespace Custom attributes go under maple.*. Sub-namespaces include maple.ingest.*, maple.cloudflare.*, maple.query.*.
Standard semconv Use OTel semconv keys verbatim: service.name, http.request.method, db.system.name, error.type.
Org identity orgId (camelCase) in TypeScript spans, maple.org_id (dotted) in Rust spans. Don't unify until MVs migrate.
Deployment env Emit deployment.environment.name (our SDKs dual-emit the deprecated deployment.environment too). Read both via DEPLOYMENT_ENV_SQL / deploymentEnvExpr, never a bare map lookup.
Warehouse SQL spans Every WarehouseQueryService.executeSql span (a Client span) carries db.system.name, peer.service, db.query.text, db.query.fingerprint, db.duration_ms, result.rowCount, orgId, query.context, and query.profile when set. Legacy spans (pre 2026-06) use db.statement*/db.system; warehouse readers coalesce both.
Service map Service-to-service edges come from joining a Client/Producer span to its child Server/Consumer span in another service, so propagate trace context and set span kinds. Database nodes need db.system.name (plus db.namespace) on a Client/Producer span. Runtime icon and platform badge need process.runtime.name, cloud.platform, maple.sdk.type on the resource. See rules/service-map-attribution.md.
Loop prevention Never remove HttpMiddleware.TracerDisabledWhen (apps/api/src/http/api-observability.ts) or the ingest loopback guard (init_tracing in apps/ingest/src/main.rs).

Canonical references (do not modify from this skill)

  • packages/query-engine/src/execution/executor.ts: WarehouseQueryService.executeSql span emission, the canonical TS example.
  • apps/ingest/src/otel.rs: resource builder (build_resource), platform detection, and the client-span helpers (forward_client_span, export_client_span). The canonical Rust example for resource and outbound-span attribution.
  • apps/ingest/src/main.rs: handle_signal and handle_cloudflare_logpush open the Server-kind tracing::info_span! for inbound OTLP and Logpush.
  • apps/api/src/http/api-observability.ts: the TracerDisabledWhen filter and header redaction list.
  • packages/effect-sdk/src/cloudflare/index.ts: MapleCloudflareSDK tracer setup. Maple's own Workers wrap it with WorkerTelemetry in packages/infra/src/cloudflare/worker-telemetry.ts.
  • packages/domain/src/tinybird/materializations.ts: MV SELECT lists that pre-extract attribute keys into columns.

Version History

  • abef749 Current 2026-09-27 16:48

    修复过时的引用和错误说明,更新技能中的路径、SDK API及包名,修正服务地图边缘推导逻辑描述。

  • 6f65ba7 2026-08-27 14:03

    修复仓库查询服务中因OpenTelemetry重命名导致的部署环境属性读取问题,统一使用coalesce表达式兼容新旧键名,并更新相关MV和测试。

  • d3478fc 2026-08-05 10:31

    更新API方法名从sqlQuery改为compiledQuery;修正包路径lib/effect-sdk为packages/effect-sdk;补充loop-prevention等规则文档索引。

  • 01a5dc6 2026-07-05 18:15

Same Skill Collection

.agents/skills/clickhouse-architecture-advisor/SKILL.md
.agents/skills/clickhouse-best-practices/SKILL.md
.agents/skills/clickhousectl-cloud-deploy/SKILL.md
.agents/skills/clickhousectl-local-dev/SKILL.md
.agents/skills/coss-particles/SKILL.md
.agents/skills/coss/SKILL.md
.agents/skills/react-doctor/SKILL.md
.agents/skills/tinybird-cli-guidelines/SKILL.md
.agents/skills/tinybird-python-sdk-guidelines/SKILL.md
.agents/skills/tinybird-typescript-sdk-guidelines/SKILL.md
.agents/skills/tinybird/SKILL.md
.context/effect/.agents/skills/grill-me/SKILL.md
.context/effect/.agents/skills/jsdocs/SKILL.md
.context/effect/.agents/skills/scratchpad/SKILL.md
.factory/skills/react-doctor/SKILL.md
apps/slack-agent/agent/skills/dashboard-builder/SKILL.md
apps/slack-agent/agent/skills/incident-investigation/SKILL.md
skills/maple-audit/SKILL.md
skills/maple-csharp-style/SKILL.md
skills/maple-effect-style/SKILL.md
skills/maple-go-style/SKILL.md
skills/maple-java-style/SKILL.md
skills/maple-kotlin-style/SKILL.md
skills/maple-nextjs-style/SKILL.md
skills/maple-nodejs-style/SKILL.md
skills/maple-onboard/SKILL.md
skills/maple-onboarding-style/SKILL.md
skills/maple-python-style/SKILL.md
skills/maple-rust-style/SKILL.md
.agents/skills/chdb-datastore/SKILL.md
.agents/skills/chdb-sql/SKILL.md
.agents/skills/onboarding-cro/SKILL.md
skills/maple-dashboard-widgets/SKILL.md
skills/maple-otel-spec-review/SKILL.md

Metadata

Files
0
Version
abef749
Hash
bf8c1677
Indexed
2026-07-05 18:15

ホーム - Wiki
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-09-28 17:04
浙ICP备14020137号-1