config

Documentation

Index

• type Advisory
• type ChoriaConnection
  • func (c *ChoriaConnection) Collective() string
  • func (c *ChoriaConnection) SeedFile() string
  • func (c *ChoriaConnection) TokenFile() string
• type Config
  • func Load(file string) (*Config, error)
  • func (c *Config) Validate() (err error)
• type HeartBeat
• type Stream
• type Subject
• type TLS
  • func (t *TLS) CertificateAuthority() string
  • func (t *TLS) PrivateKey() string
  • func (t *TLS) PublicCertificate() string

Types

type Advisory

type Advisory struct {
	// Subject is the NATS subject to publish messages too, a %s in the string will be replaced by the event type, %v with the value
	Subject string `json:"subject"`

	// Reliable indicates that the subject is a JetStream subject, so we should retry deliveries of advisories
	Reliable bool `json:"reliable"`
}

type ChoriaConnection

type ChoriaConnection struct {
	SeedFileName   string `json:"seed_file"`
	JWTFileName    string `json:"jwt_file"`
	CollectiveName string `json:"collective"`
}

func (*ChoriaConnection) Collective

func (c *ChoriaConnection) Collective() string

func (*ChoriaConnection) SeedFile

func (c *ChoriaConnection) SeedFile() string

func (*ChoriaConnection) TokenFile

func (c *ChoriaConnection) TokenFile() string

type Config

type Config struct {
	// ReplicatorName is a name for the site, used in stats, logs and headers to distinguish origin
	ReplicatorName string `json:"name"`
	// Streams are a list of streams to replicate
	Streams []*Stream `json:"streams"`
	// StateDirectory is where limiters will store state
	StateDirectory string `json:"state_store"`
	// TLS configures an overall default TLS when not set in stream or target/source level
	TLS *TLS `json:"tls"`
	// ChoriaConn configures an overall defaults Choria configuration when not set in stream or start/source level
	ChoriaConn *ChoriaConnection `json:"choria"`
	// MonitorPort is where prometheus stats will be exposed
	MonitorPort int `json:"monitor_port"`
	// Profiling enables starting go profiling on the monitor port
	Profiling bool `json:"profiling"`
	// LogLevel file to log to, stdout when empty
	LogFile string `json:"logfile"`
	// LogLevel is the logging level: debug, warn or info
	LogLevel string `json:"loglevel"`
	// Heartbeat defines monitoring heartbeats
	HeartBeat *HeartBeat `json:"heartbeats"`
}

func Load

func Load(file string) (*Config, error)

func (*Config) Validate

func (c *Config) Validate() (err error)

type HeartBeat

type HeartBeat struct {
	// LeaderElection indicates that this replicator is part of a group and will elect a leader to send hearbeats
	LeaderElection bool `json:"leader_election"`
	// Interval determines how often a heartbeat message will be sent
	Interval string `json:"interval"`
	// Headers are custom headers to add to the heartbeat message
	Headers map[string]string `json:"headers"`
	// Subjects are the subjects the heatbeat messages will be sent to
	Subjects []Subject `json:"subjects"`
	// TLS is TLS settings that would be used,
	TLS TLS `json:"tls"`
	// Choria is the Choria settings that would be used
	Choria ChoriaConnection `json:"choria"`
	// URL is the url of the nats broker
	URL string `json:"url"`
}

type Stream

type Stream struct {
	// Name is a friendly name that will be used in the consumer name and show up in every message header
	Name string `json:"name"`
	// Stream is the source stream name
	Stream string `json:"stream"`
	// FilterSubject creates a consumer that listens to a specific subject only
	FilterSubject string `json:"filter_subject"`
	// TargetStream is the name of the stream on the remote, if this is unset the Stream value will be used
	TargetStream string `json:"target_stream"`
	// TargetPrefix is a prefix to put in-front of subjects from the Stream. The final subject is <prefix>.<msg subject>
	TargetPrefix string `json:"target_subject_prefix"`
	// TargetRemoveString removes a part from the target subject after applying the prefix
	TargetRemoveString string `json:"target_subject_remove"`
	// SourceURL is the NATS server to source messages from in nats://user:pass@server form
	SourceURL string `json:"source_url"`
	// TargetURL is the NATS server to send messages to in nats://user:pass@server form
	TargetURL string `json:"target_url"`
	// TargetInitiated indicates that the replicator is running nearest to the target and so will use a latency optimized approach
	TargetInitiated bool `json:"target_initiated"`
	// StartSequence is an optional initial sequence to replicate from
	StartSequence uint64 `json:"start_sequence"`
	// StartTime is an optional initial time to replicate from in the RFC3339 form eg. 2006-01-02T15:04:05Z07:00
	StartTime time.Time `json:"start_time"`
	// StartDeltaString is a duration for time since now to start replicating from, 1h, 1d, 1w, 1M, 1Y
	StartDeltaString string `json:"start_delta"`
	// StartAtEnd indicates that the next message to arrive should be the first to be replicated
	StartAtEnd bool `json:"start_at_end"`
	// TLS is TLS settings that would be used, see also SourceTLS and TargetTLS
	TLS *TLS `json:"tls"`
	// SourceTLS overrides TLS for the source only
	SourceTLS *TLS `json:"source_tls"`
	// TargetTLS overrides TLS for the target only
	TargetTLS *TLS `json:"target_tls"`
	// ChoriaConn is Choria connection settings that would be used, see also SourceChoriaConn and TargetChoriaConn
	ChoriaConn *ChoriaConnection `json:"choria"`
	// SourceChoriaConn overrides the Choria connection for a specific source only
	SourceChoriaConn *ChoriaConnection `json:"source_choria"`
	// TargetChoriaConn overrides the Choria connection for a specific target only
	TargetChoriaConn *ChoriaConnection `json:"target_choria"`

	// MaxAgeString will skip messages older than this
	MaxAgeString string `json:"max_age"`
	// InspectJSONField will inspect a specific field in JSON payloads and limit sends by this field
	InspectJSONField string `json:"inspect_field"`
	// InspectHeaderValue inspects the value of a header and does limiting based on that
	InspectHeaderValue string `json:"inspect_header"`
	// InspectSubjectToken inspects a certain token and limits based on that, -1 inspects the entire subject, 0 disables
	InspectSubjectToken int `json:"inspect_subject_token"`
	// InspectDurationString will limit the sending of messages to 1 per duration based on the value of InspectJSONField
	InspectDurationString string `json:"inspect_duration"`
	// WarnDurationString is how long to allow an item not to be seen before advising about it
	WarnDurationString string `json:"warn_duration"`
	// PayloadSizeTrigger sets a trigger size that, if a message has a size change bigger than this, will cause an immediate replicate to do overriding the usual inspect_duration based limits
	PayloadSizeTrigger float64 `json:"size_trigger"`
	// LeaderElection indicates that this replicator is part of a group and will elect a leader to replicate, limiter will share state among the group
	LeaderElectionName string `json:"leader_election_name"`

	// AdvisoryConf configures advisories for streams with Inspection enabled
	AdvisoryConf *Advisory `json:"advisory"`

	// StartDelta is a parsed StartDeltaString
	StartDelta time.Duration `json:"-"`
	// InspectDuration is a parsed InspectDurationString
	InspectDuration time.Duration `json:"-"`
	// WarnDuration is a parsed WarnDurationString
	WarnDuration time.Duration `json:"-"`
	// MaxAgeDuration will discard messages older than this
	MaxAgeDuration time.Duration `json:"-"`
	// StateFile where state will be written
	StateFile string `json:"-"`
}

type Subject

type Subject struct {
	// Name is the name of the subject
	Name string `json:"subject"`
	// Interval determines how often a heartbeat message will be sent
	Interval string `json:"interval"`
	// Headers are custom headers to add to the heartbeat message
	Headers map[string]string `json:"headers"`
}

type TLS

type TLS struct {
	CA   string `json:"ca"`
	Cert string `json:"cert"`
	Key  string `json:"key"`
}

func (*TLS) CertificateAuthority

func (t *TLS) CertificateAuthority() string

func (*TLS) PrivateKey

func (t *TLS) PrivateKey() string

func (*TLS) PublicCertificate

func (t *TLS) PublicCertificate() string