metricutils

Documentation

Index

• Constants
• Variables
• func CollectProcessMetrics(refresh time.Duration)
• func ReadDiskStats(stats *DiskStats) error
• func StartMetricCollectionAndExport(ctx *cli.Context)
• type DiskStats

Constants

const (
	MetricNamespace            = "klaytn"
	DashboardEnabledFlag       = "dashboard"
	PrometheusExporterFlag     = "prometheus"
	PrometheusExporterPortFlag = "prometheusport"
)

const MetricsEnabledFlag = "metrics"

MetricsEnabledFlag is the CLI flag name to use to enable metrics collections.

Variables

var Enabled = false

Enabled is checked by the constructor functions for all of the standard metrics. If it is true, the metric returned is a stub.

This global kill-switch helps quantify the observer effect and makes for less cluttered pprof profiles.

var (
	EnabledPrometheusExport = false
)

Functions

func CollectProcessMetrics

func CollectProcessMetrics(refresh time.Duration)

CollectProcessMetrics periodically collects various metrics about the running process.

func ReadDiskStats

func ReadDiskStats(stats *DiskStats) error

ReadDiskStats retrieves the disk IO stats belonging to the current process.

func StartMetricCollectionAndExport

func StartMetricCollectionAndExport(ctx *cli.Context)

StartMetricCollectionAndExport starts exporting to prometheus and collects process metrics.

Types

type DiskStats

type DiskStats struct {
	ReadCount  int64 // Number of read operations executed
	ReadBytes  int64 // Total number of bytes read
	WriteCount int64 // Number of write operations executed
	WriteBytes int64 // Total number of byte written
}

DiskStats is the per process disk io stats.