Documentation ¶
Index ¶
- type Prometheus
- func (p *Prometheus) SetListenAddress(address string)
- func (p *Prometheus) SetPushGateway(pushGatewayURL, metricsURL string, pushIntervalSeconds time.Duration)
- func (p *Prometheus) SetPushGatewayJob(j string)
- func (p *Prometheus) Use(e *gin.Engine)
- func (p *Prometheus) UseWithAuth(e *gin.Engine, accounts gin.Accounts)
- type PrometheusPushGateway
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Prometheus ¶
type Prometheus struct { Ppg PrometheusPushGateway MetricsPath string // contains filtered or unexported fields }
Prometheus contains the metrics gathered by the instance and its path
func NewPrometheus ¶
func NewPrometheus(subsystem string) *Prometheus
NewPrometheus generates a new set of metrics with a certain subsystem name
func (*Prometheus) SetListenAddress ¶
func (p *Prometheus) SetListenAddress(address string)
SetListenAddress for exposing metrics on address. If not set, it will be exposed at the same address of the gin engine that is being used
func (*Prometheus) SetPushGateway ¶
func (p *Prometheus) SetPushGateway(pushGatewayURL, metricsURL string, pushIntervalSeconds time.Duration)
SetPushGateway sends metrics to a remote pushgateway exposed on pushGatewayURL every pushIntervalSeconds. Metrics are fetched from metricsURL
func (*Prometheus) SetPushGatewayJob ¶
func (p *Prometheus) SetPushGatewayJob(j string)
Set pushgateway job name, defaults to "gin"
func (*Prometheus) Use ¶
func (p *Prometheus) Use(e *gin.Engine)
Use adds the middleware to a gin engine.
func (*Prometheus) UseWithAuth ¶
func (p *Prometheus) UseWithAuth(e *gin.Engine, accounts gin.Accounts)
UseWithAuth adds the middleware to a gin engine with BasicAuth.
type PrometheusPushGateway ¶
type PrometheusPushGateway struct { // Push interval in seconds PushIntervalSeconds time.Duration // Push Gateway URL in format http://domain:port // where JOBNAME can be any string of your choice PushGatewayURL string // Local metrics URL where metrics are fetched from, this could be ommited in the future // if implemented using prometheus common/expfmt instead MetricsURL string // pushgateway job name, defaults to "gin" Job string }
PrometheusPushGateway contains the configuration for pushing to a Prometheus pushgateway (optional)