app

Documentation

Overview

Package app has the static app info

Index

• Variables
• func SetName(name string)
• type Data
  • func Info() *Data
  • func (d *Data) MarshalLog(addField func(key string, v interface{}))

Variables

var Version = "Please see http://github.com/getoutreach/gobox/blob/master/docs/version.md"

Version needs to be set at build time using -ldflags "-X github.com/getoutreach/gobox/pkg/app.Version=something" nolint:gochecknoglobals

Functions

func SetName

func SetName(name string)

SetName sets the app name

Should only be called from tests and app initialization

Types

type Data

type Data struct {
	Name    string
	Version string

	MainModule string

	Environment    string
	Namespace      string
	ServiceAccount string
	ClusterName    string
	Region         string
	PodID          string
	NodeID         string
	Deployment     string

	// ServiceID is a unique identifier for the service used primarily
	// within the `authn` framework.
	ServiceID string

	Bento string
}

Data provides the global app info

func Info

func Info() *Data

Info returns the static app info

This struct is used mainly to provide tags to append to logs. It's also used by a handful of infrastructure-y packages like Mint or orgservice that have special needs. Most services will never need to access it directly.

func (*Data) MarshalLog

func (d *Data) MarshalLog(addField func(key string, v interface{}))

MarshalLog marshals the struct for logging