Grafana - Revision history

Axka: Add infobox and Template:File-based codeblocks

2025-08-03T06:46:19Z

Add infobox and Template:File-based codeblocks

Axka: Add intra-wiki links and document code example

2025-08-03T05:59:03Z

Add intra-wiki links and document code example

← Older revision		Revision as of 05:59, 3 August 2025
Line 1:		Line 1:
	[https://grafana.com/ Grafana] is an open-source, general purpose dashboarding tool, which runs as a web application. It can be used to create a variety of time-series graphs and also for displaying logs. It supports Prometheus, graphite, InfluxDB, opentsdb, Grafana Loki, PostgreSQL and many other data sources.		[https://grafana.com/ Grafana] is an open-source, general purpose dashboarding tool, which runs as a web application. It can be used to create a variety of time-series graphs and also for displaying logs. It supports [[Prometheus]], graphite, InfluxDB, opentsdb, [[Grafana Loki]], [[PostgreSQL]] and many other data sources.

	See [https://search.nixos.org/options?query=services.grafana Grafana options]		See [https://search.nixos.org/options?query=services.grafana Grafana options].

	== Installation ==		== Installation ==
Line 74:		Line 74:
	== Configuration ==		== Configuration ==

	Everything ~~else~~ (data sources, users, dashboards, ...) can be configured either in the Web UI, or as code.		Everything (data sources, users, dashboards, ...) can be configured either in the Web UI or provisioned as code using Nix.

	=== Via Web UI ===		=== Via Web UI ===
Line 85:		Line 85:

	=== Declarative configuration ===		=== Declarative configuration ===

			Grafana supports [https://grafana.com/docs/grafana/latest/administration/provisioning/ provisioning] data sources, dashboards and alerting using {{nixos:option\|services.grafana.provision}}. Note that removing a provision and switching to the new NixOS configuration does not currently remove the provisioned items; you have to define them, for example, in <code>deleteDatasources</code>.

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
Line 93:		Line 95:
	enable = true;		enable = true;

			# Creates a mutable dashboard provider, pulling from /etc/grafana-dashboards.
			# With this, you can manually provision dashboards from JSON with `environment.etc` like below.
	dashboards.settings.providers = [{		dashboards.settings.providers = [{
	name = "my dashboards";		name = "my dashboards";
	options.path = "/etc/grafana-dashboards";		disableDeletion = true;
			options = {
			path = "/etc/grafana-dashboards";
			foldersFromFilesStructure = true;
			};
	}];		}];

	datasources.settings.datasources = [		datasources.settings.datasources = [
	# ~~"Built~~-in~~" datasources can be provisioned - see https://grafana.com/docs/grafana/latest/administration/provisioning/#~~data~~-sources~~		# Provisioning a built-in data source
	{		{
	name = "Prometheus";		name = "Prometheus";
	type = "prometheus";		type = "prometheus";
	url = "http://${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";		url = "http://${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";
			isDefault = true;
			editable = false;
	}		}
	# All plugins can, but it's not always documented: https://github.com/fr-ser/grafana-sqlite-datasource/blob/main/docs/faq.md#can-i-use-provisioning-with-this-plugin		# All plugins can be provisioned but it's not always documented: https://github.com/fr-ser/grafana-sqlite-datasource/blob/main/docs/faq.md#can-i-use-provisioning-with-this-plugin
	# Compare below with https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/		# Compare below with https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/
	{		{
	name = "Infinity";		name = "Infinity";
	type = "yesoreyeram-infinity-datasource";		type = "yesoreyeram-infinity-datasource";
			editable = false;
	}		}
	];		];

	# Note: removing attributes from the above `datasources.settings.datasources` is not enough for them to be deleted ~~on `grafana`~~;		# Note: removing attributes from the above `datasources.settings.datasources` is not currently enough for them to be deleted;
	# One needs to use the following option:		# One needs to use the following option:
	# datasources.settings.deleteDatasources = [ { name = "foo"; orgId = 1; } { name = "bar"; orgId = 1; } ];		# datasources.settings.deleteDatasources = [ { name = "foo"; orgId = 1; } { name = "bar"; orgId = 1; } ];
Line 119:		Line 130:
	};		};

	environment.etc ~~= [{~~		# see `dashboards.settings.providers` above
	~~source =~~ .~~/. +~~ "/grafana-dashboards/some-dashboard.json";		environment.etc."grafana-dashboards/some-dashboard.json".source = ./some-dashboard.json;
	~~group~~ = ~~"grafana";~~
	~~user = "grafana";~~
	}];
	</syntaxhighlight>		</syntaxhighlight>

Axka: All plugins can be provisioned

2025-08-03T05:30:20Z

All plugins can be provisioned

← Older revision		Revision as of 05:30, 3 August 2025
Line 99:		Line 99:

	datasources.settings.datasources = [		datasources.settings.datasources = [
	# "Built-in" datasources can be provisioned - ~~c.f.~~ https://grafana.com/docs/grafana/latest/administration/provisioning/#data-sources		# "Built-in" datasources can be provisioned - see https://grafana.com/docs/grafana/latest/administration/provisioning/#data-sources
	{		{
	name = "Prometheus";		name = "Prometheus";
Line 105:		Line 105:
	url = "http://${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";		url = "http://${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";
	}		}
	# ~~Some~~ plugins ~~also~~ can - ~~c.f~~. https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/		# All plugins can, but it's not always documented: https://github.com/fr-ser/grafana-sqlite-datasource/blob/main/docs/faq.md#can-i-use-provisioning-with-this-plugin
			# Compare below with https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/
	{		{
	name = "Infinity";		name = "Infinity";
	type = "yesoreyeram-infinity-datasource";		type = "yesoreyeram-infinity-datasource";
	}		}
	~~# But not all - c.f. https://github.com/fr-ser/grafana-sqlite-datasource/issues/141~~
	];		];

Alexandru Tocar: Fixed a typo: "serve Grafana", not "server Grafana".

2025-08-02T12:42:02Z

Fixed a typo: "serve Grafana", not "server Grafana".

← Older revision		Revision as of 12:42, 2 August 2025
Line 18:		Line 18:
	domain = "grafana.your.domain";		domain = "grafana.your.domain";

	# Alternatively, if you want to ~~server~~ Grafana from a subpath:		# Alternatively, if you want to serve Grafana from a subpath:
	# domain = "your.domain";		# domain = "your.domain";
	# root_url = "https://your.domain/grafana/";		# root_url = "https://your.domain/grafana/";

Dander: add recommended defaults (non-default for BC reasons)

2024-10-23T12:10:46Z

add recommended defaults (non-default for BC reasons)

← Older revision		Revision as of 12:10, 23 October 2024
Line 14:		Line 14:
	http_addr = "127.0.0.1";		http_addr = "127.0.0.1";
	http_port = 3000;		http_port = 3000;
			enforce_domain = true;
			enable_gzip = true;
	domain = "grafana.your.domain";		domain = "grafana.your.domain";

Line 21:		Line 23:
	# serve_from_sub_path = true;		# serve_from_sub_path = true;
	};		};

			# Prevents Grafana from phoning home
			#analytics.reporting_enabled = false;
	};		};
	};		};
	</syntaxhighlight>		</syntaxhighlight>

	[https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/ Grafana's documentation for the options in <code>settings</code>.]		[https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/ Read Grafana's documentation for the options in <code>settings</code>.]

	== Usage ==		== Usage ==

