viewer

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 16, 2024 License: MIT Imports: 16 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	DefaultTemplate = `` /* 923-byte string literal not displayed */

	DefaultMaxPoints  = 30
	DefaultTimeFormat = "15:04:05"
	DefaultInterval   = 2000
	DefaultAddr       = "localhost:18066"
	DefaultTheme      = ThemeMacarons
)
View Source 
const (
	// VCStack is the name of StackViewer
	VCStack = "stack"
)
View Source 
const (
	// VGCCPUFraction is the name of GCCPUFractionViewer
	VGCCPUFraction = "gccpufraction"
)
View Source 
const (
	// VGCNum is the name of GCNumViewer
	VGCNum = "gcnum"
)
View Source 
const (
	// VGCSzie is the name of GCSizeViewer
	VGCSize = "gcsize"
)
View Source 
const (
	// VGoroutine is the name of GoroutinesViewer
	VGoroutine = "goroutine"
)
View Source 
const (
	// VHeap is the name of HeapViewer
	VHeap = "heap"
)

Variables

View Source 
var DefaultCfg = &config{
	Interval:   DefaultInterval,
	MaxPoints:  DefaultMaxPoints,
	Template:   DefaultTemplate,
	ListenAddr: DefaultAddr,
	LinkAddr:   DefaultAddr,
	TimeFormat: DefaultTimeFormat,
	Theme:      DefaultTheme,
}

Functions

func Addr 

func Addr() string

Addr returns the default server listening address

func FixedPrecision 

func FixedPrecision(n float64, p int) float64

FixedPrecision returns the fixed precision float64

func Interval 

func Interval() int

Interval returns the default collecting interval of ViewManager

func LinkAddr 

func LinkAddr() string

LinkAddr returns the default html link address

func NewBasicView 

func NewBasicView(route string) *charts.Line

NewBasicView returns a basic line-chart with default configurations

func SetConfiguration 

func SetConfiguration(opts ...Option)

Types

type GCCPUFractionViewer 

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

GCCPUFractionViewer collects the GC-CPU fraction metric via `runtime.ReadMemStats()`

func (*GCCPUFractionViewer) Name 

func (vr *GCCPUFractionViewer) Name() string

func (*GCCPUFractionViewer) Serve 

func (vr *GCCPUFractionViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*GCCPUFractionViewer) SetStatsMgr 

func (vr *GCCPUFractionViewer) SetStatsMgr(smgr *StatsMgr)

func (*GCCPUFractionViewer) View 

func (vr *GCCPUFractionViewer) View() *charts.Line

type GCNumViewer 

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

GCNumViewer collects the GC number metric via `runtime.ReadMemStats()`

func (*GCNumViewer) Name 

func (vr *GCNumViewer) Name() string

func (*GCNumViewer) Serve 

func (vr *GCNumViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*GCNumViewer) SetStatsMgr 

func (vr *GCNumViewer) SetStatsMgr(smgr *StatsMgr)

func (*GCNumViewer) View 

func (vr *GCNumViewer) View() *charts.Line

type GCSizeViewer 

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

GCSizeViewer collects the GC size metric via `runtime.ReadMemStats()`

func (*GCSizeViewer) Name 

func (vr *GCSizeViewer) Name() string

func (*GCSizeViewer) Serve 

func (vr *GCSizeViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*GCSizeViewer) SetStatsMgr 

func (vr *GCSizeViewer) SetStatsMgr(smgr *StatsMgr)

func (*GCSizeViewer) View 

func (vr *GCSizeViewer) View() *charts.Line

type GoroutinesViewer 

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

GoroutinesViewer collects the goroutine number metric via `runtime.NumGoroutine()`

func (*GoroutinesViewer) Name 

func (vr *GoroutinesViewer) Name() string

func (*GoroutinesViewer) Serve 

func (vr *GoroutinesViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*GoroutinesViewer) SetStatsMgr 

func (vr *GoroutinesViewer) SetStatsMgr(smgr *StatsMgr)

func (*GoroutinesViewer) View 

func (vr *GoroutinesViewer) View() *charts.Line

type HeapViewer 

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

