metrics

Documentation

Overview

Package metrics provides utilities for generating metrics-related collateral for a binary.

Index

• type Exported
• type OpenCensusRegistry
  • func NewOpenCensusRegistry() *OpenCensusRegistry
  • func (r *OpenCensusRegistry) ExportView(d *view.Data)
  • func (r *OpenCensusRegistry) ExportedMetrics() []Exported

Types

type Exported

type Exported struct {
	Name        string
	Type        string
	Description string
}

Exported contains the name, type, and description of an exported metric.

type OpenCensusRegistry

type OpenCensusRegistry struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

OpenCensusRegistry should only be used to collected exported metrics for the offline generation of collateral. It is not suitable for production usage.

func NewOpenCensusRegistry

func NewOpenCensusRegistry() *OpenCensusRegistry

NewOpenCensusRegistry collects a list of exported metrics. As part of the setup, it configures the OpenCensus mechanisms for rapid reporting (1ms) and sleeps for double that period (2ms) to ensure an export happens before generation.

func (*OpenCensusRegistry) ExportView

func (r *OpenCensusRegistry) ExportView(d *view.Data)

ExportView implements view.Exporter

func (*OpenCensusRegistry) ExportedMetrics

func (r *OpenCensusRegistry) ExportedMetrics() []Exported