go.temporal.io/server/common/wideevents/events.go

53 LOC · 19 covered · 34 uncovered · 5 ranges · 49 concepts · 5 introducers · 17 tests

File neighbourhood

The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.

Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.

  1
  
  package wideevents
  
  2
  
  3
  
  import (
  
  4
  
  	"context"
  
  5
  
  6
  
  	"go.opentelemetry.io/otel/attribute"
  
  7
  
  	"go.opentelemetry.io/otel/log"
  
  8
  
  	"go.opentelemetry.io/otel/log/noop"
  
  9
  
  )
  
  10
  
  11
  
  // instrumentationName is the OTEL instrumentation scope for events emitted by this package.
  
  12
  
  const instrumentationName = "go.temporal.io/server/common/wideevents"
  
  13
  
  14
  
  // Payload is the data of one wide event. Each event type implements it by supplying its stable
  
  15
  
  // event name and contributing its fields as OTEL log attributes.
  
  16
  
  type Payload interface {
  
  17
  
  	// EventName is the stable name of the event type. It becomes the log record's event name so
  
  18
  
  	// events are easy to trace/grep by type.
  
  19
  
  	EventName() string
  
  20
  
  	// Attributes returns the event's fields as OTEL log key-values.
  
  21
  
  	Attributes() []log.KeyValue
  
  22
  
  }
  
  23
  
  24
  
  // NewLogger returns the OTEL logger used to emit events for serviceName. serviceName is attached
  
  25
  
  // as an instrumentation-scope attribute (OTEL semconv service.name) so every emitted event carries
  
  26
  
  // it, replacing per-event common-tag plumbing.
  
  27
  >
  func NewLogger(lp log.LoggerProvider, serviceName string) log.Logger {
  
events.go ×1

  28
  >
  	return lp.Logger(
  
  29
  >
  		instrumentationName,
  
  30
  >
  		log.WithInstrumentationAttributes(attribute.String("service.name", serviceName)),
  
  31
  >
  	)
  
  32
  >
  }
  
  33
  
  34
  
  // NoopLogger returns a logger that discards all events. Safe default for tests and for
  
  35
  
  // deployments that have not opted in to a real LoggerProvider.
  
  36
  >
  func NoopLogger() log.Logger {
  
events.go ×1

  37
  >
  	return noop.NewLoggerProvider().Logger(instrumentationName)
  
  38
  >
  }
  
  39
  
  40
  
  // Emit writes p as a single OTEL log record via logger. A nil logger is a safe no-op so call sites
  
  41
  
  // never need to guard. Batching, export, and serialization are handled by the LoggerProvider that
  
  42
  
  // produced logger.
  
  43
  >
  func Emit(logger log.Logger, p Payload) {
  
events.go ×1

  44
  >
  	if logger == nil {
  
  45
  >
  		return
  
events.go ×1

  46
  >
  	}
  
  47
  >
  	var rec log.Record
  
events.go ×1

  48
  >
  	rec.SetSeverity(log.SeverityInfo)
  
  49
  >
  	// The event type is the record's event name so events are easy to trace/grep by type.
  
  50
  >
  	rec.SetEventName(p.EventName())
  
  51
  >
  	rec.AddAttributes(p.Attributes()...)
  
  52
  >
  	logger.Emit(context.Background(), rec)
  
  53
  
  }