sink

Documentation

Index

• type AnalyticsReporter
• type Elasticsearch
  • func NewElasticsearch(log logrus.FieldLogger, commGroupIdx int, c config.Elasticsearch, ...) (*Elasticsearch, error)
  • func (e *Elasticsearch) GetStatus() health.PlatformStatus
  • func (e *Elasticsearch) IntegrationName() config.CommPlatformIntegration
  • func (e *Elasticsearch) SendEvent(ctx context.Context, rawData any, sources []string) error
  • func (e *Elasticsearch) Type() config.IntegrationType
• type Sink
• type Webhook
  • func NewWebhook(log logrus.FieldLogger, commGroupIdx int, c config.Webhook, ...) (*Webhook, error)
  • func (w *Webhook) GetStatus() health.PlatformStatus
  • func (w *Webhook) IntegrationName() config.CommPlatformIntegration
  • func (w *Webhook) PostWebhook(ctx context.Context, jsonPayload *WebhookPayload) (err error)
  • func (w *Webhook) SendEvent(ctx context.Context, rawData any, sources []string) error
  • func (w *Webhook) Type() config.IntegrationType
• type WebhookPayload

Types

type AnalyticsReporter

type AnalyticsReporter interface {
	// ReportSinkEnabled reports an enabled sink.
	ReportSinkEnabled(platform config.CommPlatformIntegration, commGroupIdx int) error
}

AnalyticsReporter defines a reporter that collects analytics data for sinks.

type Elasticsearch

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

Elasticsearch provides integration with the Elasticsearch solution.

func NewElasticsearch

func NewElasticsearch(log logrus.FieldLogger, commGroupIdx int, c config.Elasticsearch, reporter AnalyticsReporter) (*Elasticsearch, error)

NewElasticsearch creates a new Elasticsearch instance.

func (*Elasticsearch) GetStatus

func (e *Elasticsearch) GetStatus() health.PlatformStatus

GetStatus gets sink status

func (*Elasticsearch) IntegrationName

func (e *Elasticsearch) IntegrationName() config.CommPlatformIntegration

IntegrationName describes the notifier integration name.

func (*Elasticsearch) SendEvent

func (e *Elasticsearch) SendEvent(ctx context.Context, rawData any, sources []string) error

SendEvent sends an event to a configured elasticsearch server.

func (*Elasticsearch) Type

func (e *Elasticsearch) Type() config.IntegrationType

Type describes the notifier type.

type Sink

type Sink interface {
	notifier.Sink
}

Sink sends messages to communication channels. It is a one-way integration.

type Webhook

type Webhook struct {
	URL      string
	Bindings config.SinkBindings
	// contains filtered or unexported fields
}

Webhook provides functionality to notify external service about new events.

func NewWebhook

func NewWebhook(log logrus.FieldLogger, commGroupIdx int, c config.Webhook, reporter AnalyticsReporter) (*Webhook, error)

NewWebhook creates a new Webhook instance.

func (*Webhook) GetStatus

func (w *Webhook) GetStatus() health.PlatformStatus

GetStatus gets sink status

func (*Webhook) IntegrationName

func (w *Webhook) IntegrationName() config.CommPlatformIntegration

IntegrationName describes the notifier integration name.

func (*Webhook) PostWebhook

func (w *Webhook) PostWebhook(ctx context.Context, jsonPayload *WebhookPayload) (err error)

PostWebhook posts webhook to listener

func (*Webhook) SendEvent

func (w *Webhook) SendEvent(ctx context.Context, rawData any, sources []string) error

SendEvent sends an event to a configured server.

func (*Webhook) Type

func (w *Webhook) Type() config.IntegrationType

Type describes the notifier type.

type WebhookPayload

type WebhookPayload struct {
	Source    string    `json:"source,omitempty"`
	Data      any       `json:"data,omitempty"`
	TimeStamp time.Time `json:"timeStamp"`
}

WebhookPayload contains json payload to be sent to webhook url