stat

README

stat

Statistics on system and process cpu and memory information, alarm notification support.

Example of use

    import "github.com/18721889353/sunshine/pkg/stat"

    l, _ := zap.NewDevelopment()
    stat.Init(
        stat.WithLog(l),
        stat.WithPrintInterval(time.Minute),
        stat.WithEnableAlarm(stat.WithCPUThreshold(0.9), stat.WithMemoryThreshold(0.85)), // invalid if it is windows
        stat.WithPrintField(logger.String("service_name", cfg.App.Name), logger.String("host", cfg.App.Host)), // add custom fields to log
		)

Documentation

Overview

Package stat provides for counting system and process cpu and memory information, alarm notification support.

Index

• func Init(opts ...Option)
• type AlarmOption
  • func WithCPUThreshold(threshold float64) AlarmOption
  • func WithMemoryThreshold(threshold float64) AlarmOption
• type Option
  • func WithAlarm(opts ...AlarmOption) Option
  • func WithLog(l *zap.Logger) Option
  • func WithPrintField(fields ...zap.Field) Option
  • func WithPrintInterval(d time.Duration) Option

Functions

func Init

func Init(opts ...Option)

Init initialize statistical information

Types

type AlarmOption

type AlarmOption func(*alarmOptions)

AlarmOption set the alarm options field.

func WithCPUThreshold

func WithCPUThreshold(threshold float64) AlarmOption

WithCPUThreshold set cpu threshold, range 0 to 1

func WithMemoryThreshold

func WithMemoryThreshold(threshold float64) AlarmOption

WithMemoryThreshold set memory threshold, range 0 to 1

type Option

type Option func(*options)

Option set the stat options field.

func WithAlarm

func WithAlarm(opts ...AlarmOption) Option

WithAlarm enable alarm and notify, except windows

func WithLog

func WithLog(l *zap.Logger) Option

WithLog set zapLog

func WithPrintField

func WithPrintField(fields ...zap.Field) Option

WithPrintField set print field

func WithPrintInterval

func WithPrintInterval(d time.Duration) Option

WithPrintInterval set print interval