Documentation
¶
Overview ¶
Package metrics reports the statistics of the framework.
Index ¶
- Constants
- Variables
- func Counter(name string) *counter
- func IncrCounter(key string, value float64)
- func RegisterMetricsSink(sink Sink)
- func Report(rec Record) (err error)
- func ReportMultiDimensionMetrics(dimensions []*Dimension, metrics []*Metrics) error
- func ReportMultiDimensionMetricsX(name string, dimensions []*Dimension, metrics []*Metrics) error
- func ReportSingleDimensionMetrics(name string, value float64, policy Policy) error
- type Dimension
- type Metrics
- type Policy
- type Record
- type Sink
Constants ¶
const ( PolicyNONE = 0 // Undefined PolicySET = 1 // instantaneous value PolicySUM = 2 // summary PolicyAVG = 3 // average PolicyMAX = 4 // maximum PolicyMIN = 5 // minimum PolicyMID = 6 // median PolicyTimer = 7 // timer )
All available Policy(s).
Variables ¶
var ( ServiceHandleFail = Counter("ServiceHandleFail") ServiceCodecDecodeFail = Counter("ServiceCodecDecodeFail") ServiceCodecEncodeFail = Counter("ServiceCodecEncodeFail") ServiceHandleRPCNameInvalid = Counter("ServiceHandleRpcNameInvalid") ServiceCodecMarshalFail = Counter("ServiceCodecMarshalFail") TCPServerTransportHandleFail = Counter("TcpServerTransportHandleFail") TCPServerTransportWriteFail = Counter("TcpServerTransportWriteFail") SelectNodeFail = Counter("SelectNodeFail") ClientCodecEmpty = Counter("ClientCodecEmpty") ConnectionPoolGetNewConnection = Counter("ConnectionPoolGetNewConnection") ConnectionPoolGetConnectionErr = Counter("ConnectionPoolGetConnectionErr") ConnectionPoolRemoteErr = Counter("ConnectionPoolRemoteErr") ConnectionPoolRemoteEOF = Counter("ConnectionPoolRemoteEOF") ConnectionPoolIdleTimeout = Counter("ConnectionPoolIdleTimeout") ConnectionPoolLifetimeExceed = Counter("ConnectionPoolLifetimeExceed") ConnectionPoolOverLimit = Counter("ConnectionPoolOverLimit") )
Functions ¶
func IncrCounter ¶
IncrCounter increases counter key by value. Counters should accumulate values.
func RegisterMetricsSink ¶
func RegisterMetricsSink(sink Sink)
RegisterMetricsSink registers a Sink.
func ReportMultiDimensionMetrics ¶
ReportMultiDimensionMetrics creates and reports a Record with multiple dimensions and metrics. Deprecated use ReportMultiDimensionMetricsX instead.
func ReportMultiDimensionMetricsX ¶
ReportMultiDimensionMetricsX creates and reports a named Record with multiple dimensions and metrics.
Types ¶
type Metrics ¶
type Metrics struct {
// contains filtered or unexported fields
}
Metrics defines the metric.
func NewMetrics ¶
NewMetrics creates a new Metrics.
type Record ¶
type Record struct {
Name string // the name of the record
// contains filtered or unexported fields
}
Record is the single record.
terminologies:
- dimension name is an attribute of a body, often used to filter body, such as a photo album business model includes region and server room.
- dimension value refines the dimension. For example, the regions of the album business model include Shenzhen, Shanghai, etc., the region is the dimension, and Shenzhen and Shanghai are the dimension values.
- metric is a measurement, used to aggregate and calculate. For example, request count of album business model in ShenZhen Telecom is a metric.
func NewMultiDimensionMetrics ¶
NewMultiDimensionMetrics creates a Record with multiple dimensions and metrics. Deprecated use NewMultiDimensionMetricsX instead.
func NewMultiDimensionMetricsX ¶
NewMultiDimensionMetricsX creates a named Record with multiple dimensions and metrics.
func NewSingleDimensionMetrics ¶
NewSingleDimensionMetrics creates a Record with no dimension and only one metric.
func (*Record) GetDimensions ¶
GetDimensions returns dimensions.
Source Files