runenv

Documentation

Index

• Constants
• func AvailabilityZone() (string, error)
• func Datacenter() (string, error)
• func ExecutorID() (string, error)
• func Hostname() (string, error)
• func IP() net.IP
• func MarathonAppID() (string, error)
• func MesosAgentEndpoint() (string, error)
• func OsHostname() (string, error)
• func Region() (string, error)
• func TaskID() (string, error)
• type Env
  • func Environment() (Env, error)

Constants

const (
	// LocalEnv represents local environment.
	LocalEnv = Env("local")
	// DevEnv represents development environment.
	DevEnv = Env("dev")
	// TestEnv represents test environment.
	TestEnv = Env("test")
	// ProdEnv represents production environment.
	ProdEnv = Env("prod")
)

Functions

func AvailabilityZone

func AvailabilityZone() (string, error)

AvailabilityZone return the name of runtime availability zone. It returns empty string with erro if it cannot determine the name.

func Datacenter

func Datacenter() (string, error)

Datacenter returns the name of runtime datacenter. It returns empty string with error if it cannot determine the name.

func ExecutorID

func ExecutorID() (string, error)

ExecutorID returns mesos executor ID. It returns empty string with error if it cannot determine the ID.

func Hostname

func Hostname() (string, error)

Hostname returns the host name reported by Mesos, cloud or operating system.

func IP

func IP() net.IP

IP returns the IP of runtime host.

func MarathonAppID

func MarathonAppID() (string, error)

MarathonAppID returns ID of Marathon application in which context the process is running. It returns empty string with error if it cannot determine the ID.

func MesosAgentEndpoint

func MesosAgentEndpoint() (string, error)

MesosAgentEndpoint returns Mesos Agent endpoint. It returns empty string with error if it cannot determine Agent endpoint.

func OsHostname

func OsHostname() (string, error)

OsHostname returns result of calling hostname -f command, resorting to golang's os package if necessary

func Region

func Region() (string, error)

Region returns the name of runtime cloud region. It returns empty string with error if it cannot determine the name.

func TaskID

func TaskID() (string, error)

TaskID returns mesos task ID. It returns empty string with error if it cannot determine the ID.

Types

type Env

type Env string

Env is name of the environment on which service is running.

func Environment

func Environment() (Env, error)

Environment returns current environment based on hostname. If it cannot determine the hostname it returns an error.