quickwit

Documentation

Index

• Constants
• func DecodeTimestampFieldFromIndexConfig(body []byte) (string, string, error)
• func DecodeTimestampFieldFromIndexConfigs(body []byte) (string, string, error)
• func FindTimeStampFormat(timestampFieldName string, parentName *string, fieldMappings []FieldMappings) (string, bool)
• func GetTimestampFieldFromIndex(index string, qwickwitUrl string, cli *http.Client) (string, string, error)
• func GetTimestampFieldFromIndexPattern(indexPattern string, qwickwitUrl string, cli *http.Client) (string, string, error)
• func GetTimestampFieldInfos(index string, qwickwitUrl string, cli *http.Client) (string, string, error)
• func NewErrorCreationPayload(statusCode int, message string) error
• func NewQuickwitDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)
• type BucketAgg
• type FieldMappings
• type MetricAgg
• type Query
• type QuickwitCreationErrorPayload
• type QuickwitDatasource
  • func (ds *QuickwitDatasource) CallResource(ctx context.Context, req *backend.CallResourceRequest, ...) error
  • func (ds *QuickwitDatasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)
  • func (ds *QuickwitDatasource) Dispose()
  • func (ds *QuickwitDatasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)
• type QuickwitIndexMetadata

Constants

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"
)

Functions

func DecodeTimestampFieldFromIndexConfig

func DecodeTimestampFieldFromIndexConfig(body []byte) (string, string, error)

func DecodeTimestampFieldFromIndexConfigs

func DecodeTimestampFieldFromIndexConfigs(body []byte) (string, string, error)

func FindTimeStampFormat

func FindTimeStampFormat(timestampFieldName string, parentName *string, fieldMappings []FieldMappings) (string, bool)

func GetTimestampFieldFromIndex

func GetTimestampFieldFromIndex(index string, qwickwitUrl string, cli *http.Client) (string, string, error)

func GetTimestampFieldFromIndexPattern

func GetTimestampFieldFromIndexPattern(indexPattern string, qwickwitUrl string, cli *http.Client) (string, string, error)

func GetTimestampFieldInfos

func GetTimestampFieldInfos(index string, qwickwitUrl string, cli *http.Client) (string, string, error)

TODO: refactor either by using a timestamp alias suppprted by quickwit or by only using the `GetTimestampFieldFromIndexPattern` once the endpoint /indexes?index_id_pattern= is supported, which is after the next quickwit release > 0.7.1

func NewErrorCreationPayload

func NewErrorCreationPayload(statusCode int, message string) error

func NewQuickwitDatasource

func NewQuickwitDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)

Creates a Quickwit datasource.

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 FieldMappings

type FieldMappings struct {
	Name          string          `json:"name"`
	Type          string          `json:"type"`
	OutputFormat  *string         `json:"output_format,omitempty"`
	FieldMappings []FieldMappings `json:"field_mappings,omitempty"`
}

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 QuickwitCreationErrorPayload

type QuickwitCreationErrorPayload struct {
	Message    string `json:"message"`
	StatusCode int    `json:"status"`
}

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)

type QuickwitIndexMetadata

type QuickwitIndexMetadata struct {
	IndexConfig struct {
		DocMapping struct {
			TimestampField string          `json:"timestamp_field"`
			FieldMappings  []FieldMappings `json:"field_mappings"`
		} `json:"doc_mapping"`
	} `json:"index_config"`
}