audittrail

Documentation

Index

• Variables
• func PublishAuditTrailItem(streamName string, orderID string, status string, ruleName string, ...)
• type ConnectionConfig
• type Entry
• type KinesisPublisher
  • func New(config ConnectionConfig) (KinesisPublisher, error)
  • func SetupKinesisPubSub(config ConnectionConfig, streamName string) KinesisPublisher
• type WebSocketPublisher
  • func Create(port int64, stream string) WebSocketPublisher

Variables

var AuditTrailChannel chan Entry

AuditTrailChannel to receive audit trail item

Functions

func PublishAuditTrailItem

func PublishAuditTrailItem(streamName string, orderID string, status string, ruleName string, description string)

PublishAuditTrailItem creates Audit Trail entry and publishes it

Types

type ConnectionConfig

type ConnectionConfig struct {
	AccessKey  string
	SecretKey  string
	RegionName string
}

ConnectionConfig stores the local connection details

type Entry

type Entry struct {
	OrderID     string
	TimeStamp   time.Time
	Status      string
	RuleName    string
	Description string
}

Entry to record the trail of flow

type KinesisPublisher

type KinesisPublisher interface {
	Connect()
	CreateStream(streamName string) error
	Publish(streamName string, content interface{}) (bool, error)
	GetRecords(streamName string) error
	Disconnect() error
	StreamExists(streamName string) (bool, error)
	DescribeStream(streamName string) (*kinesis.DescribeStreamOutput, error)
}

KinesisPublisher interface providing basic communication methods

var KPInstance KinesisPublisher

KPInstance is an instanceof Kinesis publisher

func New

func New(config ConnectionConfig) (KinesisPublisher, error)

New creates a new kinesis publisher instance

func SetupKinesisPubSub

func SetupKinesisPubSub(config ConnectionConfig, streamName string) KinesisPublisher

SetupKinesisPubSub sets up connection to kinesis and creates the stream if does not exist

type WebSocketPublisher

type WebSocketPublisher interface {
	Start()
}

WebSocketPublisher to publish data to web client

func Create

func Create(port int64, stream string) WebSocketPublisher

Create a new WebSocketPublisher Instance