Documentation
¶
Index ¶
- func DecimalExponentialBuckets(lowestPowerOf10 int, powersOf10 int, stepsInBetween int) []float64
- func NewTLSConfigFromClientConfiguration(configuration *configuration.ClientConfiguration) (*tls.Config, error)
- func NewTLSConfigFromServerConfiguration(configuration *configuration.ServerConfiguration) (*tls.Config, error)
- func RegisterAdministrativeHTTPEndpoints(router *mux.Router)
- func StatusFromContext(ctx context.Context) error
- func StatusWrap(err error, msg string) error
- func StatusWrapWithCode(err error, code codes.Code, msg string) error
- func StatusWrapf(err error, format string, args ...interface{}) error
- func StatusWrapfWithCode(err error, code codes.Code, format string, args ...interface{}) error
- func UnmarshalConfigurationFromFile(path string, configuration proto.Message) error
- type ErrorLogger
- type UUIDGenerator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecimalExponentialBuckets ¶
DecimalExponentialBuckets generates a series of exponential bucket boundaries that can be used for Prometheus histogram objects. Instead of using powers of 2, this function uses 10^(1/m) as the exponent. This has the advantage of yielding round numbers at every power of ten.
Instead of computing the actual value of 10^(n/m), we first compute values that are up to five digits accurate within a single power of 10. This is done to ensure that the metric label name remains short and unaffected by the precision of math libraries and hardware floating point units.
Under the hood, strconv.ParseFloat() is used. Unlike math.Pow(), it ensures that the resulting floating point value is the one that yields the desired shortest decimal representation.
func NewTLSConfigFromClientConfiguration ¶
func NewTLSConfigFromClientConfiguration(configuration *configuration.ClientConfiguration) (*tls.Config, error)
NewTLSConfigFromClientConfiguration creates a TLS configuration object based on parameters specified in a Protobuf message for use with a TLS client. This Protobuf message is embedded in Buildbarn configuration files.
func NewTLSConfigFromServerConfiguration ¶
func NewTLSConfigFromServerConfiguration(configuration *configuration.ServerConfiguration) (*tls.Config, error)
NewTLSConfigFromServerConfiguration creates a TLS configuration object based on parameters specified in a Protobuf message for use with a TLS server. This Protobuf message is embedded in Buildbarn configuration files.
func RegisterAdministrativeHTTPEndpoints ¶
RegisterAdministrativeHTTPEndpoints registers HTTP endpoints that are used by all Buildbarn services.
func StatusFromContext ¶
StatusFromContext converts the error associated with a context to a gRPC Status error. This function ensures that errors such as context.DeadlineExceeded are properly converted to Status objects having the code DEADLINE_EXCEEDED.
func StatusWrap ¶
StatusWrap prepends a string to the message of an existing error.
func StatusWrapWithCode ¶
StatusWrapWithCode prepends a string to the message of an existing error, while replacing the error code.
func StatusWrapf ¶
StatusWrapf prepends a formatted string to the message of an existing error.
func StatusWrapfWithCode ¶
StatusWrapfWithCode prepends a formatted string to the message of an existing error, while replacing the error code.
Types ¶
type ErrorLogger ¶
type ErrorLogger interface {
Log(err error)
}
ErrorLogger may be used to report errors. Implementations may decide to log, mutate, redirect and discard them. This interface is used in places where errors are generated asynchronously, meaning they cannot be returned to the caller directly.
var DefaultErrorLogger ErrorLogger = defaultErrorLogger{}
DefaultErrorLogger writes errors using Go's standard logging package.
type UUIDGenerator ¶
UUIDGenerator is equal to the signature of the UUID library's UUID generation functions. It is used within this codebase to make the generator injectable as part of unit tests.
Source Files