megaphone

Documentation

Overview

Package megaphone provides a client for Megaphone, Redbubble's event broadcasting system for inter-service communication.

Index

• type ConfigError
  • func NewConfigError(e error) *ConfigError
  • func NewConfigErrorWithField(e error, field string) *ConfigError
  • func (ce *ConfigError) Error() string
• type FluentdClient
  • func (c *FluentdClient) Publish(topic, subtopic, schema, partitionKey string, payload []byte) (err error)
  • func (c *FluentdClient) PublishRawMessage(streamName string, partitionKey string, messageBytes []byte) error
• type FluentdConfig
• type KinesisSynchronousPublisher
  • func NewKinesisSynchronousPublisher(config kinesisclient.Config) (*KinesisSynchronousPublisher, error)
  • func (c *KinesisSynchronousPublisher) Publish(topic, subtopic, schema, partitionKey string, payload []byte) error
  • func (c *KinesisSynchronousPublisher) PublishRawMessage(streamName string, partitionKey string, messageBytes []byte) error
• type PayloadError
  • func NewPayloadError(e error, payload string) *PayloadError
  • func (pe *PayloadError) Error() string
• type PublicationError
  • func NewPublicationError(e error, event string) *PublicationError
  • func (pe *PublicationError) Error() string
• type Publisher
  • func NewFluentdClient(origin, host string, port int) (c Publisher, err error)

Types

type ConfigError

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

ConfigError is returned when the configuration provided for a Client is invalid.

func NewConfigError

func NewConfigError(e error) *ConfigError

NewConfigError returns a general ConfigError.

func NewConfigErrorWithField

func NewConfigErrorWithField(e error, field string) *ConfigError

NewConfigErrorWithField returns a ConfigError with details about the invalid Config field.

func (*ConfigError) Error

func (ce *ConfigError) Error() string

type FluentdClient

type FluentdClient struct {
	FluentdConfig
	// contains filtered or unexported fields
}

Client provides a standard interface to publish events to Megaphone. Conventionally, a FileLogger is used if no configuration for a FluentLogger is provided, allowing for easy local development in absence of a local Megaphone Fluentd container.

func (*FluentdClient) Publish

func (c *FluentdClient) Publish(topic, subtopic, schema, partitionKey string, payload []byte) (err error)

Publish sends an event to Megaphone, or to a local file depending on the Client configuration.

func (*FluentdClient) PublishRawMessage

func (c *FluentdClient) PublishRawMessage(streamName string, partitionKey string, messageBytes []byte) error

type FluentdConfig

type FluentdConfig struct {
	Origin string
	Host   string
	Port   int
}

FluentdConfig holds the configuration for a FluentdClient.

type KinesisSynchronousPublisher

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

func NewKinesisSynchronousPublisher

func NewKinesisSynchronousPublisher(config kinesisclient.Config) (*KinesisSynchronousPublisher, error)

func (*KinesisSynchronousPublisher) Publish

func (c *KinesisSynchronousPublisher) Publish(topic, subtopic, schema, partitionKey string, payload []byte) error

func (*KinesisSynchronousPublisher) PublishRawMessage

func (c *KinesisSynchronousPublisher) PublishRawMessage(streamName string, partitionKey string, messageBytes []byte) error

type PayloadError

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

PayloadError is returned when the event payload to be published is invalid.

func NewPayloadError

func NewPayloadError(e error, payload string) *PayloadError

NewPayloadError returns a PayloadError for a given event payload.

func (*PayloadError) Error

func (pe *PayloadError) Error() string

type PublicationError

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

PublicationError is returned when an event couldn't be published.

func NewPublicationError

func NewPublicationError(e error, event string) *PublicationError

NewPublicationError return a PublicationError for a given event.

func (*PublicationError) Error

func (pe *PublicationError) Error() string

type Publisher

type Publisher interface {
	Publish(topic, subtopic, schema, partitionKey string, payload []byte) (err error)
	PublishRawMessage(streamName string, partitionKey string, messageBytes []byte) (err error)
}

Publisher provides means to publish an event.

func NewFluentdClient

func NewFluentdClient(origin, host string, port int) (c Publisher, err error)

NewFluentdClient returns a configured Megaphone FluentdClient.