pub struct GrafanaClient { /* private fields */ }Expand description
Client for interacting with the Grafana HTTP API.
This client provides methods to create and manage Grafana resources including dashboards, folders, and data sources. It handles authentication, request formatting, and response parsing for the Grafana API. The client is designed to support Blueprint monitoring by creating pre-configured dashboards that visualize metrics and logs.
Implementations§
Source§impl GrafanaClient
impl GrafanaClient
Sourcepub fn prometheus_datasource_url(&self) -> Option<&String>
pub fn prometheus_datasource_url(&self) -> Option<&String>
Returns the configured Prometheus datasource URL, if any.
This method provides access to the Prometheus URL that has been configured for use with Grafana dashboards. It’s used when setting up Prometheus as a data source for created dashboards.
Sourcepub fn new(config: GrafanaConfig) -> Self
pub fn new(config: GrafanaConfig) -> Self
Creates a new Grafana client with the specified configuration.
Initializes an HTTP client with appropriate authentication headers based on the provided configuration. The client will use API key authentication if available, falling back to basic authentication if credentials are provided.
Sourcepub fn config(&self) -> &GrafanaConfig
pub fn config(&self) -> &GrafanaConfig
Returns a reference to the Grafana client’s configuration.
Provides access to the underlying configuration settings that this client was initialized with, including connection URLs and authentication details.
Sourcepub async fn create_dashboard(
&self,
dashboard: Dashboard,
folder_id: Option<u64>,
message: &str,
) -> Result<String>
pub async fn create_dashboard( &self, dashboard: Dashboard, folder_id: Option<u64>, message: &str, ) -> Result<String>
Creates or updates a Grafana dashboard.
This method sends a dashboard configuration to the Grafana API, either creating a new dashboard or updating an existing one if the dashboard UID already exists. It handles the proper JSON formatting required by the Grafana API and processes the response.
§Parameters
dashboard- The dashboard configuration to create or updatefolder_id- Optional folder ID to organize the dashboard inmessage- Commit message for the dashboard change
§Returns
The dashboard URL on success
§Errors
Returns an error if the Grafana API request fails or returns an error response
Sourcepub async fn create_folder(&self, title: &str, uid: Option<&str>) -> Result<u64>
pub async fn create_folder(&self, title: &str, uid: Option<&str>) -> Result<u64>
Creates a folder in Grafana for organizing dashboards.
Folders help organize dashboards in the Grafana UI. This method attempts to create a new folder with the specified title and optional UID. If a folder with the same title already exists, it returns the existing folder’s ID rather than creating a duplicate.
§Parameters
title- The display name for the folderuid- Optional unique identifier for the folder
§Returns
The folder ID (either newly created or existing)
§Errors
Returns an error if the Grafana API request fails or returns an error response
Sourcepub async fn create_blueprint_dashboard(
&self,
service_id: u64,
blueprint_id: u64,
prometheus_datasource: &str,
loki_datasource: &str,
) -> Result<String>
pub async fn create_blueprint_dashboard( &self, service_id: u64, blueprint_id: u64, prometheus_datasource: &str, loki_datasource: &str, ) -> Result<String>
Creates a pre-configured dashboard for monitoring a Blueprint service.
Generates a comprehensive dashboard with panels for system metrics, application metrics, and logs specific to the identified Blueprint service. The dashboard includes panels for CPU usage, memory usage, job execution metrics, and log streams from the specified Loki datasource.
§Parameters
service_id- The service ID to monitorblueprint_id- The blueprint ID to monitorprometheus_datasource- Name of the Prometheus datasource to useloki_datasource- Name of the Loki datasource to use for logs
§Returns
The URL of the created dashboard
§Errors
Returns an error if the dashboard creation fails or if the Grafana API returns an error
Sourcepub async fn check_datasource_health(
&self,
uid: &str,
) -> Result<DatasourceHealthResponse>
pub async fn check_datasource_health( &self, uid: &str, ) -> Result<DatasourceHealthResponse>
Performs a health check for a Grafana datasource.
§Errors
Returns an error if the health check fails or the API request is unsuccessful.
Sourcepub async fn get_datasource(
&self,
uid: &str,
) -> Result<Option<DataSourceDetails>>
pub async fn get_datasource( &self, uid: &str, ) -> Result<Option<DataSourceDetails>>
§Errors
Returns an error if the Grafana API request fails or returns an error response
Sourcepub async fn create_or_update_datasource(
&self,
payload: CreateDataSourceRequest,
) -> Result<CreateDataSourceResponse>
pub async fn create_or_update_datasource( &self, payload: CreateDataSourceRequest, ) -> Result<CreateDataSourceResponse>
§Errors
Returns an error if the request to Grafana fails, if the response cannot be parsed, or if Grafana returns a non-success status code.
Auto Trait Implementations§
impl Freeze for GrafanaClient
impl !RefUnwindSafe for GrafanaClient
impl Send for GrafanaClient
impl Sync for GrafanaClient
impl Unpin for GrafanaClient
impl !UnwindSafe for GrafanaClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
Source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
Source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T. Read moreSource§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.Source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
Source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from.Source§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
Source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T.