quickwit

package

v0.3.0-beta.1 Latest Latest Go to latest Published: Nov 29, 2023 License: AGPL-3.0 Imports: 22 Imported by: 0

Details

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

Repository

github.com/quickwit-oss/quickwit-datasource

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewQuickwitDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)
func ParseToTime(value interface{}, timeOutputFormat string) (time.Time, error)
type BucketAgg
type MetricAgg
type Query
type QuickwitDatasource

Constants ¶

View Source

const (
	Iso8601         string = "iso8601"
	Rfc2822         string = "rfc2822"
	Rfc3339         string = "rfc3339"
	TimestampSecs   string = "unix_timestamp_secs"
	TimestampMillis string = "unix_timestamp_millis"
	TimestampMicros string = "unix_timestamp_micros"
	TimestampNanos  string = "unix_timestamp_nanos"
)

Variables ¶

This section is empty.

Functions ¶

func ParseToTime ¶

func ParseToTime(value interface{}, timeOutputFormat string) (time.Time, error)

Parses a value into Time given a timeOutputFormat. The conversion only works with float64 as this is what we get when parsing a response. TODO: understand why we get a float64?

Types ¶

type BucketAgg ¶

type BucketAgg struct {
	Field    string           `json:"field"`
	ID       string           `json:"id"`
	Settings *simplejson.Json `json:"settings"`
	Type     string           `json:"type"`
}

BucketAgg represents a bucket aggregation of the time series query model of the datasource

type MetricAgg ¶

type MetricAgg struct {
	Field             string            `json:"field"`
	Hide              bool              `json:"hide"`
	ID                string            `json:"id"`
	PipelineAggregate string            `json:"pipelineAgg"`
	PipelineVariables map[string]string `json:"pipelineVariables"`
	Settings          *simplejson.Json  `json:"settings"`
	Meta              *simplejson.Json  `json:"meta"`
	Type              string            `json:"type"`
}

MetricAgg represents a metric aggregation of the time series query model of the datasource

type Query ¶

type Query struct {
	RawQuery      string       `json:"query"`
	BucketAggs    []*BucketAgg `json:"bucketAggs"`
	Metrics       []*MetricAgg `json:"metrics"`
	Alias         string       `json:"alias"`
	Interval      time.Duration
	IntervalMs    int64
	RefID         string
	MaxDataPoints int64
}

Query represents the time series query model of the datasource

type QuickwitDatasource ¶

type QuickwitDatasource struct {
	// contains filtered or unexported fields
}

func (*QuickwitDatasource) CallResource ¶

func (ds *QuickwitDatasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error

func (*QuickwitDatasource) CheckHealth ¶

func (ds *QuickwitDatasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)

CheckHealth handles health checks sent from Grafana to the plugin. The main use case for these health checks is the test button on the datasource configuration page which allows users to verify that a datasource is working as expected.

func (*QuickwitDatasource) Dispose ¶

func (ds *QuickwitDatasource) Dispose()

Dispose here tells plugin SDK that plugin wants to clean up resources when a new instance created. As soon as datasource settings change detected by SDK old datasource instance will be disposed and a new one will be created using NewSampleDatasource factory function.

func (*QuickwitDatasource) QueryData ¶

func (ds *QuickwitDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
client
kinds
dataquery
simplejson

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