opik-integrations-auditor

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Opik Integrations Auditor

Opik集成审计工具

Purpose

用途

Audit, compare, and document Opik integrations across Python, TypeScript, and backend OTEL/API surfaces with a repeatable evidence-first workflow.

通过可重复的、基于证据的工作流，对Python、TypeScript以及后端OTEL/API层面的Opik集成进行审计、对比并生成文档。

When to use

适用场景

Use this skill when the task involves:

reviewing existing Opik integrations for behavior, coverage, or documentation quality
designing or implementing a new integration
producing integration pattern docs across Python, TypeScript, and OTEL/API
identifying gaps between code, tests, and docs

当你需要完成以下任务时，可使用该技能：

审核现有Opik集成的行为、覆盖范围或文档质量
设计或实现新的集成
编写覆盖Python、TypeScript和OTEL/API的集成模式文档
识别代码、测试与文档之间的差距

Required outputs

必备输出

Produce these artifacts in the response (or files if asked):

Integration inventory table
Pattern classification per integration
Cross-surface comparison matrix (Python / TypeScript / OTEL/API)
Findings list (bugs/risks/gaps)
Documentation patch plan
Test plan (unit + integration + e2e)

在响应中生成以下成果物（若有要求可输出为文件）：

集成清单表
各集成的模式分类
跨层面对比矩阵（Python / TypeScript / OTEL/API）
问题清单（漏洞/风险/差距）
文档补丁计划
测试计划（单元测试 + 集成测试 + 端到端测试）

Workflow

工作流

Build inventory and classify pattern per integration.
Extract behavior contract (capture, streaming, errors, flush, span hierarchy).
Extract data contract (usage, metadata/tags, thread propagation).
Validate backend compatibility (OTEL endpoint/protocol/mapping rules).
Review tests for coverage and missing edge cases.
Produce documentation updates with consistent template.

构建集成清单并为每个集成分类模式。
提取行为契约（捕获、流处理、错误、刷新、调用链层级）。
提取数据契约（使用方式、元数据/标签、线程传播）。
验证后端兼容性（OTEL端点/协议/映射规则）。
审核测试的覆盖范围与缺失的边缘案例。
使用统一模板生成文档更新内容。

Load references as needed

按需加载参考资料

For matrix schema and scoring:
```
references/matrix-and-rubric.md
```
For pattern definitions:
```
references/patterns.md
```
For evidence collection paths and commands:
```
references/evidence-collection.md
```
For documentation update template:
```
references/doc-template.md
```
For testing checklist:
```
references/testing-checklist.md
```
For subagent prompt templates:
```
references/subagent-prompts.md
```

矩阵架构与评分标准：
```
references/matrix-and-rubric.md
```
模式定义：
```
references/patterns.md
```
证据收集路径与命令：
```
references/evidence-collection.md
```
文档更新模板：
```
references/doc-template.md
```
测试检查清单：
```
references/testing-checklist.md
```
子Agent提示模板：
```
references/subagent-prompts.md
```

Inputs

输入信息

Integration scope (specific integration or full inventory)
Target surfaces to compare (Python, TypeScript, OTEL/API)
Relevant repo paths and branch/diff scope
Output expectations (table depth, doc patch format, test depth)

集成范围（特定集成或完整清单）
待对比的目标层面（Python、TypeScript、OTEL/API）
相关仓库路径与分支/差异范围
输出要求（表格深度、文档补丁格式、测试深度）

Outputs

输出成果

Inventory and comparison matrix
Findings and risk summary
Documentation patch plan
Test plan with missing coverage calls

集成清单与对比矩阵
问题与风险摘要
文档补丁计划
包含缺失覆盖项的测试计划

Default evidence locations (override if repo differs)

默认证据位置（若仓库结构不同可覆盖）

Python:

```
sdks/python/src/opik/integrations
```
```
sdks/python/design/INTEGRATIONS.md
```
```
sdks/python/design/TESTING.md
```

TypeScript:

```
sdks/typescript/design/INTEGRATIONS.md
```
```
sdks/typescript/design/TESTING.md
```

Backend OTEL:

apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/OpenTelemetryResource.java

apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryService.java

apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryMapper.java

apps/opik-backend/src/main/java/com/comet/opik/domain/mapping/OpenTelemetryMappingRuleFactory.java

```
apps/opik-backend/docs/integrations.md
```

Python:

```
sdks/python/src/opik/integrations
```
```
sdks/python/design/INTEGRATIONS.md
```
```
sdks/python/design/TESTING.md
```

TypeScript:

```
sdks/typescript/design/INTEGRATIONS.md
```
```
sdks/typescript/design/TESTING.md
```

后端OTEL:

apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/OpenTelemetryResource.java

apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryService.java

apps/opik-backend/src/main/java/com/comet/opik/domain/OpenTelemetryMapper.java

apps/opik-backend/src/main/java/com/comet/opik/domain/mapping/OpenTelemetryMappingRuleFactory.java

```
apps/opik-backend/docs/integrations.md
```