processing

Documentation

Overview

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture This file is from https://github.com/zsais/go-gin-prometheus/blob/master/middleware.go It has been slightly modified in order to fix errors messages like: - request_duration_seconds could not be registered in Prometheus - response_size_bytes could not be registered in Prometheus - duplicate metrics collector registration attempted

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Package processing provide all requirements to process change data capture

Index

• func NewMetric(m *Metric, subsystem string) prometheus.Collector
• type Configuration
• type Metric
• type Prometheus
  • func NewPrometheus(subsystem string, customMetricsList ...[]*Metric) *Prometheus
  • func (p *Prometheus) HandlerFunc() gin.HandlerFunc
  • func (p *Prometheus) SetListenAddress(address string)
  • func (p *Prometheus) SetListenAddressWithRouter(listenAddress string, r *gin.Engine)
  • func (p *Prometheus) SetMetricsPath(e *gin.Engine)
  • func (p *Prometheus) SetMetricsPathWithAuth(e *gin.Engine, accounts gin.Accounts)
  • 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
• type RequestCounterURLLabelMappingFn
• type Validate
  • func (c *Validate) ParseAndValidateConfig()
  • func (c *Validate) RunAPI()
  • func (c *Validate) RunPrerequisitesOnly()

Functions

func NewMetric

func NewMetric(m *Metric, subsystem string) prometheus.Collector

NewMetric associates prometheus.Collector based on Metric.Type

Types

type Configuration

type Configuration struct {
	// Config dir containing files to be parsed
	ConfigDir string `json:"configDir" yaml:"configDir"`

	// Init will only perform prerequisites related to elasticsearch / kafka / cockroachdb
	Init bool
	// Logger expose zerolog so it can be override
	Logger *zerolog.Logger
	// contains filtered or unexported fields
}

Configuration reference all requirements relation to the file config

type Metric

type Metric struct {
	MetricCollector prometheus.Collector
	ID              string
	Name            string
	Description     string
	Type            string
	Args            []string
}

Metric is a definition for the name, description, type, ID, and prometheus.Collector type (i.e. CounterVec, Summary, etc) of each metric

type Prometheus

type Prometheus struct {
	Ppg PrometheusPushGateway

	MetricsList []*Metric
	MetricsPath string

	ReqCntURLLabelMappingFn RequestCounterURLLabelMappingFn

	// gin.Context string to use as a prometheus URL label
	URLLabelFromContext string

	// Logger expose zerolog so it can be override
	Logger *zerolog.Logger
	// contains filtered or unexported fields
}

Prometheus contains the metrics gathered by the instance and its path

func NewPrometheus

func NewPrometheus(subsystem string, customMetricsList ...[]*Metric) *Prometheus

NewPrometheus generates a new set of metrics with a certain subsystem name

func (*Prometheus) HandlerFunc

func (p *Prometheus) HandlerFunc() gin.HandlerFunc

HandlerFunc defines handler function for middleware

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) SetListenAddressWithRouter

func (p *Prometheus) SetListenAddressWithRouter(listenAddress string, r *gin.Engine)

SetListenAddressWithRouter for using a separate router to expose metrics. (this keeps things like GET /metrics out of your content's access log).

func (*Prometheus) SetMetricsPath

func (p *Prometheus) SetMetricsPath(e *gin.Engine)

SetMetricsPath set metrics paths

func (*Prometheus) SetMetricsPathWithAuth

func (p *Prometheus) SetMetricsPathWithAuth(e *gin.Engine, accounts gin.Accounts)

SetMetricsPathWithAuth set metrics paths with authentication

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)

SetPushGatewayJob 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)

type RequestCounterURLLabelMappingFn

type RequestCounterURLLabelMappingFn func(c *gin.Context) string

RequestCounterURLLabelMappingFn is a function which can be supplied to the middleware to control the cardinality of the request counter's "url" label, which might be required in some contexts. For instance, if for a "/customer/:name" route you don't want to generate a time series for every possible customer name, you could use this function:

func(c *gin.Context) string {
	url := c.Request.URL.Path
	for _, p := range c.Params {
		if p.Key == "name" {
			url = strings.Replace(url, p.Value, ":name", 1)
			break
		}
	}
	return url
}

which would map "/customer/alice" and "/customer/bob" to their template "/customer/:name".

type Validate

type Validate Configuration

func (*Validate) ParseAndValidateConfig

func (c *Validate) ParseAndValidateConfig()

ParseAndValidateConfig will validate the files configurations

func (*Validate) RunAPI

func (c *Validate) RunAPI()

RunAPI will start the api server

func (*Validate) RunPrerequisitesOnly

func (c *Validate) RunPrerequisitesOnly()

RunPrerequisitesOnly permit to run all functions related to Kafka, elasticsearch and cockroach feeds