config

Documentation

Overview

package config provides configuration types and functions for Substation.

Any non-backwards compatible changes to the configuration types should be accompanied by a version bump.

Index

• func Decode(input, output interface{}) error
• type AWS
• type Buffer
• type Metric
• type Object
• type Request
• type Retry

Functions

func Decode

func Decode(input, output interface{}) error

Decode marshals and unmarshals an input interface into the output interface using the standard library's json package. This should be used when decoding JSON configurations (i.e., Config) in Substation interface factories.

Types

type AWS

type AWS struct {
	Region        string `json:"region"`
	AssumeRoleARN string `json:"assume_role_arn"`
}

type Buffer

type Buffer struct {
	Count    int    `json:"count"`
	Size     int    `json:"size"`
	Duration string `json:"duration"`
	Key      string `json:"key"`
}

Buffer should be used by any transform that supports buffering data with internal/aggregate.

type Metric

type Metric struct {
	Name        string            `json:"name"`
	Attributes  map[string]string `json:"attributes"`
	Destination config.Config     `json:"destination"`
}

type Object

type Object struct {
	Key    string `json:"key"`
	SetKey string `json:"set_key"`
}

type Request

type Request struct {
	Timeout string `json:"Timeout"`
}

type Retry

type Retry struct {
	Count int `json:"count"`
}