Documentation
¶
Index ¶
- type Config
- type InstanceConfig
- type Module
- func (p *Module) ApplyDefaults()
- func (p *Module) DatasourceInfo() []types.DatasourceInfo
- func (p *Module) Examples() map[string]types.ExampleCategory
- func (p *Module) Init(rawConfig []byte) error
- func (p *Module) InitFromDiscovery(datasources []types.DatasourceInfo) error
- func (p *Module) Name() string
- func (p *Module) PythonAPIDocs() map[string]types.ModuleDoc
- func (p *Module) SandboxEnv() (map[string]string, error)
- func (p *Module) Start(_ context.Context) error
- func (p *Module) Stop(_ context.Context) error
- func (p *Module) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Instances []InstanceConfig `yaml:"instances"`
}
Config holds the Prometheus module configuration.
type InstanceConfig ¶
type InstanceConfig struct {
Name string `yaml:"name" json:"name"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
URL string `yaml:"url,omitempty" json:"url,omitempty"`
}
InstanceConfig holds configuration for a Prometheus instance.
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
Module implements the module.Module interface for Prometheus.
func (*Module) ApplyDefaults ¶
func (p *Module) ApplyDefaults()
ApplyDefaults sets default values before validation.
func (*Module) DatasourceInfo ¶
func (p *Module) DatasourceInfo() []types.DatasourceInfo
DatasourceInfo returns datasource metadata for datasources:// resources.
func (*Module) Examples ¶
func (p *Module) Examples() map[string]types.ExampleCategory
Examples returns query examples for the Prometheus module.
func (*Module) InitFromDiscovery ¶
func (p *Module) InitFromDiscovery(datasources []types.DatasourceInfo) error
InitFromDiscovery initializes the module from discovered datasources.
func (*Module) PythonAPIDocs ¶
PythonAPIDocs returns the Prometheus module documentation.
func (*Module) SandboxEnv ¶
SandboxEnv returns environment variables for the sandbox.
Source Files
Click to show internal directories.
Click to hide internal directories.