package pluginv2

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc QueryData (QueryDataRequest, QueryDataResponse)

  pluginv2.proto:95

• rpc CheckHealth (CheckHealthRequest, CheckHealthResponse)

  pluginv2.proto:141

  message CheckHealthRequest

  pluginv2.proto:157

  • optional PluginContext pluginContext = 1

  message CheckHealthResponse

  pluginv2.proto:161

  • CheckHealthResponse.HealthStatus status = 1

  • string message = 2

  • bytes jsonDetails = 3

• rpc CollectMetrics (CollectMetricsRequest, CollectMetricsResponse)

  pluginv2.proto:142

  message CollectMetricsRequest

  pluginv2.proto:145

  • optional PluginContext pluginContext = 1

  message CollectMetricsResponse

  pluginv2.proto:149

  • optional CollectMetricsResponse.Payload metrics = 1

• rpc CallResource (CallResourceRequest, stream CallResourceResponse)

  pluginv2.proto:68

  message CallResourceRequest

  pluginv2.proto:75

  • optional PluginContext pluginContext = 1

  • string path = 2

  • string method = 3

  • string url = 4

  • map<string, StringList> headers = 5

  • bytes body = 6

  message CallResourceResponse

  pluginv2.proto:84

  • int32 code = 1

  • map<string, StringList> headers = 2

  • bytes body = 3

• rpc TransformData (QueryDataRequest, QueryDataResponse)

  pluginv2.proto:178

• rpc QueryData (QueryDataRequest, QueryDataResponse)

  pluginv2.proto:182

Used in: PluginContext

• bytes jsonData = 3

• map<string, string> decryptedSecureJsonData = 4

• int64 lastUpdatedMS = 5

Used in: CheckHealthResponse

• UNKNOWN = 0

• OK = 1

• ERROR = 2

Used in: CollectMetricsResponse

• bytes prometheus = 1

Used in: QueryDataRequest

• string refId = 1

• int64 maxDataPoints = 2

• int64 intervalMS = 3

• optional TimeRange timeRange = 4

• bytes json = 5

• string queryType = 6

Used in: QueryDataResponse

• repeated bytes frames = 1

  Arrow encoded DataFrames Frame has its own meta, warnings, and repeats refId

• string error = 2

• bytes jsonMeta = 3

  Warning: Current ignored by frontend. Would be for metadata about the query.

Used in: PluginContext

• int64 id = 1

• string name = 2

• string url = 3

• string user = 4

• string database = 5

• bool basicAuthEnabled = 6

• string basicAuthUser = 7

• bytes jsonData = 8

• map<string, string> decryptedSecureJsonData = 9

• int64 lastUpdatedMS = 10

Used in: CallResourceRequest, CheckHealthRequest, CollectMetricsRequest, QueryDataRequest

• int64 orgId = 1

  The Grafana organization id the request originating from.

• string pluginId = 2

  The unique identifier of the plugin the request originating from.

• optional User user = 3

  The Grafana user the request originating from. Will not be provided if Grafana backend initiated the request.

• optional AppInstanceSettings appInstanceSettings = 4

  App plugin instance settings is the configured app instance settings. In Grafana an app instance is an enabled app plugin in a Grafana organization. Will only be set if request targeting an app instance.

• optional DataSourceInstanceSettings dataSourceInstanceSettings = 5

  Data source instance settings is the configured data source instance settings. In Grafana a data source instance is a created data source in a Grafana organization. Will only be set if request targeting a data source instance.

QueryDataRequest

Used as request type in: Data.QueryData, Transform.TransformData, TransformDataCallBack.QueryData

• optional PluginContext pluginContext = 1

• map<string, string> headers = 2

  Environment info

• repeated DataQuery queries = 3

  List of data queries

Used as response type in: Data.QueryData, Transform.TransformData, TransformDataCallBack.QueryData

• map<string, DataResponse> responses = 1

  Map of refId to response

Used in: CallResourceRequest, CallResourceResponse

• repeated string values = 1

Used in: DataQuery

• int64 fromEpochMS = 1

• int64 toEpochMS = 2

Used in: PluginContext

• string login = 1

• string name = 2

• string email = 3

• string role = 4