Netdata - Revision history

DoggoBit: /* Tips and Tricks */

2025-06-05T20:07:07Z

Tips and Tricks

← Older revision		Revision as of 20:07, 5 June 2025
Line 117:		Line 117:
	==== Modern Web UI ====		==== Modern Web UI ====

	{{~~Unfree~~}}		{{tip/unfree}}

	Netdata comes with an old, unmaintained but open source web UI that is accessible at port <code>19999</code>. Netdata Inc. will not fix any bugs in the old UI and it may to become more and more broken as time goes on. There is however, a newer, maintained but proprietary web UI that can be optionally enabled to replace the old UI. To use this new UI, override Netdata's package:		Netdata comes with an old, unmaintained but open source web UI that is accessible at port <code>19999</code>. Netdata Inc. will not fix any bugs in the old UI and it may to become more and more broken as time goes on. There is however, a newer, maintained but proprietary web UI that can be optionally enabled to replace the old UI. To use this new UI, override Netdata's package:
Line 138:		Line 138:
	==== nvidia-smi ====		==== nvidia-smi ====

	{{~~Unfree~~}}		{{tip/unfree}}

	To enable the <code>nvidia-smi</code> plugin, you have to ensure that <code>nvidia-smi</code> can be called by <code>netdata</code>:		To enable the <code>nvidia-smi</code> plugin, you have to ensure that <code>nvidia-smi</code> can be called by <code>netdata</code>:

Tennox: update docs for claiming

2025-04-06T09:43:55Z

update docs for claiming

