Wiki source code of Grafana

Version 34.5 by Peter Wurbs on 2025/04/14 12:17

version	line-number	content
6.1	1	(% class="wikigeneratedid" %)
	2	[[image:https://logowik.com/content/uploads/images/grafana-icon4114.logowik.com.webp\|\|alt="Grafana Icon Logo PNG vector in SVG, PDF, AI, CDR format" data-xwiki-image-style-alignment="end" height="107" width="143"]]
	3
	4	= Content =
	5
5.1	6	{{toc/}}
	7
7.1	8	= Introduction =
3.1	9
4.1	10	Grafana is an open-source platform for monitoring and visualizing time-series data from sources like Prometheus, Loki, Databases etc. It allows users to create interactive dashboards and alerts to track system performance and trends in real time.
7.1	11
8.1	12	[[Vendor Page>>https://grafana.com/]]
7.1	13
	14	There is good documentation to start using Grafana:
	15
	16	[[Grafana Documentation>>https://grafana.com/docs/grafana/latest/?utm_source=grafana_gettingstarted]]
	17
	18	[[Grafana Tutorials>>https://grafana.com/tutorials/?utm_source=grafana_gettingstarted]]
	19
13.1	20	There is a great possibility to play with Grafana using the [[Grafana Playground>>https://play.grafana.org/d/bdnahipisghdsa/getting-started-with-grafana-play?orgId=1]].
	21
8.1	22	= Accessing Grafana =
	23
11.1	24	* Grafana as part of the DevOps-as-a-Service toolchain can be accessed by either
32.1	25	** DevOps Portal Homepage → Grafana Tile
9.1	26	[[image:1744266164249-840.png]]
11.1	27	** or directly use the URL [[https:~~/~~/grafana-<customer~>.devops.t-systems.net>>https://grafana-<customer>.devops.t-systems.net]]
13.1	28	* Preconditions in DevOps portal to access Grafana:
	29	** A Grafana license must be assigned to the user
	30	** Grafana must be added to the tool list of the project
11.1	31	* If you are not already logged in to another tool in the toolchain, then you have to login using your configured SSO credentials.
	32	* When you see this message after entering your credentials, then you don't have a Grafana license assigned in the DevOps portal:
8.1	33	[[image:1744266590219-161.png\|\|height="242" width="293"]]
	34
32.2	35	= Users, Projects and Roles =
8.1	36
11.1	37	* Projects, users and their roles in projects are managed in the DevOps portal, the corresponding functions in Grafana are disabled (UI and API)
32.2	38
	39	(% class="box warningmessage" %)
	40	(((
	41	⚠ Note
32.10	42	Projects in DevOps portal are mapped to Grafana Organizations. These are not related to the organizations in the portal.
32.2	43	)))
	44
34.1	45	* When there is a new project in the portal having Grafana as a configured tool, then there is a new Grafana Organization. Users assigned to a project in the portal are then assigned to a Grafana Organization applying the configured roles.
10.1	46	** Role mapping: (((
34.3	47	(% class="active" %)\|=Project Role in DevOps Portal\|=Grafana Organization Role\|=Permissions in Grafana
34.2	48	\|Admin\|Admin\|Has full permissions within the Grafana org, e.g. can setup datasources, manage folders, teams and service accounts
34.3	49	\|Master\|(% colspan="1" rowspan="2" %)Editor\|(% colspan="1" rowspan="2" %)Can create/edit dashboards and alerts and use the Explore function
	50	\|Developer
11.1	51	\|Viewer\|Viewer\|Can view dashboards and alerts
10.1	52
11.1	53	A detailed description of the Grafana role model can be found [[here>>https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/]].
10.1	54	)))
11.1	55	* There is an additional permission management possible on folder level. A folder contains a set of dashboards. A project admin can create folders and manage specific permissions for this folder using Grafana. See this [[link >>https://grafana.com/docs/grafana/latest/dashboards/manage-dashboards/#create-a-dashboard-folder]]for further information. Folder permissions management is out of scope of the user management in the DevOps portal.
34.4	56	* A project admin is entitled to create and manage "Service Accounts" in Grafana and grant permissions in the specific organization. A Service Account belongs to an Organization and not to an user. Service Accounts can be used for systems which want to work wit the Grafana API for any automation purposes. See this [[link >>https://grafana.com/docs/grafana/latest/administration/service-accounts/]]for further information. Service Account management is done directly in Grafana and is out of scope of the user management in the DevOps portal. This function is comparable with the Technical Users feature in the DevOps portal.
13.1	57	* If you are assigned to more than one project in the DevOps portal, having Grafana configured as tool, then you can switch between Organizations in Grafana. Go to the top left corner, click on the Org list and select any other Grafana Organization (project), you want to switch to.
	58	[[image:1744272203893-682.png\|\|height="272" width="255"]]
8.1	59
29.1	60	(% class="box warningmessage" %)
	61	(((
	62	⚠ Note
	63	When you work in Grafana, always make sure that you chose the intended Organization.
	64	)))
	65
14.1	66	= Main Functions =
	67
	68	== Datasources ==
	69
	70	* Before you can setup dashboards and alerts, you have to setup datasources. Grafana itself is only a visualization tool, for data gathered via datasources.
	71	* Datasources are created/managed per Grafana Organization.
	72	* The Admin role is required to setup and manage datasources.
26.2	73
	74	(% class="box warningmessage" %)
14.1	75	(((
26.2	76	⚠ Note
14.1	77	When a datasource is available in an Organization, every user assigned to this Organization (Project) with Admin or Edit role can access/explore the data provided by this datasource.
	78	)))
26.2	79
34.5	80	* Most common datasources are available for
14.1	81	** Prometheus to visualize metrics
	82	** Loki to search and visualize logs
	83	** MySQL, PostgreSQL to access and visualize database data
34.5	84	** ...
14.1	85	* Many possible datasource types are preinstalled as built-in plugins and can be used
34.5	86	* Datasource are set up via Menu panel → Connections → Datasources
17.1	87	[[image:1744273328067-517.png\|\|height="273" width="222"]]
18.1	88	* Detailed information can be found via this [[link>>https://grafana.com/docs/grafana/latest/datasources/]].
18.2	89
	90	== Explore ==
	91
18.8	92	* Based on set up datasources, users owning the Edit or Admin role can explore provided data using the "Explore" function.
	93	* "Explore" can be used for:
18.10	94	** Check provided data, contained labels
18.13	95	** Search for specific data
18.12	96	** Quickly execute queries and generate visualization panels
18.13	97	** Generate queries later to be used in dashboards
20.10	98	* "Explore" function can be found in the Menu panel
18.14	99	* Detailed information can be found via this [[link>>https://grafana.com/docs/grafana/latest/explore/]]
20.1	100
	101	== Dashboards ==
	102
20.3	103	* Dashboards are the way to visualize metrics, logs and other data.
20.9	104	* Dashboards are a collection of "Panels". Each panel is of a specific type (stat, time series, table, log...). Many Panel Plugins are preinstalled and can be used.
20.4	105	* Data are displayed based on queries which are the main part of a panel configuration.
	106	* Dashboards can be created and edited by users owning the Editor or Admin role
20.10	107	* "Dashboard" function can be in the Menu panel
21.2	108	* There is a good [[guideline >>https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/]]about the first steps.
20.10	109	* Detailed information can be found via this [[link>>https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/]].
21.2	110
	111	== Alerts ==
	112
21.3	113	* Based on the data gathered via datasources, alerts can be defined.
	114	* In contrast to the classic alerting, the new Grafana Unified Alerting is set up mostly independent of specific dashboards.
21.4	115	* Alerting configuration is split into
	116	** Alert rules
	117	** Contact points
	118	** Notification policies
21.5	119	* How it works
	120	** Grafana alerting periodically queries data sources and evaluates the condition defined in the alert rule
	121	** If the condition is breached, an alert instance fires
	122	** Firing instances are routed to notification policies based on matching labels
	123	** Notifications are sent out to the contact points specified in the notification policy
22.2	124	** [[image:1744277362911-905.png\|\|height="169" width="514"]]
21.7	125	* Many contact point types like E-Mail, Teams, Slack, Pushover etc. are available and can be configured.
	126	* "Alerting" function can be in the Menu panel
22.2	127	* Detailed information can be found via this [[link>>https://grafana.com/docs/grafana/latest/alerting/]].
	128
22.6	129	= Metrics of DevOps-as-a-Service Toolchain =
	130
22.9	131	* As part of the Grafana deployment, preconfigured and standardized dashboards are provided to show relevant data about the DevOps-as-a-Service toolchain
22.19	132	* These dashboards are located in the MainOrg.
22.22	133	* To access them:
	134	** Switch to the MainOrg in the Org list on the top left corner.
	135	** Click on Dashboards in the left Menu pane
	136	** Click on folder "DevOps-as-a-Service Metrics"
22.26	137	** Choose the dashboard you want to see
25.1	138	** [[image:1744278056971-203.png\|\|height="285" width="826"]]
31.1	139	** Alternatively, you can use the link in the "Useful Links" panel of the Grafana Home page.
	140	[[image:1744285635938-113.png\|\|height="127" width="350"]]
26.2	141
27.2	142	(% class="box warningmessage" %)
	143	(((
	144	⚠ Note
26.1	145	Every user assigned a Grafana license in the DevOps portal is able to access them, independent of any project assignment.
	146	)))

Wiki source code of Grafana

DevOps-as-a-Service