Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

event

package

Go to main page

Versions in this module

v1

v1.11.2

Feb 21, 2025

v1.11.1

Feb 14, 2025

v1.11.0

Feb 10, 2025

Changes in this version

+ type EventMetricsTracker struct

+ EmittedEvents *prometheus.CounterVec

+ EventsProcessTime *prometheus.CounterVec

+ EventsRateLimited *metrics.Event

+ ProcessedEvents *prometheus.CounterVec

+ func NewMetricsTracker(ns string, factory metrics.Factory) *EventMetricsTracker

+ func (m *EventMetricsTracker) RecordEmittedEvent(eventName string, emitter string)

+ func (m *EventMetricsTracker) RecordEventsRateLimited()

+ func (m *EventMetricsTracker) RecordProcessedEvent(eventName string, deriver string, duration time.Duration)

v1.10.0

Nov 19, 2024

v1.9.5

Nov 8, 2024

v1.9.4

Oct 8, 2024

v1.9.3

Sep 25, 2024

Changes in this version

+ type CriticalErrorEvent struct

+ Err error

+ func (ev CriticalErrorEvent) String() string

+ type Registry interface

+ Register func(name string, deriver Deriver, opts *RegisterOpts) Emitter

+ Unregister func(name string) (old Emitter)

v1.9.2

Sep 5, 2024

v1.9.1

Aug 28, 2024

v1.9.0

Aug 7, 2024

v1.8.0

Jul 17, 2024

Changes in this version

+ func Any(fns ...func(ev Event) bool) func(ev Event) bool

+ func Is[T Event](ev Event) bool

+ type AnnotatedEvent struct

+ EmitContext uint64

+ Event Event

+ type AttachEmitter interface

+ AttachEmitter func(em Emitter)

+ type DebugDeriver struct

+ Log log.Logger

+ func (d DebugDeriver) OnEvent(ev Event)

+ type Deriver interface

+ OnEvent func(ev Event) bool

+ type DeriverFunc func(ev Event) bool

+ func (fn DeriverFunc) OnEvent(ev Event) bool

+ type DeriverMux []Deriver

+ func (s *DeriverMux) OnEvent(ev Event) bool

+ type Drainer interface

+ Drain func() error

+ DrainUntil func(fn func(ev Event) bool, excl bool) error

+ type Emitter interface

+ Emit func(ev Event)

+ type EmitterDrainer interface

+ type EmitterFunc func(ev Event)

+ func (fn EmitterFunc) Emit(ev Event)

+ type EmitterOpts struct

+ Burst int

+ Limiting bool

+ OnLimited func()

+ Rate rate.Limit

+ type Event interface

+ String func() string

+ type Executable interface

+ RunEvent func(ev AnnotatedEvent)

+ type ExecutableFunc func(ev AnnotatedEvent)

+ func (fn ExecutableFunc) RunEvent(ev AnnotatedEvent)

+ type Executor interface

+ Add func(d Executable, opts *ExecutorOpts) (leaveExecutor func())

+ Enqueue func(ev AnnotatedEvent) error

+ type ExecutorOpts struct

+ Capacity int

+ type GlobalSyncExec struct

+ func NewGlobalSynchronous(ctx context.Context) *GlobalSyncExec

+ func (gs *GlobalSyncExec) Add(d Executable, _ *ExecutorOpts) (leaveExecutor func())

+ func (gs *GlobalSyncExec) Drain() error

+ func (gs *GlobalSyncExec) DrainUntil(fn func(ev Event) bool, excl bool) error

+ func (gs *GlobalSyncExec) Enqueue(ev AnnotatedEvent) error

+ type Limiter struct

+ func NewLimiter[E Emitter](ctx context.Context, em E, eventRate rate.Limit, eventBurst int, ...) *Limiter[E]

+ func (l *Limiter[E]) Emit(ev Event)

+ type LimiterDrainer Limiter[EmitterDrainer]

+ func NewLimiterDrainer(ctx context.Context, em EmitterDrainer, eventRate rate.Limit, eventBurst int, ...) *LimiterDrainer

+ func (l *LimiterDrainer) Drain() error

