plugin

package

v0.54.0-beta.2 Latest Latest Go to latest Published: Jun 19, 2026 License: Apache-2.0 Imports: 3 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/perses/perses

Links

Documentation ¶

Index ¶

Constants
type Kind
- func (k Kind) IsQuery() bool
type ModuleMetadata
type ModuleSpec
- func (m *ModuleSpec) UnmarshalJSON(data []byte) error
- func (m *ModuleSpec) UnmarshalYAML(unmarshal func(any) error) error
type ModuleStatus
type Plugin
- func (p *Plugin) UnmarshalJSON(data []byte) error
- func (p *Plugin) UnmarshalYAML(unmarshal func(any) error) error
type Spec

Constants ¶

View Source

const (
	// Deprecated. Use github.com/perses/spec/go/plugin/plugin.LatestVersion instead
	LatestVersion = "latest"
	// Deprecated. Use github.com/perses/spec/go/plugin/plugin.DefaultRegistry instead
	DefaultRegistry = "perses.dev"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Kind ¶

type Kind string

Deprecated. Use github.com/perses/spec/go/module/module.Kind instead

const (
	KindVariable        Kind = "Variable"
	KindDatasource      Kind = "Datasource"
	KindPanel           Kind = "Panel"
	KindTimeSeriesQuery Kind = "TimeSeriesQuery"
	KindTraceQuery      Kind = "TraceQuery"
	KindProfileQuery    Kind = "ProfileQuery"
	KindLogQuery        Kind = "LogQuery"
	KindQuery           Kind = "Query"
	KindAlertsQuery     Kind = "AlertsQuery"
	KindSilencesQuery   Kind = "SilencesQuery"
	KindExplore         Kind = "Explore"
	KindAnnotation      Kind = "Annotation"
)

func (Kind) IsQuery ¶ added in v0.52.0

func (k Kind) IsQuery() bool

type ModuleMetadata ¶

type ModuleMetadata struct {
	Name     string `json:"name" yaml:"name"`
	Version  string `json:"version" yaml:"version"`
	Registry string `json:"registry" yaml:"registry"`
}

Deprecated. Use github.com/perses/spec/go/module/module.Metadata instead

type ModuleSpec ¶

type ModuleSpec struct {
	SchemasPath string   `json:"schemasPath" yaml:"schemasPath"`
	ModuleName  string   `json:"moduleName,omitempty" yaml:"moduleName,omitempty"`
	ModuleOrg   string   `json:"moduleOrg,omitempty" yaml:"moduleOrg,omitempty"`
	Plugins     []Plugin `json:"plugins" yaml:"plugins"`
}

Deprecated. Use github.com/perses/spec/go/module/module.Spec instead

func (*ModuleSpec) UnmarshalJSON ¶

func (m *ModuleSpec) UnmarshalJSON(data []byte) error

func (*ModuleSpec) UnmarshalYAML ¶

func (m *ModuleSpec) UnmarshalYAML(unmarshal func(any) error) error

type ModuleStatus ¶

type ModuleStatus struct {
	IsLoaded bool   `json:"isLoaded" yaml:"isLoaded"`
	InDev    bool   `json:"inDev" yaml:"inDev"`
	Error    string `json:"error,omitempty" yaml:"error,omitempty"`
}

Deprecated. Use github.com/perses/spec/go/module/module.Status instead

type Plugin ¶

type Plugin struct {
	Kind Kind `json:"kind" yaml:"kind"`
	Spec Spec `json:"spec" yaml:"spec"`
}

Deprecated. Use github.com/perses/spec/go/module/module.Plugin instead

func (*Plugin) UnmarshalJSON ¶

func (p *Plugin) UnmarshalJSON(data []byte) error

func (*Plugin) UnmarshalYAML ¶

func (p *Plugin) UnmarshalYAML(unmarshal func(any) error) error

type Spec ¶

type Spec struct {
	Display *common.Display `json:"display" yaml:"display"`
	Name    string          `json:"name" yaml:"name"`
}

Deprecated. Use github.com/perses/spec/go/module/module.PluginSpec instead

Source Files ¶

View all Source files

plugin.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL