OS4X Grafana Integration - Revision history

Admin: /* Error resolving hints */

2025-11-28T14:19:48Z

Error resolving hints

Admin: /* Solution */

2025-11-28T14:12:47Z

Solution

Admin: /* Panel shows "No data" */

2025-11-28T14:11:32Z

Panel shows "No data"

Admin: /* Error resolving hints */

2025-11-28T14:11:19Z

Error resolving hints

Admin at 13:37, 28 November 2025

2025-11-28T13:37:11Z

Admin at 13:27, 28 November 2025

2025-11-28T13:27:48Z

Admin at 13:16, 28 November 2025

2025-11-28T13:16:48Z

Admin at 12:11, 26 November 2025

2025-11-26T12:11:34Z

Admin at 12:10, 26 November 2025

2025-11-26T12:10:07Z

Admin at 13:27, 29 October 2025

2025-10-29T13:27:36Z

← Older revision		Revision as of 14:19, 28 November 2025
Line 57:		Line 57:
	*table "<code>os4x_throughput</code>", all fields		*table "<code>os4x_throughput</code>", all fields
	*table "<code>os4x_partners</code>", fields "<code>idx</code>" and "<code>shortname</code>"		*table "<code>os4x_partners</code>", fields "<code>idx</code>" and "<code>shortname</code>"
		+
		+	== TSL secured database backend ==
		+	The automatic setup of the data source in Grafana supports at the moment only unencrypted MySQL/MariaDB database connections. If you are using an encrypted connection, you must configure the existing datasource manually.

@@ Line 56: / Line 56: @@
 Add a new database user to the database backend which is allowed to access the database and at least to select the following entities:
 *table "<code>os4x_throughput</code>", all fields
-*table "<code>os4x_partners</code>", fields "<code>idx</code>" and "<code>longname</code>"
+*table "<code>os4x_partners</code>", fields "<code>idx</code>" and "<code>shortname</code>"

@@ Line 56: / Line 56: @@
 Add a new database user to the database backend which is allowed to access the database and at least to select the following entities:
 *table "<code>os4x_throughput</code>", all fields
-*table "<code>os4x_partners<code>", fields "<code>idx</code>" and "<code>longname</code>"
+*table "<code>os4x_partners</code>", fields "<code>idx</code>" and "<code>longname</code>"

← Older revision		Revision as of 14:11, 28 November 2025
Line 39:		Line 39:

	= Error resolving hints =		= Error resolving hints =
		+
		+	== Panel shows "No data" ==
		+	The most obvious reason is missing permissions to the database by Grafana. Verify this by the following steps:
		+	*In OS4Xadmin, navigate to "Logging" -> "Grafana", remember the title of the panel, especially the UUID after "OS4X throughput per partner" (i.e. "<code>408d85cc-64ab-4de7-aa25-9877a52225fd</code>")
		+	*Navigate to the admin panel of Grafana (the URL provided in "Configuration" -> "Grafana" -> "Grafana API URL", i.e. http://192.168.40.145:3000
		+	*Authorize as administrative user in Grafana
		+	*Navigate to "Connections" -> "Data sources"
		+	*Extract the data source with the same UUID as the panel's name (i.e. "<code>os4x-408d85cc-64ab-4de7-aa25-9877a52225fd</code>"), click on that entry
		+	*Scroll down to the bottom, click on "Save and test". An error message should appear like this:
		+
		+	[[File:Bildschirmfoto 2025-11-28 um 15.08.00.png]]
		+
		+	The error describes more details. In this case, the database user "<code>os4x_cworks_de</code>" from the resolved host "<code>heimdall.lan</code>" is not allowed to access the database.
		+
		+	=== Solution ===
		+	Add a new database user to the database backend which is allowed to access the database and at least to select the following entities:
		+	*table "<code>os4x_throughput</code>", all fields
		+	*table "<code>os4x_partners<code>", fields "<code>idx</code>" and "<code>longname</code>"

← Older revision		Revision as of 13:37, 28 November 2025
Line 23:		Line 23:

	[[File:Bildschirmfoto 2025-11-28 um 14.26.39.png]]		[[File:Bildschirmfoto 2025-11-28 um 14.26.39.png]]
		+
		+	== Connection ==
		+	After entering the Grafana API URL and admin API token (optionally an Org-ID value), you can click on "Test connection" which verifies the functionality. If it succeeds, the next button will be enabled.
		+
		+	== Data source ==
		+	The current database connection needs to be defined in Grafana. This only defines the connection, but cannot check its functionality. If something doesn't work with the connectivity, check the chapter "Error resolving hints" below. If the datasource isn't defined in Grafana yet, it will be added automatically. The value of "Datasource UID" will be filled out dynamically. If successful, the last button "Check dashboard" will be enabled.
		+
		+	== Dashboard ==
		+	The last button "Check dashboard" verifies the existance of a dashboard for this OS4X installation (identified by its dynamically created UUID). If the dashboard doesn't exist, it will be created automatically. This dashboard will be named "OS4X throughput per partner - ''<UUID>''". This dashboard will be shared externally from Grafana, so no API token or authentication is required to access its panel. If everything works fine, the dashboard UID and URL will be added dynamically to the configuration panel. You are now ready to save the created and defined values.
		+
		+	= Accessing Grafana graph =
		+	OS4X integrates the Grafana graph in a separate panel, accessible via the administrative web interface in "Logs" -> "Grafana":
		+
		+	[[File:Bildschirmfoto 2025-11-28 um 14.36.38.png]]
		+
		+	= Error resolving hints =

@@ Line 1: / Line 1: @@
 = Requirements =
 A Grafana server with installed MySQL Data Source plugin is required. For the configuration of the integration you need an API token with administrative permissions.
@@ Line 8: / Line 16: @@
   systemctl restart grafana-server.service
-= Coming soon =
+= Authentication token =
-''(t.b.d.)''
+The dynamic setup of the Grafana data source, dashboard and panel requires an administrative API token. You can generate one in the Grafana admin interface in "Administration" -> "Users and access" -> "Service accounts". Pick an existing service account or create a new one with role "Admin". Add a service account token. The token is only required during setup and can be removed afterwards.

@@ Line 2: / Line 2: @@
 A Grafana server with installed MySQL Data Source plugin is required. For the configuration of the integration you need an API token with administrative permissions.
-= Configuration =
+= Grafana server configuration =
 Since the panel is being embedded as an HTML iframe, the HTTP response header must not contain "<code>X-Frame-Options: DENY</code>". Change the Grafana configuration (default: <code>/etc/grafana/grafana.ini</code>) the following value:
   allow_embedding = true

← Older revision		Revision as of 13:27, 29 October 2025
Line 1:		Line 1:
	= Coming soon =		= Coming soon =
	''(t.b.d.)''		''(t.b.d.)''
		+
		+	= Configuration =
		+	Since the panel is being embedded as an HTML iframe, the HTTP response header must not contain "<code>X-Frame-Options: DENY</code>". Change the Grafana configuration (default: <code>/etc/grafana/grafana.ini</code>) the following value:
		+	allow_embedding = true
		+	Restart Grafana afterwards:
		+	systemctl restart grafana-server.service