event

README

Event

A pluggable interface for platform event publishing and subscription.

Interface

It's important to be able to track events at the platform level to know what's changing where. With hundreds of services it can be difficult to track or find a way to enforce this across services. By tracking platform events we can essentially build a platform event correlation system.

type Event interface {
	// publish an event record
	Publish(context.Context, *Record) error
	// subscribe to an event types
	Subscribe(context.Context, Handler, ...string) error
	// Name
	String() string
}

type Record struct {
	Id        string
	Type      string
	Origin    string
	Timestamp int64
	RootId    string
	Metadata  map[string]string
	Data      string
}

func NewEvent(opts ...Option) Event {
	return newOS(opts...)
}

Supported Backends

• Event service

Documentation

Overview

Package event is an interface for event sourcing.

Index

• Variables
• func NewContext(ctx context.Context, c Event) context.Context
• type Event
  • func FromContext(ctx context.Context) (Event, bool)
  • func NewEvent(opts ...Option) Event
• type Handler
• type Option
• type Options
• type Record

Variables

var (
	RecordTopic      = "micro.event.record"
	DefaultEventType = "event"
)

Functions

func NewContext

func NewContext(ctx context.Context, c Event) context.Context

Types

type Event

type Event interface {
	// publish an event record
	Publish(context.Context, *Record) error
	// subscribe to an event types
	Subscribe(context.Context, Handler, ...string) error
	// Name
	String() string
}

func FromContext

func FromContext(ctx context.Context) (Event, bool)

func NewEvent

func NewEvent(opts ...Option) Event

type Handler

type Handler func(*Record)

type Option

type Option func(o *Options)

type Options

type Options struct {
	Client client.Client

	// Alternate options
	Context context.Context
}

type Record

type Record struct {
	Id        string
	Type      string
	Origin    string
	Timestamp int64
	RootId    string
	Metadata  map[string]string
	Data      string
}