Skip to content

observability.md

Latest commit

 

History

History
48 lines (38 loc) · 2.72 KB

observability.md

File metadata and controls

48 lines (38 loc) · 2.72 KB

observability.md

Section Inventory

Section Core Python Py# TypeScript TS# Ruby Rb# Go Go#
Overview — ✓ 1 ✓ 1 TODO 1 ✓ 1
Logging / Replay-Aware Logging — ✓ 2 ✓ 2 TODO 2 ✓ 2
Customizing the Logger — ✓ 2 ✓ 3 — — ✓ 3
OpenTelemetry Integration — — — — — — — — —
Metrics — ✓ 3 ✓ 4 TODO 3 ✓ 4
Search Attributes (Visibility) — ✓ 4 — — — — ✓ 5
Debugging with Event History — — — — — — — — —
Best Practices — ✓ 5 ✓ 5 TODO 4 ✓ 6

Style Compliance

Language Status Notes
Python ✓ reference —
TypeScript ✓ aligned Removed verbose sections
Ruby — Not started
Go ✓ aligned workflow.GetLogger, slog integration, Tally/Prometheus metrics

Status

Ruby notes:

  • Logging: Temporalio::Workflow.logger is replay-aware; Temporalio::Activity::Context.current.logger for activities
  • Metrics: Temporalio::Runtime::MetricsOptions with Prometheus (PrometheusMetricsOptions) or custom MetricBuffer
  • OpenTelemetry: Temporalio::Contrib::OpenTelemetry::TracingInterceptor — mentioned inline, not separate section (matching Python/TS style)
  • Ruby has Unsafe.replaying? for side-effect guards: unless Temporalio::Workflow::Unsafe.replaying?
  • Customizing the Logger: Ruby's Temporalio::Workflow.logger is straightforward; mention inline in Logging section (no separate section)

Go-specific notes:

  • Logging: workflow.GetLogger(ctx) for replay-safe workflow logging; activity.GetLogger(ctx) for activity logging
  • Customizing: Go 1.21+ supports log.NewStructuredLogger(slog.New(...)) via client.Options.Logger; also supports custom log.Logger interface
  • Metrics: Go uses Tally library (go.temporal.io/sdk/contrib/tally) for Prometheus integration; client.Options.MetricsHandler
  • Tracing: Go supports OpenTelemetry, OpenTracing, and Datadog via contrib/ packages and interceptors
  • Search Attributes: Go includes visibility/search attributes in observability (like Python, unlike TS)

Intentionally missing (—):

  • Core column: no core observability.md exists (implementation-specific)
  • OpenTelemetry / Debugging: Removed as too detailed
  • Search Attributes: Python/Go include; TS keeps in data-handling.md

Order alignment: ✓ Aligned — Ruby follows Python order (compact, 4 sections)

Style alignment: ✅ Complete (Python, TypeScript, Go). Ruby should follow same concise structure.