ingest

Documentation

Overview

Package ingest implements event ingestion.

Index

• type Collector
• type DeduplicatingCollector
  • func (d DeduplicatingCollector) Ingest(ev event.Event, namespace string) error
• type Deduplicator
• type InMemoryCollector
  • func NewInMemoryCollector() *InMemoryCollector
  • func (c *InMemoryCollector) Close()
  • func (c *InMemoryCollector) Events(namespace string) []event.Event
  • func (c *InMemoryCollector) Ingest(ev event.Event, namespace string) error
  • func (c *InMemoryCollector) Namespaces() []string

Types

type Collector

type Collector interface {
	Ingest(ev event.Event, namespace string) error
	Close()
}

Collector is a receiver of events that handles sending those events to some downstream broker.

type DeduplicatingCollector

type DeduplicatingCollector struct {
	Collector

	Deduplicator Deduplicator
}

DeduplicatingCollector implements event deduplication at event ingestion.

func (DeduplicatingCollector) Ingest

func (d DeduplicatingCollector) Ingest(ev event.Event, namespace string) error

Ingest implements the {Collector} interface wrapping an existing {Collector} and deduplicating events.

type Deduplicator

type Deduplicator interface {
	// IsUnique checks if an event is unique AND adds it to the deduplication index.
	IsUnique(ctx context.Context, namespace string, ev event.Event) (bool, error)
}

Deduplicator checks if an event is unique.

type InMemoryCollector

type InMemoryCollector struct {
	// contains filtered or unexported fields
}

InMemoryCollector is a {Collector} backed by in-memory storage.

func NewInMemoryCollector

func NewInMemoryCollector() *InMemoryCollector

NewInMemoryCollector returns a new {Collector} backed by in-memory storage.

func (*InMemoryCollector) Close

func (c *InMemoryCollector) Close()

Close implements the {Collector} interface.

func (*InMemoryCollector) Events

func (c *InMemoryCollector) Events(namespace string) []event.Event

Events returns events ingested into a namespace.

func (*InMemoryCollector) Ingest

func (c *InMemoryCollector) Ingest(ev event.Event, namespace string) error

Ingest implements the {Collector} interface.

func (*InMemoryCollector) Namespaces

func (c *InMemoryCollector) Namespaces() []string

Namespaces returns namespaces events were ingested into.