def

package

v1.1.2 Latest Latest Go to latest Published: Sep 13, 2020 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/powerman/go-service-example

Links

Open Source Insights

Documentation ¶

Overview ¶

Package def provides default values for both commands and tests.

Index ¶

Constants
Variables
func Init() error
func Version() string
type Metrics
- func NewMetrics(reg *prometheus.Registry) Metrics

Constants ¶

View Source

const (
	LogServer     = "server"     // "OpenAPI", "gRPC", "Prometheus metrics", etc.
	LogRemote     = "remote"     // Aligned IPv4:Port "   192.168.0.42:1234 ".
	LogAddr       = "addr"       // host:port.
	LogHost       = "host"       // DNS hostname or IPv4/IPv6 address.
	LogPort       = "port"       // TCP/UDP port number.
	LogHTTPMethod = "httpMethod" // GET, POST, etc.
	LogHTTPStatus = "httpStatus" // Status code: 200, 404, etc.
	LogFunc       = "func"       // RPC/event handler method name, REST resource path.
	LogUserID     = "userID"
)

Log field names.

Variables ¶

View Source

var (
	ProgName    = strings.TrimSuffix(path.Base(os.Args[0]), ".test")
	Hostname, _ = os.Hostname()

	TestSecond  = time.Duration(float64(time.Second) * testTimeFactor)
	TestTimeout = 7 * TestSecond
)

Constants.

Functions ¶

func Init ¶

func Init() error

Init must be called once before using this package. It provides common initialization for both commands and tests.

func Version ¶

func Version() string

Version returns application version based on build info.

Types ¶

type Metrics ¶

type Metrics struct {
	PanicsTotal           prometheus.Counter
	MisconfigurationTotal prometheus.Counter
}

Metrics shared by all packages.

func NewMetrics ¶

func NewMetrics(reg *prometheus.Registry) Metrics

NewMetrics registers and returns metrics shared by all packages.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL