56 |
56 |
57 |
57 |
58 ### Netdata |
58 ### Netdata |
59 |
59 |
60 You'll likely want to pare down what netdata is sending. Here's an |
60 You'll likely want to pare down what netdata is sending. Here's an |
61 example configuration for `netdata.conf` -- season this to taste (what |
61 example configuration for `exporting.conf` -- season this to taste (what |
62 charts to send and frequency.) |
62 charts to send and frequency.) |
63 |
63 |
|
64 Note: This example uses the "exporting" module introduced in |
|
65 Netdata v1.23. If your netdata is older than that, you'll be using |
|
66 the deprecated "backend" instead in the main `netdata.conf` file. |
|
67 |
64 ``` |
68 ``` |
65 [backend] |
69 [exporting:global] |
66 hostname = your-hostname |
70 enabled = yes |
67 enabled = yes |
71 |
68 type = json |
72 [json:timescale] |
69 data source = average |
73 hostname = your-hostname |
70 destination = machine-where-netdata-tsrelay-lives:14866 |
74 enabled = yes |
71 prefix = n |
75 data source = average |
72 update every = 60 |
76 destination = localhost:14866 |
73 buffer on failures = 5 |
77 prefix = netdata |
74 send charts matching = !cpu.cpu* !ipv6* !users* nfs.rpc net.* net_drops.* net_packets.* !system.interrupts* system.* disk.* disk_space.* disk_ops.* mem.* |
78 update every = 10 |
|
79 buffer on failures = 10 |
|
80 send charts matching = !cpu.cpu* !ipv6* !users.* nfs.rpc net.* net_drops.* net_packets.* !system.interrupts* system.* disk.* disk_space.* disk_ops.* mem.* |
75 ``` |
81 ``` |
76 |
82 |
77 |
83 |
78 Running the Relay |
84 Running the Relay |
79 ----------------- |
85 ----------------- |
80 |
86 |
81 ### Options |
87 ### Options |
82 |
88 |
83 * [-q|--quiet]: Quiet mode. No output at all. Ignored if -d is supplied. |
89 * [-q|--quiet]: Quiet mode. No output at all. Ignored if -d is supplied. |
84 * [-d|--debug]: Debug mode. Show incoming data. |
90 * [-d|--debug]: Debug mode. Show incoming data. |
85 * [--dbopts]: PostgreSQL connection information. (See below for more details.) |
91 * [-D|--dropconn]: Drop the TCP connection to netdata between samples. |
|
92 This may be more efficient depending on your environment and |
|
93 number of clients. Defaults to false. |
|
94 * [-o|--dbopts]: PostgreSQL connection information. (See below for more details.) |
86 * [-h|--help]: Display quick help text. |
95 * [-h|--help]: Display quick help text. |
87 * [--listen-addr]: A specific IP address to listen on. Defaults to **INADDR_ANY**. |
96 * [-a|--listen-addr]: A specific IP address to listen on. Defaults to **INADDR_ANY**. |
88 * [--listen-port]: The port to listen for netdata JSON streams. |
97 * [-p|--listen-port]: The port to listen for netdata JSON streams. |
89 Default is **14866**. |
98 Default is **14866**. |
|
99 * [-P|--persistent]: Don't disconnect from the database between samples. This may be |
|
100 more efficient with a small number of clients, when not using a |
|
101 pooler, or with a very high sample size/rate. Defaults to false. |
90 * [-T|--dbtable]: Change the table name to insert to. Defaults to **netdata**. |
102 * [-T|--dbtable]: Change the table name to insert to. Defaults to **netdata**. |
91 * [-t|--timeout]: Maximum time in milliseconds to wait for data. Slow |
103 * [-t|--timeout]: Maximum time in milliseconds to wait for data. Slow |
92 connections may need to increase this from the default **500** ms. |
104 connections may need to increase this from the default **500** ms. |
93 * [-v|--version]: Show version. |
105 * [-v|--version]: Show version. |
|
106 |
94 |
107 |
95 |
108 |
96 **Notes** |
109 **Notes** |
97 |
110 |
98 Nim option parsing might be slightly different than what you're used to. |
111 Nim option parsing might be slightly different than what you're used to. |
110 "host=localhost dbname=netdata application_name=netdata-tsrelay" |
123 "host=localhost dbname=netdata application_name=netdata-tsrelay" |
111 |
124 |
112 ... which uses the default PostgreSQL port, and connects as the running |
125 ... which uses the default PostgreSQL port, and connects as the running |
113 user. |
126 user. |
114 |
127 |
115 Reference the [PostgreSQL |
128 Reference the [PostgreSQL Documentation](https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS) |
116 Documentation](https://www.postgresql.org/docs/current/static/libpq-conn |
129 for all available options (including how to store passwords in a |
117 ect.html#LIBPQ-PARAMKEYWORDS) for all available options (including how |
130 separate file, enable SSL mode, etc.) |
118 to store passwords in a separate file, enable SSL mode, etc.) |
|
119 |
131 |
120 |
132 |
121 ### Daemonizing |
133 ### Daemonizing |
122 |
134 |
123 Use a tool of your choice to run this at system |
135 Use a tool of your choice to run this at system |