From 902ecc9a0688cc43273d8a19c15591136cc860fc Mon Sep 17 00:00:00 2001 From: Marcus Olsson Date: Wed, 30 Sep 2020 15:07:44 +0200 Subject: [PATCH] Docs: Add trace and exemplar to glossary (#27854) * Format glossary table * Add trace and examplar to glossary * Fix typo * Fix review comments * Fix review comment * Update docs/sources/getting-started/glossary.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> --- docs/sources/getting-started/glossary.md | 93 ++++++++++++++++-------- 1 file changed, 62 insertions(+), 31 deletions(-) diff --git a/docs/sources/getting-started/glossary.md b/docs/sources/getting-started/glossary.md index f649fc99c24..a4aa6b705c5 100644 --- a/docs/sources/getting-started/glossary.md +++ b/docs/sources/getting-started/glossary.md @@ -17,41 +17,72 @@ This topic lists words and abbreviations that are commonly used in the Grafana d - - - - - - - - - - - - - - - - - - + - - - - - - - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DashboardA set of one or more panels, organized and arranged into one or more rows, that provide an at-a-glance view of related information.
Data sourceA file, database, or service providing the data. Grafana supports a several data sources by default, and can be extended to support additional ones through plugins.
GraphA commonly-used visualization that displays data as points, lines, or bars.
PanelBasic building block in Grafana, composed by a query and a visualization. Can be moved and resized within a dashboard.
PluginAn extension of Grafana that allows users to provide additional functionality to enhance their experience. The types of plugins currently supported are: -
    -
  • App plugin: Extends Grafana with a customized experience. It includes a set of panel and data source plugins, as well as custom pages.
  • -
  • Data source plugin: Extends Grafana with support for additional data sources.
  • -
  • Panel plugin: Extends Grafana with additional visualization options.
  • -
+
Dashboard + A set of one or more panels, organized and arranged into one or more rows, that provide an at-a-glance view of related information.
QueryUsed to request data from a data source. The structure and format of the query depend on the specific data source.
Time seriesA series of measurements, ordered by time. Time series are stored in data sources and returned as the result of a query.
Data source + A file, database, or service providing the data. Grafana supports a several data sources by default, and can be extended to support additional data sources through plugins. +
VisualizationExemplar + An exemplar is any data that serves as a detailed example of one of the observations aggregated into a metric. An exemplar contains the observed value together with an optional timestamp and arbitrary labels, which are typically used to reference a trace. +
Graph + A commonly-used visualization that displays data as points, lines, or bars. +
Panel + Basic building block in Grafana, composed by a query and a visualization. Can be moved and resized within a dashboard. +
Plugin + An extension of Grafana that allows users to provide additional functionality to enhance their experience. The types of plugins currently supported are: +
    +
  • + App plugin: Extends Grafana with a customized experience. It includes a set of panel and data source plugins, as well as custom pages. +
  • +
  • + Data source plugin: Extends Grafana with support for additional data sources. +
  • +
  • + Panel plugin: Extends Grafana with additional visualization options. +
  • +
+
Query + Used to request data from a data source. The structure and format of the query depend on the specific data source. +
Time series + A series of measurements, ordered by time. Time series are stored in data sources and returned as the result of a query. +
Trace + An observed execution path of a request through a distributed system. For more information, refer to [What is Distributed Tracing?](https://opentracing.io/docs/overview/what-is-tracing/). +
Visualization A graphical representation of query results.