Loading...
Loading...
Compare original and translation side by side
defineEnricherevlog/toolkitevlog/toolkitdefineEnricherfeat(core): add the {name} enricherevlog/enricherscorefeat(core): add the {name} enricherevlog/enricherscore| # | File | Action |
|---|---|---|
| 1 | | Add enricher source (one |
| 2 | Same file: | Decide whether the enricher belongs in the default composition (see below) |
| 3 | | Add tests (one |
| 4 | | Add a section for the enricher + update the import list and, if applicable, the "All built-in enrichers" default composition text |
| 5 | | Add the enricher to the |
| 6 | | Add the enricher to the Built-in Enrichers section (root |
| 7 | | Create changeset ( |
| # | 文件 | 操作 |
|---|---|---|
| 1 | | 添加 Enricher 源代码(一次 |
| 2 | 同一文件中的 | 判断该 Enricher 是否应加入默认组合(见下文) |
| 3 | | 添加测试(每个 Enricher 使用一个 |
| 4 | | 为该 Enricher 添加章节,并更新导入列表;如适用,还要更新 "All built-in enrichers" 的默认组合文本 |
| 5 | | 在 Enrichers 部分的 |
| 6 | | 在 Built-in Enrichers 部分添加该 Enricher(根目录的 |
| 7 | | 创建 changeset( |
createDefaultEnrichers()createDefaultEnrichers()createDefaultEnrichers()composeEnrichers../shared/composecreateDefaultEnrichers()createDefaultEnrichers()composeEnrichers../shared/composecreateDefaultEnrichers()| Placeholder | Example (UserAgent) | Usage |
|---|---|---|
| | camelCase for event field key |
| | PascalCase in function/interface names |
| | Human-readable display name |
| 占位符 | 示例(UserAgent) | 用途 |
|---|---|---|
| | 事件字段键使用 camelCase |
| | 函数和接口名称使用 PascalCase |
| | 人类可读的显示名称 |
defineEnricherdefineEnricherpackages/evlog/src/enrichers/index.tsdefineEnricher<T>({ name, field, compute }, options?)compute(ctx)TundefineddefineEnrichermergeEventFieldoptions.overwritefalsecomputeundefinedgetHeader()normalizeNumber()../shared/headersevlog/toolkitctx.eventcreateTraceContextEnricherevent.traceIdevent.parentSpanIddefineEnrichercreate{Name}Enricher(options: EnricherOptions = {})defineEnricher(...)defineEnricher{Name}Infopackages/evlog/src/enrichers/index.tsdefineEnricher<T>({ name, field, compute }, options?)compute(ctx)TundefineddefineEnrichermergeEventFieldoptions.overwritefalsecomputeundefinedgetHeader()normalizeNumber()../shared/headersevlog/toolkitctx.eventcreateTraceContextEnricherevent.traceIdevent.parentSpanIddefineEnrichercreate{Name}Enricher(options: EnricherOptions = {})defineEnricher(...)defineEnricher{Name}Infopackages/evlog/test/toolkit/enrichers.test.tsdescribepackages/evlog/test/README.mdctx.requestctx.responseprocess.envctx.eventoverwrite: falseoverwrite: truecreateDefaultEnrichers()describepackages/evlog/test/README.mdpackages/evlog/test/toolkit/enrichers.test.tsctx.requestctx.responseprocess.envctx.eventoverwrite: falseoverwrite: truecreateDefaultEnrichers()apps/docs/content/5.use-cases/5.enrichers.md## {DISPLAY}undefinedapps/docs/content/5.use-cases/5.enrichers.md## {DISPLAY}undefinedevent.{name}
3. If the enricher joined the default composition, update the "All built-in enrichers" section text listing what `createDefaultEnrichers()` composes.
Custom-enricher authoring docs live separately at `apps/docs/content/6.extend/5.custom-enrichers.md`, with no change needed there unless the toolkit contract itself changed.event.{name}
3. 如果该 Enricher 已加入默认组合,请更新 "All built-in enrichers" 章节中列举 `createDefaultEnrichers()` 所组合内容的文本。
自定义 Enricher 的编写文档单独位于 `apps/docs/content/6.extend/5.custom-enrichers.md`;除非 toolkit 契约本身发生变化,否则无需修改该文档。skills/review-logging-patterns/SKILL.mdBuilt-in:skills/review-logging-patterns/SKILL.mdBuilt-in:packages/evlog/README.mdREADME.mdpackages/evlog/README.mdREADME.md.changeset/{name}-enricher.mdminor.changeset/{name}-enricher.mdminorcd packages/evlog
pnpm run lint
pnpm run typecheck
pnpm run test
pnpm run buildcd packages/evlog
pnpm run lint
pnpm run typecheck
pnpm run test
pnpm run build