metrics

Documentation

Index

• Constants
• Variables
• func DisableLogging()
• func EnableLogging()
• func LogMetricsNow()
• func SetLoggingDuration(duration time.Duration) error
• type Metric
  • func RegisterMetric(groupName, metricName string) *Metric
  • func (m *Metric) Add(delta int64) int64
  • func (m *Metric) Load() int64
  • func (m *Metric) Name() string
  • func (m *Metric) Store(val int64)
• type MetricGroup
  • func GetMetricGroupByName(groupName string) *MetricGroup
  • func (g *MetricGroup) DisableLogging()
  • func (g *MetricGroup) EnableLogging()
  • func (g *MetricGroup) IsLoggingEnabled() bool
  • func (g *MetricGroup) NewLogFields() log.Fields
  • func (g *MetricGroup) NewLogMsg() string
• type MetricGroupList
  • func (l MetricGroupList) Append(group *MetricGroup) MetricGroupList
  • func (l MetricGroupList) Len() int
  • func (l MetricGroupList) Less(i, j int) bool
  • func (l MetricGroupList) Swap(i, j int)

Constants

const (
	// MetricGroup name format for each user.
	UserMetricGroupFormat = "user - %s"

	UserMetricInBytes  = "InBytes"
	UserMetricOutBytes = "OutBytes"
)

Variables

var (
	// Max number of connections ever reached.
	MaxConn = RegisterMetric("connections", "MaxConn")

	// Accumulated active open connections.
	ActiveOpens = RegisterMetric("connections", "ActiveOpens")

	// Accumulated passive open connections.
	PassiveOpens = RegisterMetric("connections", "PassiveOpens")

	// Current number of established connections.
	CurrEstablished = RegisterMetric("connections", "CurrEstablished")

	// Number of bytes receive from proxy connections.
	InBytes = RegisterMetric("traffic", "InBytes")

	// Number of bytes send to proxy connections.
	OutBytes = RegisterMetric("traffic", "OutBytes")

	// Number of padding bytes send to proxy connections.
	OutPaddingBytes = RegisterMetric("traffic", "OutPaddingBytes")
)

Functions

func DisableLogging

func DisableLogging()

Disable metrics logging.

func EnableLogging

func EnableLogging()

Enable metrics logging with the given time duration.

func LogMetricsNow

func LogMetricsNow()

LogMetricsNow writes the current metrics to log. This function can be called when (periodic) logging is disabled.

func SetLoggingDuration

func SetLoggingDuration(duration time.Duration) error

Set the metrics logging time duration.

Types

type Metric

type Metric struct {
	// contains filtered or unexported fields
}

Metric holds a named int64 value. int64 is the only supported metric value type.

func RegisterMetric

func RegisterMetric(groupName, metricName string) *Metric

RegisterMetric registers a new metric. The caller should not take the ownership of the returned pointer. If the same metric is registered multiple times, the pointer to the first object is returned.

func (*Metric) Add

func (m *Metric) Add(delta int64) int64

Add increase / decrease the metric value.

func (*Metric) Load

func (m *Metric) Load() int64

Load returns the current metric value.

func (*Metric) Name

func (m *Metric) Name() string

Name returns the name of metric.

func (*Metric) Store

func (m *Metric) Store(val int64)

Store saves a new metric value.

type MetricGroup

type MetricGroup struct {
	// contains filtered or unexported fields
}

MetricGroup holds a list of metric under the same group.

func GetMetricGroupByName

func GetMetricGroupByName(groupName string) *MetricGroup

GetMetricGroupByName returns the MetricGroup by name. It returns nil if the MetricGroup is not found.

func (*MetricGroup) DisableLogging

func (g *MetricGroup) DisableLogging()

DisableLogging disables logging of this MetricGroup.

func (*MetricGroup) EnableLogging

func (g *MetricGroup) EnableLogging()

EnableLogging enables logging of this MetricGroup.

func (*MetricGroup) IsLoggingEnabled

func (g *MetricGroup) IsLoggingEnabled() bool

IsLoggingEnabled returns if logging is enabled in this MetricGroup.

func (*MetricGroup) NewLogFields

func (g *MetricGroup) NewLogFields() log.Fields

NewLogFields creates log fields from the MetricGroup.

func (*MetricGroup) NewLogMsg

func (g *MetricGroup) NewLogMsg() string

NewLogMsg creates a base log message without fields from the MetricGroup.

type MetricGroupList

type MetricGroupList []*MetricGroup

MetricGroupList is a list of MetricGroup.

func (MetricGroupList) Append

func (l MetricGroupList) Append(group *MetricGroup) MetricGroupList

Append adds a new MetricGroup to the end of list.

func (MetricGroupList) Len

func (l MetricGroupList) Len() int

Len implements sort.Interface.

func (MetricGroupList) Less

func (l MetricGroupList) Less(i, j int) bool

Less implements sort.Interface.

func (MetricGroupList) Swap

func (l MetricGroupList) Swap(i, j int)

Swap implements sort.Interface.