memory

Documentation

Overview

Package memory tracks the NVIDIA per-GPU memory usage.

Index

• Constants
• func New(ctx context.Context, cfg Config) components.Component
• type Config
  • func ParseConfig(b any, db *sql.DB) (*Config, error)
  • func (cfg Config) Validate() error
• type Output
  • func ParseOutputJSON(data []byte) (*Output, error)
  • func ParseStateMemoryUsage(m map[string]string) (*Output, error)
  • func ParseStatesToOutput(states ...components.State) (*Output, error)
  • func ToOutput(i *nvidia_query.Output) *Output
  • func (o *Output) Evaluate() (string, bool, error)
  • func (o *Output) JSON() ([]byte, error)
  • func (o *Output) States() ([]components.State, error)

Constants

const (
	StateNameMemoryUsage = "memory_usage"

	StateKeyMemoryUsageData           = "data"
	StateKeyMemoryUsageEncoding       = "encoding"
	StateValueMemoryUsageEncodingJSON = "json"
)

const Name = "accelerator-nvidia-memory"

Functions

func New

func New(ctx context.Context, cfg Config) components.Component

Types

type Config

type Config struct {
	Query query_config.Config `json:"query"`
}

func ParseConfig

func ParseConfig(b any, db *sql.DB) (*Config, error)

func (Config) Validate

func (cfg Config) Validate() error

type Output

type Output struct {
	UsagesSMI  []nvidia_query.ParsedMemoryUsage `json:"usages_smi"`
	UsagesNVML []nvidia_query_nvml.Memory       `json:"usages_nvml"`
}

func ParseOutputJSON

func ParseOutputJSON(data []byte) (*Output, error)

func ParseStateMemoryUsage

func ParseStateMemoryUsage(m map[string]string) (*Output, error)

func ParseStatesToOutput

func ParseStatesToOutput(states ...components.State) (*Output, error)

func ToOutput

func ToOutput(i *nvidia_query.Output) *Output

ToOutput converts nvidia_query.Output to Output. It returns an empty non-nil object, if the input or the required field is nil (e.g., i.SMI).

func (*Output) Evaluate

func (o *Output) Evaluate() (string, bool, error)

Returns the output evaluation reason and its healthy-ness.

func (*Output) JSON

func (o *Output) JSON() ([]byte, error)

func (*Output) States

func (o *Output) States() ([]components.State, error)