Dander: expand the deployment section

2024-10-22T21:56:29Z

expand the deployment section

@@ Line 25: / Line 25: @@
 </syntaxhighlight>
-This will make Grafana available only at localhost. On a server, it might be used through SSH tunnel or made publicly available using nginx with TLS. For example the follwing [[Nginx]] configuration can be used:
+[https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/ Grafana's documentation for the options in <code>settings</code>.]
 <syntaxhighlight lang=nix>
 services.nginx.virtualHosts."your.domain" = {
@@ Line 36: / Line 44: @@
    };
 };
 </syntaxhighlight>

Dander: simply explanation of setting up subpath / subdomain

2024-10-22T21:15:47Z

simply explanation of setting up subpath / subdomain

← Older revision		Revision as of 21:15, 22 October 2024
Line 7:		Line 7:
	Grafana is available as NixOS module, it can be enabled using the following config:		Grafana is available as NixOS module, it can be enabled using the following config:

	<syntaxhighlight lang=nix>		<syntaxhighlight lang="nix">
	services.grafana = {		services.grafana = {
	enable = true;		enable = true;
	settings = {		settings = {
	server = {		server = {
	~~# Listening Address~~
	http_addr = "127.0.0.1";		http_addr = "127.0.0.1";
	~~# and Port~~
	http_port = 3000;		http_port = 3000;
	# Grafana ~~needs to know on which domain and URL it's running~~		domain = "grafana.your.domain";
	domain = "your.domain";
	root_url = "https://your.domain/grafana/"; ~~# Not needed if it is `https://your.domain/`~~		# Alternatively, if you want to server Grafana from a subpath:
	serve_from_sub_path = true;		# domain = "your.domain";
			# root_url = "https://your.domain/grafana/";
			# serve_from_sub_path = true;
	};		};
	};		};

Klinger: Category:Server Category:Web Applications

2024-08-25T17:29:50Z

Category:Server Category:Web Applications

← Older revision		Revision as of 17:29, 25 August 2024
Line 97:		Line 97:
	* [https://grafana.com/ grafana.com]		* [https://grafana.com/ grafana.com]
	* [https://xeiaso.net/blog/prometheus-grafana-loki-nixos-2020-11-20 How to Setup Prometheus, Grafana and Loki on NixOS]		* [https://xeiaso.net/blog/prometheus-grafana-loki-nixos-2020-11-20 How to Setup Prometheus, Grafana and Loki on NixOS]

			[[Category:Server]]
			[[Category:Web Applications]]

Tboston: http:// is needed here

2024-08-24T14:56:24Z

http:// is needed here

← Older revision		Revision as of 14:56, 24 August 2024
Line 69:		Line 69:
	name = "Prometheus";		name = "Prometheus";
	type = "prometheus";		type = "prometheus";
	url = "${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";		url = "http://${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";
	}		}
	# Some plugins also can - c.f. https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/		# Some plugins also can - c.f. https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/

Pamplemousse at 16:39, 3 August 2024

2024-08-03T16:39:40Z

← Older revision		Revision as of 16:39, 3 August 2024
Line 52:		Line 52:
	=== Declarative configuration ===		=== Declarative configuration ===

	<syntaxhighlight lang=nix>		<syntaxhighlight lang="nix">
	services.grafana = {		services.grafana = {
	declarativePlugins = with pkgs.grafanaPlugins; [ ... ];		declarativePlugins = with pkgs.grafanaPlugins; [ ... ];
Line 65:		Line 65:

	datasources.settings.datasources = [		datasources.settings.datasources = [
	# "Built-in" datasources can be provisioned https://grafana.com/docs/grafana/latest/administration/provisioning/#data-sources		# "Built-in" datasources can be provisioned - c.f. https://grafana.com/docs/grafana/latest/administration/provisioning/#data-sources
	{		{
	name = "Prometheus";		name = "Prometheus";
Line 71:		Line 71:
	url = "${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";		url = "${config.services.prometheus.listenAddress}:${toString config.services.prometheus.port}";
	}		}
	# Some plugins also can https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/		# Some plugins also can - c.f. https://grafana.com/docs/plugins/yesoreyeram-infinity-datasource/latest/setup/provisioning/
	{		{
	name = "Infinity";		name = "Infinity";
	type = "yesoreyeram-infinity-datasource";		type = "yesoreyeram-infinity-datasource";
	}		}
	# But not all, c.f. https://github.com/fr-ser/grafana-sqlite-datasource/issues/141		# But not all - c.f. https://github.com/fr-ser/grafana-sqlite-datasource/issues/141
	];		];