菜单
OpenTelemetry setup, custom spans, trace propagation, span error recording, and Jaeger/OTLP configuration. Use when adding tracing to services, repositories, queues, Redis, database queries, or external calls.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Delivery -> service -> repository boundaries for this Go API. Use when adding endpoints, features, DTO/domain mappings, service methods, repositories, or business logic.
GORM models, repositories, migris migrations, and domain/model mapping. Use when creating tables, changing schema, adding persistence methods, or handling database errors.
ctxi18n locale flow, translation catalogs, localized validation labels, and localized handler errors. Use when adding user-facing messages or locale-aware errors.
Project test patterns using Ginkgo/Gomega, Testify, gomock, Testcontainers, miniredis, and E2E helpers. Use when writing or updating handler, service, repository, queue, telemetry, or E2E tests.
go-mailgen notification composition, queue payloads, domain.Mail transport, and SMTP delivery. Use when creating email notifications, changing templates, or sending mail through the queue.
Project error and validation rules: domain errors in services, RFC 7807 problem responses in delivery, localized validator errors for DTOs. Use when handling errors, mapping domain errors, or validating request DTOs.
| name | go-telemetry-tracing |
| description | OpenTelemetry setup, custom spans, trace propagation, span error recording, and Jaeger/OTLP configuration. Use when adding tracing to services, repositories, queues, Redis, database queries, or external calls. |
This project uses OpenTelemetry (OTel) for distributed tracing. The default exporter is OTLP, and the default endpoint points at otel-collector:4317 in local compose setups.
internal/telemetry/internal/config/telemetry.go and initialized in internal/telemetry/tracing.go.Echo: Traces incoming HTTP requests via echo-opentelemetry.GORM: Traces database queries.Redis: Traces cache operations via redisotel.Asynq: Traces queue enqueueing and worker processing.internal/telemetry/error.go records exception type, message, and stack trace when available.To add a custom span in a service or repository:
func (s *service) ComplexOperation(ctx context.Context) error {
ctx, span := telemetry.StartSpan(ctx, s.tracer)
defer span.End()
if err := s.repo.Do(ctx); err != nil {
telemetry.RecordSpanError(span, err)
return err
}
return nil
}
Existing services use package-level tracers such as otel.Tracer("auth-service") and otel.Tracer("user-service").
github.com/cockroachdb/errors.telemetry.RecordSpanError(span, err) before returning errors from custom spans when useful.When running locally with Docker Compose, traces are available in Grafana Explore (Tempo datasource) at http://localhost:3000.
OTel configuration (enabled flag, exporter, endpoint, insecure mode, sampling ratio, export timeout) is managed in internal/config/telemetry.go and initialized in internal/telemetry/tracing.go.
OTEL_ENABLED=trueOTEL_EXPORTER=otlpOTEL_EXPORTER_OTLP_ENDPOINT=otel-collector:4317OTEL_EXPORTER_OTLP_INSECURE=trueOTEL_TRACES_SAMPLER_RATIO=1.0OTEL_EXPORT_TIMEOUT=5stracetest.InMemoryExporter for span assertions.make test after telemetry or error-recording changes.