Documentation
¶
Overview ¶
Package benchmarkoor integrates the benchmarkoor execution-client benchmarking service. Datasources come from proxy discovery: the proxy holds the benchmarkoor API URL and read-only API key, and the module exposes read operations over indexed benchmark runs, suites, and per-test performance stats.
Index ¶
- type Module
- func (m *Module) ApplyDefaults()
- func (m *Module) DatasourceInfo() []types.DatasourceInfo
- func (m *Module) Examples() map[string]types.ExampleCategory
- func (m *Module) Init(_ []byte) error
- func (m *Module) InitFromDiscovery(datasources []types.DatasourceInfo) error
- func (m *Module) Name() string
- func (m *Module) PythonAPIDocs() map[string]types.ModuleDoc
- func (m *Module) SandboxEnv() (map[string]string, error)
- func (m *Module) Start(_ context.Context) error
- func (m *Module) Stop(_ context.Context) error
- func (m *Module) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
Module implements the module.Module interface for benchmarkoor.
func (*Module) ApplyDefaults ¶
func (m *Module) ApplyDefaults()
ApplyDefaults sets default values before validation.
func (*Module) DatasourceInfo ¶
func (m *Module) DatasourceInfo() []types.DatasourceInfo
DatasourceInfo returns datasource metadata for datasources:// resources.
func (*Module) Examples ¶
func (m *Module) Examples() map[string]types.ExampleCategory
Examples returns query examples for the benchmarkoor module.
func (*Module) Init ¶
Init is a no-op: the module's datasources come from proxy discovery via InitFromDiscovery.
func (*Module) InitFromDiscovery ¶
func (m *Module) InitFromDiscovery(datasources []types.DatasourceInfo) error
InitFromDiscovery initializes the module from discovered datasources. Safe to call repeatedly: subsequent calls replace the datasource list in place so the proxy client's periodic refresh propagates without a restart.
Always writes the filtered list, including when empty — see the comment on the clickhouse module's InitFromDiscovery for the rationale.
func (*Module) PythonAPIDocs ¶
PythonAPIDocs returns the benchmarkoor module documentation.
func (*Module) SandboxEnv ¶
SandboxEnv returns environment variables for the sandbox.
Source Files