catalog

Documentation

Index

• Constants
• func DefaultHardwareTools() []string
• func DefaultWorkloads(diskPath string, includeExtensions bool, filter *regexp.Regexp) []bench.Workload
• func HardwareToolIDs() []string
• func StandardizeHardwareTools(raw []string) []string
• type Definition
  • func DefaultDefinitions(includeExtensions bool) []Definition
  • func DefinitionsForEngine(engine, diskPath string, iperfHosts []string) []Definition
  • func DefinitionsForScope(engine, scope, diskPath string, iperfHosts []string) []Definition
  • func DefinitionsForScopeWithHardwareTools(engine, scope, diskPath string, iperfHosts []string, hardwareTools []string) []Definition
  • func ExternalDefinitions(diskPath string, iperfHosts []string) []Definition
  • func ExternalHardwareDefinitions(diskPath string) []Definition
  • func ExternalHardwareDefinitionsForTools(diskPath string, hardwareTools []string) []Definition
  • func NativeDefinitions(diskPath string) []Definition
  • func NativeHardwareDefinitions(diskPath string) []Definition
  • func NetworkDefinitions(iperfHosts []string) []Definition
  • func NetworkDefinitionsWithManifest(iperfHosts []string, manifest nodecatalog.Manifest, ipFamily string) []Definition
• type HardwareToolSpec
  • func HardwareTools() []HardwareToolSpec

Constants

const (
	ScopeAll      = "all"
	ScopeHardware = "hardware"
	ScopeNetwork  = "network"
)

const (
	HardwareToolSysbench  = "sysbench"
	HardwareToolOpenSSL   = "openssl"
	HardwareToolFio       = "fio"
	HardwareToolDD        = "dd"
	HardwareToolStream    = "stream"
	HardwareToolMBW       = "mbw"
	HardwareToolGeekbench = "geekbench"
	HardwareToolWinSAT    = "winsat"
)

Functions

func DefaultHardwareTools

func DefaultHardwareTools() []string

DefaultHardwareTools returns the default hardware tools. Geekbench/WinSAT and auxiliary dd/STREAM/mbw probes are opt-in.

func DefaultWorkloads

func DefaultWorkloads(diskPath string, includeExtensions bool, filter *regexp.Regexp) []bench.Workload

DefaultWorkloads instantiates the default external-tool workload registry.

func HardwareToolIDs

func HardwareToolIDs() []string

HardwareToolIDs returns selectable external hardware tool IDs in display order.

func StandardizeHardwareTools

func StandardizeHardwareTools(raw []string) []string

StandardizeHardwareTools normalizes aliases, removes duplicates, and returns tools in stable display order. The special value "all" enables every adapter.

Types

type Definition

type Definition struct {
	Name        string
	Category    string
	Description string
	Factory     func(string) bench.Workload
}

Definition describes a workload without instantiating its heavy data payloads.

func DefaultDefinitions

func DefaultDefinitions(includeExtensions bool) []Definition

DefaultDefinitions returns the default external-tool catalog (for list command).

func DefinitionsForEngine

func DefinitionsForEngine(engine, diskPath string, iperfHosts []string) []Definition

DefinitionsForEngine returns workloads based on the engine selection.

func DefinitionsForScope

func DefinitionsForScope(engine, scope, diskPath string, iperfHosts []string) []Definition

DefinitionsForScope returns workloads based on engine and high-level scope.

Hardware measurements are external-tool based. Legacy engine values such as "native" and "full" are accepted for API compatibility, but they no longer register in-process CPU/memory/disk benchmark workloads.

func DefinitionsForScopeWithHardwareTools

func DefinitionsForScopeWithHardwareTools(engine, scope, diskPath string, iperfHosts []string, hardwareTools []string) []Definition

DefinitionsForScopeWithHardwareTools returns workloads for a scope using the selected external hardware tools. Empty hardwareTools selects the default set.

func ExternalDefinitions

func ExternalDefinitions(diskPath string, iperfHosts []string) []Definition

ExternalDefinitions returns workloads that wrap external tools plus network diagnostics.

func ExternalHardwareDefinitions

func ExternalHardwareDefinitions(diskPath string) []Definition

ExternalHardwareDefinitions returns hardware workloads that wrap external benchmark tools. Missing tools are reported by the workload itself; this registry intentionally does not fall back to in-process benchmark code.

func ExternalHardwareDefinitionsForTools

func ExternalHardwareDefinitionsForTools(diskPath string, hardwareTools []string) []Definition

ExternalHardwareDefinitionsForTools returns hardware workloads that wrap the selected external tools. Missing tools are reported by workload execution.

func NativeDefinitions

func NativeDefinitions(diskPath string) []Definition

NativeDefinitions is retained for API compatibility.

Deprecated: hardware benchmark workloads are external-tool based; this function returns the same external definitions as DefaultDefinitions.

func NativeHardwareDefinitions

func NativeHardwareDefinitions(diskPath string) []Definition

NativeHardwareDefinitions is retained for API compatibility.

Deprecated: hardware benchmark workloads are external-tool based; this function returns ExternalHardwareDefinitions.

func NetworkDefinitions

func NetworkDefinitions(iperfHosts []string) []Definition

NetworkDefinitions returns network diagnostics and speed tests.

func NetworkDefinitionsWithManifest

func NetworkDefinitionsWithManifest(iperfHosts []string, manifest nodecatalog.Manifest, ipFamily string) []Definition

NetworkDefinitionsWithManifest returns network workloads pinned to one validated catalog snapshot. No workload falls back to embedded nodes.

type HardwareToolSpec

type HardwareToolSpec struct {
	ID          string
	Name        string
	Description string
	Default     bool
}

HardwareToolSpec describes a selectable external hardware benchmark tool.

func HardwareTools

func HardwareTools() []HardwareToolSpec

HardwareTools returns selectable external hardware tool metadata in display order.