Documentation
¶
Index ¶
- Constants
- func AWSLookup(host string) string
- func Get(key string, defaultVal string) string
- func GetEnvMap() map[string]string
- func IsDockerSocket(value string) bool
- func LookupContainerID() string
- func LookupHostPort(localPort int, socket string, hostPort int) int
- func NewInvalidSpecificationError() errors.TracerError
- func NewMissingEnvironmentVariableError(field string, tag string) errors.TracerError
- func NewUnsupportedDataTypeError(dataType reflect.Kind, field string) errors.TracerError
- func Process(config interface{}) error
- func ProcessMap(config interface{}, envVars map[string]string) error
- func Push(config interface{}) error
- func RedisAddress() string
- func RedisHost() string
- func RedisPort() int
- type Bucket
- type InvalidSpecificationError
- type MissingEnvironmentVariableError
- type UnsupportedDataTypeError
Constants ¶
const NoS3EnvVar = "NO_S3_ENV_VARS"
NoS3EnvVar is the environment variable to set when you so not want to try and pull from S3.
Variables ¶
This section is empty.
Functions ¶
func AWSLookup ¶
AWSLookup tries to perform a Get against the provided URL This is a work around intended to get the Local Host IP / Name for the EC2 instance that service is running on through the AWS Meta data service since we can't dynamically set that environment variable.
func Get ¶
Get returns the value of an environment variable if the variable is set, else the default value
func IsDockerSocket ¶
IsDockerSocket checks that the string has the correct prefix for a docker service lookup
func LookupContainerID ¶
func LookupContainerID() string
LookupContainerID checks the /etc/hostname for the Container ID The default docker behavior is to place the Short Container ID in /etc/hostname
func LookupHostPort ¶
LookupHostPort uses the docker socket to query the Host Port The `docker info` command can provide the host port information, the dockerclient is a wrapper for docker calls. The docker container needs to be configured with the dockerSocket mounted
func NewInvalidSpecificationError ¶
func NewInvalidSpecificationError() errors.TracerError
NewInvalidSpecificationError instantiates a InvalidSpecificationError with a stack trace
func NewMissingEnvironmentVariableError ¶
func NewMissingEnvironmentVariableError(field string, tag string) errors.TracerError
NewMissingEnvironmentVariableError instantiates a MissingEnvironmentVariableError with a stack trace
func NewUnsupportedDataTypeError ¶
func NewUnsupportedDataTypeError(dataType reflect.Kind, field string) errors.TracerError
NewUnsupportedDataTypeError instantiates a UnsupportedDataTypeError with a stack trace
func Process ¶
func Process(config interface{}) error
Process takes a Specification that describes the configuration for the application only attributes tagged with `env:""` will be imported from the environment Example Specification:
type Specification struct {
DatabaseURL string `env:"DATABASE_URL"`
ServiceID string `env:"SERVICE_ID,optional"`
}
Supported options: optional
func ProcessMap ¶
ProcessMap is the same as Process except that the environment variable map is supplied instead of retrieved
func Push ¶
func Push(config interface{}) error
Push the passed specification object onto the environment, note that these changes will not live past the life of this process.
func RedisAddress ¶
func RedisAddress() string
RedisAddress returns the combined host and port from the environment
Types ¶
type Bucket ¶
type Bucket struct {
Downloader *s3manager.Downloader
// contains filtered or unexported fields
}
Bucket wraps the S3 downloader with an in memory cache
func NewBucket ¶
func NewBucket() *Bucket
NewBucket returns a Bucket with an S3 downloader and an initialized cache
type InvalidSpecificationError ¶
type InvalidSpecificationError struct {
// contains filtered or unexported fields
}
InvalidSpecificationError indicates that a config is of the wrong type.
func (*InvalidSpecificationError) Error ¶
func (err *InvalidSpecificationError) Error() string
func (*InvalidSpecificationError) Trace ¶
func (err *InvalidSpecificationError) Trace() []string
Trace returns the stack trace for the error
type MissingEnvironmentVariableError ¶
type MissingEnvironmentVariableError struct {
Field string
Tag string
// contains filtered or unexported fields
}
MissingEnvironmentVariableError indicates that a non-optional variable was not found in the environment
func (MissingEnvironmentVariableError) Error ¶
func (err MissingEnvironmentVariableError) Error() string
func (*MissingEnvironmentVariableError) Trace ¶
func (err *MissingEnvironmentVariableError) Trace() []string
Trace returns the stack trace for the error
type UnsupportedDataTypeError ¶
type UnsupportedDataTypeError struct {
Type reflect.Kind
Field string
// contains filtered or unexported fields
}
UnsupportedDataTypeError indicates that no conversion from string to the given type has been implemented
func (UnsupportedDataTypeError) Error ¶
func (err UnsupportedDataTypeError) Error() string
func (*UnsupportedDataTypeError) Trace ¶
func (err *UnsupportedDataTypeError) Trace() []string
Trace returns the stack trace for the error
Source Files