models

Documentation

Index

• Constants
• Variables
• func ValidateInhooksConfig(appConf *lib.AppConfig, c *InhooksConfig) error
• type DeliveryAttempt
• type DeliveryAttemptStatus
• type Flow
• type HMACAlgorithm
• type InhooksConfig
• type Message
• type MessageStatus
• type QueueStatus
• type QueuedInfo
• type Sink
• type SinkType
• type Source
• type SourceType
• type Transform
• type TransformDefinition
• type TransformType
• type Verification
• type VerificationType

Constants

const (
	DeliveryAttemptStatusOK     = "ok"
	DeliveryAttemptStatusFailed = "failed"
)

const (
	SinkTypeHttp = "http"
)

const (
	SourceTypeHttp = "http"
)

const (
	TransformTypeJavascript = "javascript"
)

Variables

var HMACAlgorithms = []HMACAlgorithm{
	HMACAlgorithmSHA256,
}

var SinkTypes = []SinkType{
	SinkTypeHttp,
}

var SourceTypes = []SourceType{
	SourceTypeHttp,
}

var TransformTypes = []TransformType{
	TransformTypeJavascript,
}

var VerificationTypes = []VerificationType{
	VerificationTypeHMAC,
}

Functions

func ValidateInhooksConfig

func ValidateInhooksConfig(appConf *lib.AppConfig, c *InhooksConfig) error

ValidateInhooksConfig validates inhooks config and sets defaults

Types

type DeliveryAttempt

type DeliveryAttempt struct {
	At     time.Time             `json:"at"`
	Status DeliveryAttemptStatus `json:"status"`
	Error  string                `json:"error"`
}

type DeliveryAttemptStatus

type DeliveryAttemptStatus string

type Flow

type Flow struct {
	ID     string  `yaml:"id"`
	Source *Source `yaml:"source"`
	Sinks  []*Sink `yaml:"sinks"`
}

type HMACAlgorithm

type HMACAlgorithm string

const (
	HMACAlgorithmSHA256 HMACAlgorithm = "sha256"
)

type InhooksConfig

type InhooksConfig struct {
	Flows                []*Flow                `yaml:"flows"`
	TransformDefinitions []*TransformDefinition `yaml:"transform_definitions"`
}

type Message

type Message struct {
	ID       string `json:"id"`
	FlowID   string `json:"flowID"`
	SourceID string `json:"sourceID"`
	// Ingested Request ID
	IngestedReqID string      `json:"ingestedReqID"`
	SinkID        string      `json:"sinkID"`
	HttpHeaders   http.Header `json:"httpHeaders"`
	RawQuery      string      `json:"rawQuery"`
	Payload       []byte      `json:"payload"`

	// Processing Info
	DeliveryAttempts []*DeliveryAttempt `json:"deliveryAttempts"`
	DeliverAfter     time.Time
}

type MessageStatus

type MessageStatus string

type QueueStatus

type QueueStatus string

const (
	QueueStatusScheduled  QueueStatus = "scheduled"
	QueueStatusReady      QueueStatus = "ready"
	QueueStatusProcessing QueueStatus = "processing"
	QueueStatusDone       QueueStatus = "done"
	QueueStatusDead       QueueStatus = "dead"
)

type QueuedInfo

type QueuedInfo struct {
	MessageID    string
	QueueStatus  QueueStatus
	DeliverAfter time.Time
}

type Sink

type Sink struct {
	// Sink ID
	ID string `yaml:"id"`
	// Sink Type
	Type SinkType `yaml:"type"`
	// Sink Url for HTTP sinks
	URL string `yaml:"url"`
	// Process after delay
	Delay *time.Duration `yaml:"delay"`
	// Retry every x time
	RetryInterval *time.Duration `yaml:"retryInterval"`
	// Retry exponential multiplier. 1 is constant backoff. Set to > 1 for exponential backoff.
	RetryExpMultiplier *float64 `yaml:"retryExpMultiplier"`
	// Max attempts
	MaxAttempts *int `yaml:"maxAttempts"`
	// Transform to apply to the data
	Transform *Transform `yaml:"transform"`
}

type SinkType

type SinkType string

type Source

type Source struct {
	ID           string        `yaml:"id"`
	Slug         string        `yaml:"slug"`
	Type         SourceType    `yaml:"type"`
	Verification *Verification `yaml:"verification"`
}

type SourceType

type SourceType string

type Transform

type Transform struct {
	ID string `yaml:"id"`
}

type TransformDefinition

type TransformDefinition struct {
	ID     string        `yaml:"id"`
	Type   TransformType `yaml:"type"`
	Script string        `yaml:"script"`
}

type TransformType

type TransformType string

type Verification

type Verification struct {
	VerificationType     VerificationType `yaml:"verificationType"`
	HMACAlgorithm        *HMACAlgorithm   `yaml:"hmacAlgorithm"`
	SignatureHeader      string           `yaml:"signatureHeader"`
	SignaturePrefix      string           `yaml:"signaturePrefix"`
	CurrentSecretEnvVar  string           `yaml:"currentSecretEnvVar"`
	PreviousSecretEnvVar string           `yaml:"previousSecretEnvVar"`
}

type VerificationType

type VerificationType string

const (
	VerificationTypeHMAC VerificationType = "hmac"
)