rudderstack

Documentation

Index

• Variables
• func NewRudderstackEventReporter(logger logging.Logger, tracerProvider tracing.TracerProvider, cfg *Config) (analytics.EventReporter, error)
• type Config
  • func (cfg *Config) ValidateWithContext(ctx context.Context) error
• type EventReporter
  • func (c *EventReporter) AddUser(ctx context.Context, userID string, properties map[string]any) error
  • func (c *EventReporter) Close()
  • func (c *EventReporter) EventOccurred(ctx context.Context, event types.ServiceEventType, userID string, ...) error

Variables

var (
	// ErrNilConfig indicates an nil config was provided.
	ErrNilConfig = errors.New("nil config")
	// ErrEmptyAPIToken indicates an empty API token was provided.
	ErrEmptyAPIToken = errors.New("empty API token")
	// ErrEmptyDataPlaneURL indicates an empty data plane URL was provided.
	ErrEmptyDataPlaneURL = errors.New("empty data plane URL")
)

Functions

func NewRudderstackEventReporter

func NewRudderstackEventReporter(logger logging.Logger, tracerProvider tracing.TracerProvider, cfg *Config) (analytics.EventReporter, error)

NewRudderstackEventReporter returns a new Segment-backed EventReporter.

Types

type Config

type Config struct {
	APIKey       string `json:"apiKey"       toml:"api_key"`
	DataPlaneURL string `json:"dataPlaneURL" toml:"data_plane_url,omitempty"`
}

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.

type EventReporter

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

EventReporter is a Segment-backed EventReporter.

func (*EventReporter) AddUser

func (c *EventReporter) AddUser(ctx context.Context, userID string, properties map[string]any) error

AddUser upsert's a user's identity.

func (*EventReporter) Close

func (c *EventReporter) Close()

Close wraps the internal client's Close method.

func (*EventReporter) EventOccurred

func (c *EventReporter) EventOccurred(ctx context.Context, event types.ServiceEventType, userID string, properties map[string]any) error

EventOccurred associates events with a user.