plugin

Documentation

Index

• func CreateTableFramesFromQuery(ctx context.Context, tableName string, cursor *mongo.Cursor) (*data.Frame, error)
• func CreateTimeSeriesFramesFromQuery(ctx context.Context, cursor *mongo.Cursor) (map[string]*data.Frame, error)
• func MongoUri(config *models.PluginSettings) (string, error)
• func NewDatasource(ctx context.Context, source backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)
• func PrintDataFrame(dataFrame *data.Frame)
• type Datasource
  • func (d *Datasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)
  • func (d *Datasource) Dispose()
  • func (d *Datasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)
• type TimeSeriesRow

Functions

func CreateTableFramesFromQuery

func CreateTableFramesFromQuery(ctx context.Context, tableName string, cursor *mongo.Cursor) (*data.Frame, error)

func CreateTimeSeriesFramesFromQuery

func CreateTimeSeriesFramesFromQuery(ctx context.Context, cursor *mongo.Cursor) (map[string]*data.Frame, error)

Create time-series data frames of different names on Mongo query result. Each data frame has field "ts", "value" and "name"

func MongoUri

func MongoUri(config *models.PluginSettings) (string, error)

Validate mongo connection configuration and return connection string

func NewDatasource

func NewDatasource(ctx context.Context, source backend.DataSourceInstanceSettings) (instancemgmt.Instance, error)

NewDatasource creates a new MongoDB datasource instance.

func PrintDataFrame

func PrintDataFrame(dataFrame *data.Frame)

Types

type Datasource

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

Datasource is a mongo datasource which can respond to data queries, reports its health and has streaming skills.

func (*Datasource) CheckHealth

func (d *Datasource) 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 (*Datasource) Dispose

func (d *Datasource) 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 (*Datasource) QueryData

func (d *Datasource) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)

QueryData handles multiple queries and returns multiple responses. req contains the queries []DataQuery (where each query contains RefID as a unique identifier). The QueryDataResponse contains a map of RefID to the response for each query, and each response contains Frames ([]*Frame).

type TimeSeriesRow

type TimeSeriesRow[T any] struct {
	Timestamp time.Time `bson:"ts"`
	Name      string    `bson:"name"`
	Value     T         `bson:"value"`
}