Module grafana_plugin_sdk::data

source ·
Expand description

Data types used throughout the SDK.

Note that many of the types in this module are marked as #[non_exhaustive] and cannot be constructed using struct expressions. This is because Grafana may choose to add additional fields or variants at any time. Instead, use the constructor (if available) or create a mutable default value using Default::default() and modify any fields.

For example:

use grafana_plugin_sdk::{
    data::{Field, FieldConfig, Frame, Metadata, Notice, Severity},
    prelude::*,
};

let mut field_config = FieldConfig::default();
field_config.display_name_from_ds = Some("X".to_string());
let field = ["a", "b", "c"]
    .into_field("x")
    .with_config(field_config);

let mut notice = Notice::new("warning! this is important".to_string());
notice.severity = Some(Severity::Warning);
let mut metadata = Metadata::default();
metadata.path = Some("my path".to_string());
metadata.notices = Some(vec![notice]);

let frame = Frame::new("my frame")
    .with_field(field)
    .with_metadata(metadata);

Structs

  • CheckedFrame
    A reference to a checked and verified Frame, which is ready for serialization.
  • ConfFloat64
    A wrapper around an Option<f64> used in various backend data structures, with custom NaN and Infinity serialization.
  • DataLink
    Links to use when clicking on a result.
  • Field
    A typed column within a Frame.
  • FieldConfig
    The display properties for a Field.
  • Frame
    A structured, two-dimensional data frame.
  • Metadata
    Metadata about a Frame.
  • Notice
    A notification to be displayed in Grafana’s UI.
  • QueryStat
    Used for storing arbitrary statistics metadata related to a query and its results.
  • Threshold
    A single step on the threshold list.
  • ThresholdsConfig
    Configuration for thresholds for a field.
  • TypeInfo
    The type information for a Frame as understood by Grafana.
  • ValueMappingResult
    A new value to be displayed when a ValueMapping matches an input value.

Enums

  • Error
    Errors that can occur when interacting with the Grafana plugin SDK.
  • FrameInclude
    Options for customizing the way a Frame is serialized.
  • InspectType
    A suggestion for which tab to display in the panel inspector in Grafana’s UI.
  • Severity
    The severity level of a notice.
  • SimpleType
    The ‘simple’ type of this data.
  • SpecialValueMatch
    Special values that can be mapped to new text and colour values.
  • ThresholdsMode
    How thresholds should be evaluated.
  • TypeInfoType
    Valid types understood by Grafana.
  • ValueMapping
    Allows input values to be mapped to text and colour.
  • VisType
    Visualiation type options understood by Grafana.

Constants

Traits