Struct grafana_plugin_sdk::backend::PluginContext

#[non_exhaustive]
pub struct PluginContext {
    pub org_id: i64,
    pub plugin_id: String,
    pub user: Option<User>,
    pub app_instance_settings: Option<AppInstanceSettings>,
    pub datasource_instance_settings: Option<DataSourceInstanceSettings>,
}

Holds contextual information about a plugin request: Grafana org, user, and plugin instance settings.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

org_id: i64

The organisation ID from which the request originated.

plugin_id: String

The ID of the plugin.

user: Option<User>

Details about the Grafana user who made the request.

This will be None if the Grafana backend initiated the request, such as when the request is made on behalf of Grafana Alerting.

app_instance_settings: Option<AppInstanceSettings>

The configured app instance settings.

An app instance is an app plugin of a certain type that has been configured and enabled in a Grafana organisation.

This will be None if the request does not target an app instance.

datasource_instance_settings: Option<DataSourceInstanceSettings>

The configured datasource instance settings.

A datasource instance is a datasource plugin of a certain type that has been configured and created in a Grafana organisation. For example, the ‘datasource’ may be the Prometheus datasource plugin, and there may be many configured Prometheus datasource instances configured in a Grafana organisation.

This will be None if the request does not target a datasource instance.

Trait Implementations

impl Clone for PluginContext

fn clone(&self) -> PluginContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl TryFrom<PluginContext> for PluginContext

type Error = ConvertFromError

The type returned in the event of a conversion error.

fn try_from(other: PluginContext) -> Result<Self, Self::Error>

Performs the conversion.