Documentation
¶
Index ¶
- func DecodeTimestampFieldFromIndexConfig(body []byte) (string, error)
- func DecodeTimestampFieldFromIndexConfigs(body []byte) (string, error)
- func GetTimestampField(index string, qwickwitUrl string, cli *http.Client) (string, error)
- func GetTimestampFieldFromIndex(index string, qwickwitUrl string, cli *http.Client) (string, error)
- func GetTimestampFieldFromIndexPattern(indexPattern string, qwickwitUrl string, cli *http.Client) (string, error)
- func NewErrorCreationPayload(statusCode int, message string) error
- func NewQuickwitDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)
- func ParseToTime(value interface{}) (time.Time, 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 ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeTimestampFieldFromIndexConfig ¶ added in v0.4.0
func DecodeTimestampFieldFromIndexConfigs ¶ added in v0.4.0
func GetTimestampField ¶ added in v0.4.0
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 GetTimestampFieldFromIndex ¶ added in v0.4.0
func GetTimestampFieldFromIndexPattern ¶ added in v0.4.0
func NewErrorCreationPayload ¶ added in v0.3.0
func NewQuickwitDatasource ¶
func NewQuickwitDatasource(settings backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)
Creates a Quickwit datasource.
func ParseToTime ¶
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 FieldMappings ¶ added in v0.3.0
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 ¶ added in v0.3.0
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 ¶ added in v0.4.0
type QuickwitIndexMetadata struct {
IndexConfig struct {
DocMapping struct {
TimestampField string `json:"timestamp_field"`
} `json:"doc_mapping"`
} `json:"index_config"`
}
Source Files
Directories