Documentation
¶
Overview ¶
Package debug implements a plugin that exposes an HTTP server for debugging purposes.
Index ¶
- type Config
- type Plugin
- func (p *Plugin) Close(ctx context.Context, req *emptypb.Empty) (*emptypb.Empty, error)
- func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)
- func (p *Plugin) GetInfo(context.Context, *emptypb.Empty) (*v1.PluginInfo, error)
- func (p *Plugin) InjectQuerier(srv v1.StorageQuerierPlugin_InjectQuerierServer) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶ added in v0.3.1
type Config struct { // ListenAddress is the address to listen on. Defaults to "localhost:6060". ListenAddress string `mapstructure:"listen-address" koanf:"listen-address"` // PathPrefix is the path prefix to use for the debug server. // Defaults to "/debug". PathPrefix string `mapstructure:"path-prefix" koanf:"path-prefix"` // DisablePProf disables pprof. DisablePProf bool `mapstructure:"disable-pprof" koanf:"disable-pprof"` // PProfProfiles is the list of profiles to enable for pprof. // An empty list enables all profiles. Each will be available at // /<path-prefix>/pprof/<profile>. PprofProfiles string `mapstructure:"pprof-profiles" koanf:"pprof-profiles"` // EnableDBQuerier enables the database querier. EnableDBQuerier bool `mapstructure:"enable-db-querier" koanf:"enable-db-querier"` }
Config are the options for the debug plugin.
func NewDefaultOptions ¶
func NewDefaultOptions() Config
NewDefaultOptions returns the default options for the debug plugin.
func (*Config) AsMapStructure ¶ added in v0.3.1
func (*Config) DefaultOptions ¶ added in v0.3.1
DefaultOptions returns the default options for the plugin.
func (*Config) SetMapStructure ¶ added in v0.8.0
type Plugin ¶
type Plugin struct { v1.UnimplementedPluginServer v1.UnimplementedStorageQuerierPluginServer // contains filtered or unexported fields }
Plugin is the debug plugin.
func (*Plugin) Configure ¶
func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)
Configure configures the plugin.
func (*Plugin) InjectQuerier ¶
func (p *Plugin) InjectQuerier(srv v1.StorageQuerierPlugin_InjectQuerierServer) error
InjectQuerier injects the querier.
Click to show internal directories.
Click to hide internal directories.