metrics

Documentation

Overview

Package metrics provides access to metrics generated by the wavepipe media server.

Index

• func AddRXBytes(count int64)
• func AddTXBytes(count int64)
• func RXBytes() int64
• func TXBytes() int64
• type DatabaseMetrics
  • func GetDatabaseMetrics() (*DatabaseMetrics, error)
• type Metrics
• type NetworkMetrics

Functions

func AddRXBytes

func AddRXBytes(count int64)

AddRXBytes atomically increments the rxBytes counter by the amount specified

func AddTXBytes

func AddTXBytes(count int64)

AddTXBytes atomically increments the txBytes counter by the amount specified

func RXBytes

func RXBytes() int64

RXBytes returns the total number of bytes received over the network

func TXBytes

func TXBytes() int64

TXBytes returns the total number of bytes transmitted over the network

Types

type DatabaseMetrics

type DatabaseMetrics struct {
	Updated int64 `json:"updated"`

	Artists int64 `json:"artists"`
	Albums  int64 `json:"albums"`
	Songs   int64 `json:"songs"`
	Folders int64 `json:"folders"`
	Art     int64 `json:"art"`
}

DatabaseMetrics represents metrics regarding the wavepipe database, including total numbers of specific objects, and the time when the database was last updated

func GetDatabaseMetrics

func GetDatabaseMetrics() (*DatabaseMetrics, error)

GetDatabaseMetrics returns a variety of metrics about the wavepipe database, including total numbers of specific objects, and the time when the database was last updated

type Metrics

type Metrics struct {
	Database *DatabaseMetrics `json:"database"`
	Network  *NetworkMetrics  `json:"network"`
}

Metrics represents a variety of metrics about the current wavepipe instance, and contains several nested structs which contain more specific metrics

type NetworkMetrics

type NetworkMetrics struct {
	RXBytes int64 `json:"rxBytes"`
	TXBytes int64 `json:"txBytes"`
}

NetworkMetrics represents metrics regarding wavepipe network traffic, including total traffic received and transmitted in bytes