modulepackage
0.0.0-20230801125804-9e6854553a08
Repository: https://github.com/obeleh/grafana-api-go-sdk.git
Documentation: pkg.go.dev
# README
DO NOT USE THIS FOR NORMAL GRAFANA API USE. This is a hack to get around the fact that the json from panels and rows can be different from the API spec in the original repo
# Packages
No description provided by the author
# Functions
Limit sets the max number of folders to return.
No description provided by the author
NewClient initializes client for interacting with an instance of Grafana server; apiKeyOrBasicAuth accepts either 'username:password' basic authentication credentials, or a Grafana API key.
NewCustom initializes panel with a stat panel.
NewDashlist initializes panel with a dashlist panel.
No description provided by the author
NewGraph initializes panel with a graph panel.
No description provided by the author
No description provided by the author
NewPluginlist initializes panel with a stat panel.
NewSinglestat initializes panel with a singlestat panel.
NewStat initializes panel with a stat panel.
NewTable initializes panel with a table panel.
NewText initializes panel with a text panel.
NewTimeseries initializes panel with a timeseries panel.
QueryParamLimit sets `limit` parameter.
QueryParamStart sets `start` parameter.
SearchDashboardID specifies Search dashboard id's to search for.
SearchFolderID specifies Search folder id's to search for.
SearchLimit specifies maximum number of results from Search query.
SearchPage specifies Search page number to be queried for.
SearchQuery specifies Search search query.
SearchStarred specifies if Search should search for starred dashboards only.
SearchTag specifies Search tag to search for.
SearchType specifies Search type to search for.
WithAlertType filters the type to alerts.
WithAnnotationType filters the type to annotations.
WithDashboard filters the response to the specified dashboard ID.
WithEndTime filters the annotations to before the specified time.
WithLimit sets the max number of alerts to return.
WithPage adds a page number query parameter.
WithPagesize adds a page size query parameter.
WithPanel filters the response to the specified panel ID.
WithQuery adds a query parameter.
WithStartTime filters the annotations to after the specified time.
WithTag adds the tag to the.
WithTeam adds a query parameter.
WithUser filters the annotations to only be made by the specified user ID.
# Constants
Each panel may be one of these types.
Each panel may be one of these types.
Each panel may be one of these types.
Each panel may be one of these types.
DefaultFolderId is the id of the general folder that is pre-created and cannot be removed.
Each panel may be one of these types.
Each panel may be one of these types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Each panel may be one of these types.
Each panel may be one of these types.
Search entities to be used with SearchType().
Search entities to be used with SearchType().
Each panel may be one of these types.
Each panel may be one of these types.
Each panel may be one of these types.
Constants for templating.
Constants for templating.
Constants for templating.
Each panel may be one of these types.
Each panel may be one of these types.
# Variables
DefaultHTTPClient initialized Grafana with appropriate conditions.
TeamNotFound is an error returned if the given team was not found.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AlertNotification as described in the doc https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AnnotationResponse is representation of an existing annotation.
for a graph panel.
No description provided by the author
No description provided by the author
BoardProperties keeps metadata of a dashboard.
No description provided by the author
No description provided by the author
Client uses Grafana REST API for interacting with Grafana server.
for a table.
for a table.
No description provided by the author
CreateAnnotationRequest is a request to create a new annotation.
CreateSnapshotRequest is representation of a snapshot request.
No description provided by the author
DashboardVersion represents a response from /api/dashboards/id/:dashboardId/versions API.
No description provided by the author
Datasource as described in the doc http://docs.grafana.org/reference/http_api/#get-all-datasources.
Datasource type as described in http://docs.grafana.org/reference/http_api/#available-data-source-types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FloatString represents special type for json values that could be strings or ints: 100 or "100".
Folder as described in the doc https://grafana.com/docs/grafana/latest/http_api/folder/#get-all-folders.
No description provided by the author
FoundBoard keeps result of search with metadata of a dashboard.
for a stat.
No description provided by the author
HealthResponse represents the health of grafana server.
No description provided by the author
IntString represents special type for json values that could be strings or ints: 100 or "100".
for a graph panel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PatchAnnotationRequest is a request to patch an existing annotation.
No description provided by the author
No description provided by the author
No description provided by the author
RawBoardRequest struct that wraps Board and parameters being sent.
Row represents single row of Grafana dashboard.
No description provided by the author
for a graph panel.
SetDashboardParams contains the extra parameters that affects where and how the dashboard will be stored.
No description provided by the author
for a graph panel.
for a stat.
StackdriverAlignOption defines a single alignment option shown in Grafana during query configuration.
StackdriverAlignOptions defines the list of alignment options shown in Grafana during query configuration.
No description provided by the author
StatusMessage reflects status message as it returned by Grafana REST API.
StringSliceString represents special type for json values that could be strings or slice of strings: "something" or ["something"].
No description provided by the author
for an any panel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
for a stat.
Version struct that wraps GetAllDashboardVersions API Call Response.
# Type aliases
No description provided by the author
GetAnnotationsParams is the type for all options implementing query parameters https://grafana.com/docs/grafana/latest/http_api/annotations/#find-annotations.
GetFolderParams is the type for all options implementing query parameters.
Height of rows maybe passed as number (ex 200) or as string (ex "200px") or empty string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SearchTeamParams is the type for all options implementing query parameters perpage optional.