package
1.11.9
Repository: https://github.com/xmidt-org/webpa-common.git
Documentation: pkg.go.dev

# Functions

Configure is a one-stop shopping function for preparing WebPA configuration.
ConfigureFlagSet adds the standard set of WebPA flags to the supplied FlagSet.
ConfigureViper configures a Viper instances using the opinionated WebPA settings.
create CPUProfileFiles creates a cpu profile of the server, its triggered by the optional flag cpuprofile the CPU profile is created on the server's start.
Create CPUProfileFiles creates a memory profile of the server, its triggered by the optional flag memprofile the memory profile is created on the server's exit.
No description provided by the author
Initialize handles the bootstrapping of the server code for a WebPA node.
ListenAndServe invokes the server method.
Metrics is the module function for this package that adds the default request handling metrics.
NewConnectionStateLogger produces a function appropriate for http.Server.ConnState.
NewErrorLog creates a new logging.Logger appropriate for http.Server.ErrorLog.
No description provided by the author
Serve is like ListenAndServe, but accepts a custom net.Listener.
SignalWait blocks until any of a set of signals is encountered.

# Constants

No description provided by the author
AlternateSuffix is the suffix appended to the server name, along with a period (.), for logging information pertinent to the alternate server.
No description provided by the author
CPUProfileFlagName is the command-line flag for creating a cpuprofile on the server.
CPUProfileShortHand is the command-line shortcut for creating cpushorthand on the server.
No description provided by the author
No description provided by the author
DefaultHealthAddress is the bind address of the health check server.
DefaultHealthLogInterval is the interval at which health statistics are emitted when a non-positive log interval is specified.
No description provided by the author
DefaultLogConnectionState is the default setting for logging connection state messages.
No description provided by the author
DefaultMetricsAddress is the bind address of the metrics server.
DefaultPprofAddress is the bind address of the pprof server.
DefaultPrimaryAddress is the bind address of the primary server (e.g.
DefaultProject is used as a metrics namespace when one is not defined.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FileFlagName is the name of the command-line flag for specifying an alternate configuration file for Viper to hunt for.
FileFlagShorthand is the command-line shortcut flag for FileFlagName.
HealthSuffix is the suffix appended to the server name, along with a period (.), for logging information pertinent to the health server.
No description provided by the author
No description provided by the author
MemProfileFlagName is the command-line flag for creating memprofile on the server.
MemProfileShortHand is the command-line shortcut for creating memprofile on the server.
MetricsSuffix is the suffix appended to the server name, along with a period (.), for logging information pertinent to the metrics server.
PprofSuffix is the suffix appended to the server name, along with a period (.), for logging information pertinent to the pprof server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrorNoPrimaryAddress is the error returned when no primary address is specified in a WebPA instance.

# Structs

Basic describes a simple HTTP server.
Health represents a configurable factory for a Health server.
Metric is the configurable factory for a metrics server.
WebPA represents a server component within the WebPA cluster.

# Type aliases

No description provided by the author