prometheus

Documentation

Index

• type MiddlewareBuilder
  • func (m MiddlewareBuilder) Build() mist.Middleware

Types

type MiddlewareBuilder

type MiddlewareBuilder struct {
	Namespace string // Namespace is a top-level categorization that groups related subsystems. It's meant to prevent collisions between different subsystems.
	Subsystem string // Subsystem is a second-level categorization beneath namespace that allows for grouping related functionalities.
	Name      string // Name is the individual identifier for a specific middleware component. It should be unique within the namespace and subsystem.
	Help      string // Help is a descriptive string that provides insights into what the middleware does or is used for. It may be exposed in monitoring tools or documentation.
}

MiddlewareBuilder is a struct that holds metadata for identifying and describing a set of middleware. This metadata includes details that are typically used for logging, monitoring, or other forms of introspection. The struct is not a middleware itself, but rather a collection of descriptive fields that may be associated with middleware operations.

func (MiddlewareBuilder) Build

func (m MiddlewareBuilder) Build() mist.Middleware

Build constructs and returns a new prometheus monitoring middleware for use within the mist framework. The MiddlewareBuilder receiver attaches the newly built prometheus metric collection functionality to mist Middleware. The metrics collected are specifically SummaryVec which help in observing the request latency distribution.