HeapViewer collects the heap-stats metrics via `runtime.ReadMemStats()`

func (*HeapViewer) Name 

func (vr *HeapViewer) Name() string

func (*HeapViewer) Serve 

func (vr *HeapViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*HeapViewer) SetStatsMgr 

func (vr *HeapViewer) SetStatsMgr(smgr *StatsMgr)

func (*HeapViewer) View 

func (vr *HeapViewer) View() *charts.Line

type Metrics 

type Metrics struct {
	Values []float64 `json:"values"`
	Time   string    `json:"time"`
}

Metrics

type Option 

type Option func(c *config)

func WithAddr 

func WithAddr(addr string) Option

WithAddr sets the listening address and link address

func WithInterval 

func WithInterval(interval int) Option

WithInterval sets the interval of collecting and pulling metrics

func WithLinkAddr 

func WithLinkAddr(addr string) Option

WithLinkAddr sets the html link address

func WithMaxPoints 

func WithMaxPoints(n int) Option

WithMaxPoints sets the maximum points of each chart series

func WithTemplate 

func WithTemplate(t string) Option

WithTemplate sets the rendered template which fetching stats from the server and handling the metrics data

func WithTheme 

func WithTheme(theme Theme) Option

WithTheme sets the theme of the charts

func WithTimeFormat 

func WithTimeFormat(s string) Option

WithTimeFormat sets the time format for the line-chart Y-axis label

type StackViewer 

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

StackViewer collects the stack-stats metrics via `runtime.ReadMemStats()`

func (*StackViewer) Name 

func (vr *StackViewer) Name() string

func (*StackViewer) Serve 

func (vr *StackViewer) Serve(w http.ResponseWriter, _ *http.Request)

func (*StackViewer) SetStatsMgr 

func (vr *StackViewer) SetStatsMgr(smgr *StatsMgr)

func (*StackViewer) View 

func (vr *StackViewer) View() *charts.Line

type StatsEntity 

type StatsEntity struct {
	Stats *runtime.MemStats
	T     string
}

StatsEntity is the entity of the metrics with timestamp.

func MemStats 

func MemStats() *StatsEntity

MemStats returns the runtime.MemStats and T.

type StatsMgr 

type StatsMgr struct {
	Ctx    context.Context
	Cancel context.CancelFunc
	// contains filtered or unexported fields
}

func NewStatsMgr 

func NewStatsMgr(ctx context.Context) *StatsMgr

func (*StatsMgr) Tick 

func (s *StatsMgr) Tick()

type Theme 

type Theme string
const (
	ThemeWesteros Theme = types.ThemeWesteros
	ThemeMacarons Theme = types.ThemeMacarons
)

type Viewer 

type Viewer interface {
	Name() string
	View() *charts.Line
	Serve(w http.ResponseWriter, _ *http.Request)
	SetStatsMgr(smgr *StatsMgr)
}

Viewer is the abstraction of a Graph which in charge of collecting metrics from somewhere

func NewGCCPUFractionViewer 

func NewGCCPUFractionViewer() Viewer

NewGCCPUFractionViewer returns the GCCPUFractionViewer instance Series: Fraction

func NewGCCPUFractionViewerWithNumCPU 

func NewGCCPUFractionViewerWithNumCPU() Viewer

NewGCCPUFractionViewer returns the GCCPUFractionViewer instance Series: Fraction

func NewGCNumViewer 

func NewGCNumViewer() Viewer

NewGCNumViewer returns the GCNumViewer instance Series: GcNum

func NewGCSizeViewer 

func NewGCSizeViewer() Viewer

NewGCSizeViewer returns the GCSizeViewer instance Series: GCSys / NextGC

func NewGoroutinesViewer 

func NewGoroutinesViewer() Viewer

NewGoroutinesViewer returns the GoroutinesViewer instance Series: Goroutines

func NewHeapViewer 

func NewHeapViewer() Viewer

NewHeapViewer returns the HeapViewer instance Series: Alloc / Inuse / Sys / Idle

func NewStackViewer 

func NewStackViewer() Viewer

NewStackViewer returns the StackViewer instance Series: StackSys / StackInuse / MSpanSys / MSpanInuse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.