+ func (l *LimiterDrainer) DrainUntil(fn func(ev Event) bool, excl bool) error

+ func (l *LimiterDrainer) Emit(ev Event)

+ type LogTracer struct

+ func NewLogTracer(log log.Logger, lvl slog.Level) *LogTracer

+ func (lt *LogTracer) OnDeriveEnd(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time, ...)

+ func (lt *LogTracer) OnDeriveStart(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time)

+ func (lt *LogTracer) OnEmit(name string, ev AnnotatedEvent, derivContext uint64, emitTime time.Time)

+ func (lt *LogTracer) OnRateLimited(name string, derivContext uint64)

+ type Metrics interface

+ RecordEmittedEvent func(eventName string, emitter string)

+ RecordEventsRateLimited func()

+ RecordProcessedEvent func(eventName string, deriver string, duration time.Duration)

+ type MetricsTracer struct

+ func NewMetricsTracer(m Metrics) *MetricsTracer

+ func (mt *MetricsTracer) OnDeriveEnd(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time, ...)

+ func (mt *MetricsTracer) OnDeriveStart(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time)

+ func (mt *MetricsTracer) OnEmit(name string, ev AnnotatedEvent, derivContext uint64, emitTime time.Time)

+ func (mt *MetricsTracer) OnRateLimited(name string, derivContext uint64)

+ type NoopDeriver struct

+ func (d NoopDeriver) OnEvent(ev Event)

+ type NoopEmitter struct

+ func (e NoopEmitter) Emit(ev Event)

+ type NoopMetrics struct

+ func (n NoopMetrics) RecordEmittedEvent(eventName string, emitter string)

+ func (n NoopMetrics) RecordEventsRateLimited()

+ func (n NoopMetrics) RecordProcessedEvent(eventName string, deriver string, duration time.Duration)

+ type RegisterOpts struct

+ Emitter EmitterOpts

+ Executor ExecutorOpts

+ func DefaultRegisterOpts() *RegisterOpts

+ type SequenceTracer struct

+ func NewSequenceTracer() *SequenceTracer

+ func (st *SequenceTracer) Output(showDurations bool) string

+ type StructTracer struct

+ Entries []TraceEntry

+ func NewStructTracer() *StructTracer

+ func (st *StructTracer) OnDeriveEnd(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time, ...)

+ func (st *StructTracer) OnDeriveStart(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time)

+ func (st *StructTracer) OnEmit(name string, ev AnnotatedEvent, derivContext uint64, emitTime time.Time)

+ func (st *StructTracer) OnRateLimited(name string, derivContext uint64)

+ type Sys struct

+ func NewSystem(log log.Logger, ex Executor) *Sys

+ func (s *Sys) AddTracer(t Tracer)

+ func (s *Sys) Register(name string, deriver Deriver, opts *RegisterOpts) Emitter

+ func (s *Sys) RemoveTracer(t Tracer)

+ func (s *Sys) Stop()

+ func (s *Sys) Unregister(name string) (previous Emitter)

+ type System interface

+ AddTracer func(t Tracer)

+ Register func(name string, deriver Deriver, opts *RegisterOpts) Emitter

+ RemoveTracer func(t Tracer)

+ Stop func()

+ Unregister func(name string) (old Emitter)

+ type TimingTracer struct

+ func NewTimingTracer() *TimingTracer

+ func (st *TimingTracer) Output() string

+ type TraceEntry struct

+ DerivContext uint64

+ DeriveEnd struct{ ... }

+ EmitContext uint64

+ EventName string

+ EventTime time.Time

+ Kind TraceEntryKind

+ Name string

+ type TraceEntryKind int

+ const TraceDeriveEnd

+ const TraceDeriveStart

+ const TraceEmit

+ const TraceRateLimited

+ type Tracer interface

+ OnDeriveEnd func(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time, ...)

+ OnDeriveStart func(name string, ev AnnotatedEvent, derivContext uint64, startTime time.Time)

+ OnEmit func(name string, ev AnnotatedEvent, derivContext uint64, emitTime time.Time)

+ OnRateLimited func(name string, derivContext uint64)