← Older revision		Revision as of 09:43, 6 April 2025
Line 31:		Line 31:
	You may wish to aggregate multiple machines' Netdata information, in which case, you can subscribe to the Netdata Cloud service, or you can self-host [[Prometheus]] and [[Grafana]] as a self-hosted solution.		You may wish to aggregate multiple machines' Netdata information, in which case, you can subscribe to the Netdata Cloud service, or you can self-host [[Prometheus]] and [[Grafana]] as a self-hosted solution.

	==== Adding node ====		==== Adding node to cloud ====
	* Enable the Netdata service as described above.		* Enable the Netdata service as described above.
			* override package to be built `withCloud`
	* When adding a new node in the web interface, you get a token; copy that token to <code>/var/lib/netdata/cloud.d/token</code>.		* When adding a new node in the web interface, you get a token; copy that token to <code>/var/lib/netdata/cloud.d/token</code>.
	* As root, run the <code>netdata-claim.sh</code> script.		* As root, run the <code>netdata-claim.sh</code> script.
	{{Commands\|# nix-shell -p netdata --run "netdata-claim.sh"}}		{{Commands\|# nix-shell -p netdata --run "netdata-claim.sh"}}

			====== Declare claim token ([https://search.nixos.org/options?show=services.netdata.claimTokenFile option docs]) ======
			<syntaxhighlight lang="nixos">
			services.netdata = {
			package = pkgs.netdata.override { withCloud = true; };
			claimTokenFile = config.sops.secrets.netdata-token.path; # mounted by sops-nix, in this example
			};
			</syntaxhighlight>

	=== Streaming node setup ===		=== Streaming node setup ===

SigmaSquadron: Sync changes from nixos.wiki and re-format to fit the MoS.

2024-10-30T14:14:18Z

Sync changes from nixos.wiki and re-format to fit the MoS.

Show changes

Jhakonen: Add instructions how to take newer web UI into use

2024-08-01T17:41:51Z

Add instructions how to take newer web UI into use

← Older revision		Revision as of 17:41, 1 August 2024
Line 8:		Line 8:
	*When adding new node in the web interface you get a token, write that token to /var/lib/netdata/cloud.d/token		*When adding new node in the web interface you get a token, write that token to /var/lib/netdata/cloud.d/token
	*As root run <code>nix-shell -p netdata --run "netdata-claim.sh"</code>		*As root run <code>nix-shell -p netdata --run "netdata-claim.sh"</code>

			== Newer web UI ==
			Netdata comes with an old unmaintained web UI that is accesible at port <code>19999</code>. Netdata Inc. will not fix any bugs in the old UI and it may to become more and more broken as time goes on. There is, however, a newer maintained, but unfree proprietary web UI that can be optionally enabled to replace the old UI. To take it into use, override netdata's package:<syntaxhighlight lang="nix">
			services.netdata.package = pkgs.netdata.override {
			withCloudUi = true;
			};
			</syntaxhighlight>In addition, you need to allow unfree packages.

	== Streaming node setup ==		== Streaming node setup ==

imported>Beardedtek: /* samba */ replace html code " with "

2023-08-15T21:44:39Z

samba: replace html code " with "

← Older revision		Revision as of 21:44, 15 August 2023
Line 84:		Line 84:

	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	services.netdata.configDir.~~"~~python.d.conf~~"~~ = pkgs.writeText ~~"~~python.d.conf~~"~~ ''		services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''
	samba: yes		samba: yes
	'';		'';

	# add samba and sudo to path of python plugin		# add samba and sudo to path of python plugin
	systemd.services.netdata.path = [ pkgs.samba ~~"~~/run/wrappers~~"~~ ];		systemd.services.netdata.path = [ pkgs.samba "/run/wrappers" ];

	# permit to run sudo smbstatus -P		# permit to run sudo smbstatus -P
Line 98:		Line 98:
	# as documented here : https://github.com/netdata/netdata/blob/master/system/netdata.service.in		# as documented here : https://github.com/netdata/netdata/blob/master/system/netdata.service.in
	# review capabilityset above if other plugins are non functional		# review capabilityset above if other plugins are non functional
	systemd.services.netdata.serviceConfig.CapabilityBoundingSet = [~~"~~CAP_SETGID~~"~~];		systemd.services.netdata.serviceConfig.CapabilityBoundingSet = ["CAP_SETGID"];

	# enable profiling		# enable profiling

imported>Beardedtek: /* nvidia-smi */ edit quotes to not include html code

2023-08-15T21:42:36Z

nvidia-smi: edit quotes to not include html code

← Older revision		Revision as of 21:42, 15 August 2023
Line 74:		Line 74:
	systemd.services.enable = true;		systemd.services.enable = true;
	systemd.services.netdata.path = [pkgs.linuxPackages.nvidia_x11];		systemd.services.netdata.path = [pkgs.linuxPackages.nvidia_x11];
	services.netdata.configDir.~~"~~python.d.conf~~"~~ = pkgs.writeText ~~"~~python.d.conf~~"~~ ''		services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''
	nvidia_smi: yes		nvidia_smi: yes
	'';		'';
	</syntaxhighlight>		</syntaxhighlight>

	== samba ==		== samba ==

imported>Ncfavier: add syntax highlighting

2023-07-27T18:21:38Z

add syntax highlighting

← Older revision		Revision as of 18:21, 27 July 2023
Line 15:		Line 15:
	=== Receiver node ===		=== Receiver node ===

	<~~pre~~>		<syntaxhighlight lang="nix">
	services.netdata.configDir."stream.conf" =		services.netdata.configDir."stream.conf" =
	let		let
	mkChildNode = apiKey: allowFrom: ''		mkChildNode = apiKey: allowFrom: ''
	[${apiKey}]		[${apiKey}]
	enabled = yes		enabled = yes
	default history = <a value of your choice>		default history = <a value of your choice>
	default memory mode = dbengine # a good default		default memory mode = dbengine # a good default
	health enabled by default = auto		health enabled by default = auto
	allow from = ${allowFrom}		allow from = ${allowFrom}
	'';		'';
	in pkgs.writeText "stream.conf" ''		in pkgs.writeText "stream.conf" ''
	[stream]		[stream]
	# This won't stream by itself, except if the receiver is a sender too, which is possible in netdata model.		# This won't stream by itself, except if the receiver is a sender too, which is possible in netdata model.
	enabled = no		enabled = no
	enable compression = yes		enable compression = yes

	# An allowed sender node		# An allowed sender node
	${mkChildNode "an API key" "an allowed IP"}		${mkChildNode "an API key" "an allowed IP"}
	'';		'';
	</~~pre~~>		</syntaxhighlight>

	=== Sender node ===		=== Sender node ===

	<~~pre~~>		<syntaxhighlight lang="nix">
	services.netdata.configDir."stream.conf" = pkgs.writeText "stream.conf" ''		services.netdata.configDir."stream.conf" = pkgs.writeText "stream.conf" ''
	[stream]		[stream]
	enabled = yes		enabled = yes
	destination = receiver-hostname-or-ip-address:19999		destination = receiver-hostname-or-ip-address:19999
	api key = any string that is set also on the receiver side		api key = any string that is set also on the receiver side
	'';		'';
	</~~pre~~>		</syntaxhighlight>

	If you don't need any web UI and want to consume minimal resources on the sender node, use:		If you don't need any web UI and want to consume minimal resources on the sender node, use:

	<~~pre~~>		<syntaxhighlight lang="nix">
	services.netdata = {		services.netdata = {
	config = {		config = {
	global = { "memory mode" = "none"; };		global = { "memory mode" = "none"; };
	web = {		web = {
	mode = "none";		mode = "none";
	"accept a streaming request every seconds" = 0;		"accept a streaming request every seconds" = 0;
	};
	};		};
	};		};
	</~~pre~~>		};
			</syntaxhighlight>

	This way, it won't spawn any web UI, neither store any metric locally.		This way, it won't spawn any web UI, neither store any metric locally.
Line 71:		Line 71:
	To enable the <code>nvidia-smi</code> plugin you have to make sure <code>nvidia-smi</code> can be called by <code>netdata</code>.		To enable the <code>nvidia-smi</code> plugin you have to make sure <code>nvidia-smi</code> can be called by <code>netdata</code>.

	<~~pre~~>systemd.services.enable = true;		<syntaxhighlight lang="nix">
			systemd.services.enable = true;
	systemd.services.netdata.path = [pkgs.linuxPackages.nvidia_x11];		systemd.services.netdata.path = [pkgs.linuxPackages.nvidia_x11];
	services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''		services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''
	nvidia_smi: yes		nvidia_smi: yes
	'';</~~pre~~>		'';
			</syntaxhighlight>
	== samba ==		== samba ==

	To enable <code>samba</code> plugin additional permissions and configurations will need to be set.		To enable <code>samba</code> plugin additional permissions and configurations will need to be set.

	<~~pre~~>		<syntaxhighlight lang="nix">
	services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''		services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''
	samba: yes		samba: yes
Line 99:		Line 101:
	# enable profiling		# enable profiling
	services.samba.extraConfig = ''		services.samba.extraConfig = ''
	smbd profiling level = on		smbd profiling level = on
	'';		'';
	</~~pre~~>		</syntaxhighlight>

imported>RaitoBezarius: explain how to do streaming node setups

2023-07-27T15:06:00Z

explain how to do streaming node setups

← Older revision		Revision as of 15:06, 27 July 2023
Line 9:		Line 9:
	*As root run <code>nix-shell -p netdata --run "netdata-claim.sh"</code>		*As root run <code>nix-shell -p netdata --run "netdata-claim.sh"</code>

			== Streaming node setup ==

			Ensure you choose appropriate access control for your nodes.

			=== Receiver node ===

			<pre>
			services.netdata.configDir."stream.conf" =
			let
			mkChildNode = apiKey: allowFrom: ''
			[${apiKey}]
			enabled = yes
			default history = <a value of your choice>
			default memory mode = dbengine # a good default
			health enabled by default = auto
			allow from = ${allowFrom}
			'';
			in pkgs.writeText "stream.conf" ''
			[stream]
			# This won't stream by itself, except if the receiver is a sender too, which is possible in netdata model.
			enabled = no
			enable compression = yes

			# An allowed sender node
			${mkChildNode "an API key" "an allowed IP"}
			'';
			</pre>

			=== Sender node ===

			<pre>
			services.netdata.configDir."stream.conf" = pkgs.writeText "stream.conf" ''
			[stream]
			enabled = yes
			destination = receiver-hostname-or-ip-address:19999
			api key = any string that is set also on the receiver side
			'';
			</pre>

			If you don't need any web UI and want to consume minimal resources on the sender node, use:

			<pre>
			services.netdata = {
			config = {
			global = { "memory mode" = "none"; };
			web = {
			mode = "none";
			"accept a streaming request every seconds" = 0;
			};
			};
			};
			</pre>

			This way, it won't spawn any web UI, neither store any metric locally.

	<span id="python-plugins"></span>		<span id="python-plugins"></span>

imported>Hurricanehrndz at 15:55, 8 November 2022

2022-11-08T15:55:53Z

← Older revision		Revision as of 15:55, 8 November 2022
Line 41:		Line 41:
	# as documented here : https://github.com/netdata/netdata/blob/master/system/netdata.service.in		# as documented here : https://github.com/netdata/netdata/blob/master/system/netdata.service.in
	# review capabilityset above if other plugins are non functional		# review capabilityset above if other plugins are non functional
	systemd.services.netdata.serviceConfig.CapabilityBoundingSet = ["CAP_SETGID"];~~</pre>~~		systemd.services.netdata.serviceConfig.CapabilityBoundingSet = ["CAP_SETGID"];

	# enable profiling		# enable profiling
Line 47:		Line 47:
	smbd profiling level = on		smbd profiling level = on
	'';		'';
			</pre>

imported>Hurricanehrndz at 15:54, 8 November 2022

2022-11-08T15:54:35Z

← Older revision		Revision as of 15:54, 8 November 2022
Line 24:		Line 24:
	== samba ==		== samba ==

	To enable <code>samba</code> plugin ~~a lot of things~~ need to be ~~done~~.		To enable <code>samba</code> plugin additional permissions and configurations will need to be set.

	~~<blockquote>Still I could not make samba to work, because systemd services seem to be forbidden to run sudo. Please update if you are able to make it work.~~		<pre>
	~~</blockquote>~~
	<pre>~~systemd.services.enable = true;~~
	services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''		services.netdata.configDir."python.d.conf" = pkgs.writeText "python.d.conf" ''
	samba: yes		samba: yes
Line 34:		Line 32:

	# add samba and sudo to path of python plugin		# add samba and sudo to path of python plugin
	systemd.services.netdata.path = [ ~~pkgs.sudo~~ pkgs.samba ];		systemd.services.netdata.path = [ pkgs.samba "/run/wrappers" ];

	# permit to run sudo smbstatus -P		# permit to run sudo smbstatus -P
Line 40:		Line 38:
	netdata ALL=(root) NOPASSWD: ${pkgs.samba}/bin/smbstatus		netdata ALL=(root) NOPASSWD: ${pkgs.samba}/bin/smbstatus
	'';		'';
	# as documented here : https://~~learn~~.netdata~~.cloud~~/~~docs~~/~~agent~~/~~collectors~~/~~python~~.d.~~plugin/samba~~
	# ~~but seem not to work~~		# as documented here : https://github.com/netdata/netdata/blob/master/system/netdata.service.in
	systemd.services.netdata.serviceConfig.CapabilityBoundingSet = ["~"];</pre>		# review capabilityset above if other plugins are non functional
			systemd.services.netdata.serviceConfig.CapabilityBoundingSet = ["CAP_SETGID"];</pre>

			# enable profiling
			services.samba.extraConfig = ''
			smbd profiling level = on
			'';