summaryrefslogtreecommitdiffstats
path: root/debian/manpages/netdata.1
blob: 0ef572f60a93af95717a75b3110717d58f710931 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
.TH NETDATA 1 2021\-02\-07 1.29.0 "real\-time performance monitoring"

.SH NAME
\fBnetdata\fR \- real\-time performance monitoring

.SH SYNOPSIS
\fBnetdata\fR [\-c \fIOPTIONS\fR] [\-D|\-d] [\-P \fIFILENAME\fR] [\-i \fIIP\fR] [\-p \fIPORT\fR] [\-s \fIPATH\fR] [\-t \fISECONDS\fR] [\-u \fIUSERNAME\fR]
.PP
\fBnetdata\fR \-h
\fBnetdata\fR \-v|\-V

.SH DESCRIPTION
\fBnetdata\fR is distributed, real\-time, performance and health monitoring for
systems and applications. It provides insights of everything happening on the
systems it runs using interactive web dashboards.
.PP
It can run autonomously without any third party components or it can be
integrated to existing monitoring tool chains (Prometheus, Graphite,
OpenTSDB, Kafka, Grafana, etc).

.SH OPTIONS
The \fBnetdata\fR daemon is usually started by the systemd service,
the following options are available:

.IP "\-c \fIFILENAME\fR" 4
Configuration file to load.
.br
Default: /etc/netdata/netdata.conf.

.IP "\-D" 4
Do not fork. Run in the foreground.
.br
Default: run in the background

.IP "\-d" 4
Fork. Run in the background.
.br
Default: run in the background

.IP "\-h" 4
Display this help message.

.IP "\-P \fIFILENAME\fR" 4
File to save a pid while running.
.br
Default: do not save pid to a file

.IP "\-i \fIIP\fR" 4
The IP address to listen to.
.br
Default: all IP addresses IPv4 and IPv6

.IP "\-p \fIPORT\fR" 4
API/Web port to use.
.br
Default: 19999

.IP "\-s \fIPATH\fR" 4
Prefix for /proc and /sys (for containers).
.br
Default: no prefix

.IP "\-t \fISECONDS\fR" 4
The internal clock of netdata.
.br
Default: 1

.IP "\-u \fIUSERNAME\fR" 4
Run as user.
.br
Default: netdata

.IP "\-v, \-V" 4
Print netdata version and exit.

.IP "\-W \fIOPTIONS\fR" 4
See Advanced options below.

.SS ADVANCED OPTIONS

.IP "\-W stacksize=\fIN\fR" 4
Set the stacksize (in bytes).

.IP "\-W debug_flags=\fIN\fR" 4
Set runtime tracing to debug.log.

.IP "\-W unittest" 4
Run internal unittests and exit.

.IP "\-W createdataset=\fIN\fR" 4
Create a DB engine dataset of N seconds and exit.

.IP "\-W stresstest=\fIA\fR,\fIB\fR,\fIC\fR,\fID\fR,\fIE\fR,\fIF\fR" 4
Run a DB engine stress test for \fIA\fR seconds, with \fIB\fR writers and \fIC\fR readers, with a ramp up time of \fID\fR seconds for writers, a page cache size of \fIE\fR MiB, an optional disk space limit of \fIF\fR MiB and exit.

.IP "\-W set \fISECTION\fR \fIOPTION\fR \fIVALUE\fR" 4
Set netdata.conf option from the command line.

.IP "\-W simple\-pattern \fIPATTERN\fR \fISTRING\fR" 4
Check if string matches pattern and exit.

.IP "\-W 'claim -token=TOKEN -rooms=ROOM1,ROOM2'" 4
Claim the agent to the workspace rooms pointed to by TOKEN and ROOM*.

.SH SIGNALS

.IP "HUP" 4
Close and reopen log files.

.IP "USR1" 4
Save internal DB to disk.

.IP "USR2" 4
Reload health configuration.

.SH FILES
.IP "\fB/etc/netdata\fR" 4
Configuration file.
.IP "\fB/usr/share/doc/netdata" 4
Upstream documentation.

.SH HOMEPAGE
More information about netdata can be found on the homepage at <\fIhttps://my-netdata.io\fR> and in the manual at <\fIhttps://docs.netdata.cloud\fR>.

.SH AUTHOR
netdata was written by Costa Tsaousis <\fIcosta@tsaousis.gr\fR>.
.PP
This manual page was written by Federico Ceratto <\fIfederico@debian.org\fR> for the Debian project and may be used by others.