config

Documentation

Index

• func CacheTime() int
• func ConcurrentOpacityCheckingEnabled() bool
• func DebugModeEnabled() bool
• func DefaultParams() []string
• func LogLevel() string
• func MetricsSystem() string
• func Update()
• func Viper() *viper.Viper
• type Cloudfront
• type GoogleCloudStorage
• type S3Bucket
• type Source
  • func DataSource() *Source
• type StatsdCollectorConfig
  • func StatsdConfig() *StatsdCollectorConfig
• type WebFolder

Functions

func CacheTime

func CacheTime() int

CacheTime returns the time to set the cache-time in image handler from the environment

func ConcurrentOpacityCheckingEnabled

func ConcurrentOpacityCheckingEnabled() bool

ConcurrentOpacityCheckingEnabled returns true if we want to process image using multiple cores (checking isOpaque)

func DebugModeEnabled

func DebugModeEnabled() bool

DebugModeEnabled returns the debug mode bool from the environment

func DefaultParams

func DefaultParams() []string

DefaultParams returns []string of default parameters (separated by semicolon) which will be applied to all image request, following the existing contract

func LogLevel

func LogLevel() string

LogLevel returns the log level for logger from the environment

func MetricsSystem

func MetricsSystem() string

MetricSystem returns the metrics system to be used for MetricService in dependencies from the environment

func Update

func Update()

Update creates a new instance of the configuration and reads all values again

func Viper

func Viper() *viper.Viper

Viper creates a new singleton instance of viper.Viper

Types

type Cloudfront

type Cloudfront struct {
	// Host is the FQDN for the cloudfront integration on the S3 bucket
	Host string
	// SecureProtocol designates whether to use http or https protocol for requests
	SecureProtocol bool
}

Cloudfront contains the configuration for cloudfront which can be used with an S3 bucket

type GoogleCloudStorage

type GoogleCloudStorage struct {
	// Name of the bucket
	Name string
	// CredentialsJSON of the service account associated with the bucket
	CredentialsJSON string
}

GoogleCloudStorage contains the configuration values for GoogleCloudStorage source

type S3Bucket

type S3Bucket struct {
	// Name of the bucket
	Name string
	// Region of the bucket
	Region string
	// Access key that should be used to access the bucket
	AccessKey string
	// Secret key that should be used to access the bucket
	SecretKey string
	// Endpoint overrides the default generated endpoint for bucket client
	Endpoint string
}

S3Bucket contains the configuration values for S3 source

type Source

type Source struct {
	// Kind tells which type of Storage backend should be used
	Kind string
	// HystrixCommand provides the hystrix config to be used with the source to add resiliency
	HystrixCommand storage.HystrixCommand
	// Value is and interface which holds the actual kind of the object
	Value interface{}
	// PathPrefix is used to restrict access to specific paths only via the image proxy
	PathPrefix string
}

Source contains the configuration for data source object that will be used, the type of the data source, hystrix command, and the path prefix to restring access

func DataSource

func DataSource() *Source

DataSource returns the source struct after it is initialised from the environment values

type StatsdCollectorConfig

type StatsdCollectorConfig struct {
	// StatsdAddr is the tcp address of the Statsd server
	StatsdAddr string
	// Prefix is the prefix that will be prepended to all metrics sent from this collector.
	Prefix string
	// StatsdSampleRate sets statsd sampling. If 0, defaults to 1.0. (no sampling)
	SampleRate float32
	// FlushBytes sets message size for statsd packets. If 0, defaults to LANFlushSize.
	FlushBytes int
}

StatsdCollectorConfig contains the configuration required to initialize Statsd client

func StatsdConfig

func StatsdConfig() *StatsdCollectorConfig

StatsdConfig returns the config for statsd client initialization in dependencies from the environment

type WebFolder

type WebFolder struct {
	// BaseURL that should be appended to the path
	// Eg: https://example.com/web-folder/{path} will map to https://host.com/{path}
	BaseURL string
}

WebFolder contains the configuration for a directory available on the public internet