5521e5be7 · cryptotaxi247/netdata-1

@@ -13,6 +13,8 @@ import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/Inst

13 import Tabs from '@theme/Tabs';

14 import TabItem from '@theme/TabItem';

15

16 +## Get started

17 +

18 Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from

19 any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface.

20

@@ -29,9 +31,44 @@ To install Netdata in minutes on your platform:

31 2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform

32 3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it

33

32 -Upon installation completing successfully, you should be able to see the node live in your Netdata Space!

34 +Upon installation completing successfully, you should be able to see the node live in your Netdata Space and live charts in the Overview tab. [Read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).

35 +

36 +Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting,

37 +but we have some hints on what you might want to do next.

38 +

39 +### What's next?

40 +

41 +Explore our [general advanced installation options and troubleshooting](#advanced-installation-options-and-troubleshooting), specific options for the [single line installer](#install-on-linux-with-one-line-installer), or [other installation methods](#other-installation-methods).

42 +

43 +#### Agent user interface

44 +

45 +To access the UI provided by the locally installed agent, open a browser and navigate to `http://NODE:19999`, replacing `NODE` with either `localhost` or

46 +the hostname/IP address of the remote node. You can also read more about [how the agent dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways

47 +to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).

48 +

49 +#### Configuration

50 +

51 +Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in

52 +`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores

53 +metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).

54 +

55 +#### Data collection

56 +

57 +If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should

58 +learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md). If there's a [supported

59 +collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)

60 +or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.

61 +

62 +#### Alarms & notifications

63 +

64 +Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source

65 +community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or

66 +[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.

67 +

68 +#### Make your deployment production ready

69 +

70 +Both [securing Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) and [setting up replication](https://github.com/netdata/netdata/blob/master/streaming/README.md) are strongly recommended.

71

34 -Continue reading for more advanced instructions and installation options.

72

73 ## Install on Linux with one-line installer

74

@@ -64,7 +101,7 @@ You can leave the room id blank to have your node claimed to the default "All no

101 Jump down to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps monitoring and

102 troubleshooting with Netdata.

103

67 -## Other installation options

104 +## Other installation methods

105

106 <InstallRegexLink>

107 <InstallBoxRegexLink

@@ -93,36 +130,129 @@ troubleshooting with Netdata.

130 svg="linux" />

131 </InstallRegexLink>

132

133 +- [Run with Docker](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)

134 +- [Deploy on Kubernetes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)

135 +- [Install on macOS](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)

136 +- [Linux from Git](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)

137 +- [Linux from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)

138 +- [Linux for offline nodes](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)

139

97 -## What's next?

140 +## Advanced installation options and troubleshooting

141

99 -If you opted to use Netdata Cloud, you will immediately see your node connected and live charts in the Overview tab. You can also [read more about the cloud features](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx).

142 +### Automatic updates

143

101 -To access the UI provided by the locally installed agent, open a browser and navigate to `http://NODE:19999`, replacing `NODE` with either `localhost` or

102 -the hostname/IP address of the remote node. You can also read more about [how the agent dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways

103 -to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx).

144 +By default, Netdata's installation scripts enable automatic updates for both nightly and stable release channels.

145

105 -Where you go from here is based on your use case, immediate needs, and experience with monitoring and troubleshooting.

146 +If you would prefer to update your Netdata agent manually, you can disable automatic updates by using the `--no-updates`

147 +option when you install or update Netdata using the [automatic one-line installation

148 +script](#automatic-one-line-installation-script).

149

107 -### Configuration

150 +```bash

151 +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --no-updates

152 +```

153

109 -Discover the recommended way to [configure Netdata's settings or behavior](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) using our built-in

110 -`edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores

111 -metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md).

154 +With automatic updates disabled, you can choose exactly when and how you [update

155 +Netdata](https://github.com/netdata/netdata/blob/master/packaging/installer/UPDATE.md).

156

113 -### Data collection

157 +#### Network usage of Netdata’s automatic updater

158

115 -If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should

116 -learn more about [how data collectors work](https://github.com/netdata/netdata/blob/master/docs/collect/how-collectors-work.md). If there's a [supported

117 -collector](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md) for metrics you need, [configure the collector](https://github.com/netdata/netdata/blob/master/docs/collect/enable-configure.md)

118 -or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint.

159 +The auto-update functionality set up by the installation scripts requires working internet access to function

160 +correctly. In particular, it currently requires access to GitHub (to check if a newer version of the updater script

161 +is available or not, as well as potentially fetching build-time dependencies that are bundled as part of the install),

162 +and Google Cloud Storage (to check for newer versions of Netdata and download the sources if there is a newer version).

163

120 -### Alarms & notifications

164 +Note that the auto-update functionality will check for updates to itself independently of updates to Netdata,

165 +and will try to use the latest version of the updater script whenever possible. This is intended to reduce the

166 +amount of effort required by users to get updates working again in the event of a bug in the updater code.

167

122 -Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source

123 -community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or

124 -[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience.

168 +### Nightly vs. stable releases

169 +

170 +The Netdata team maintains two releases of the Netdata agent: **nightly** and **stable**. By default, Netdata's

171 +installation scripts will give you **automatic, nightly** updates, as that is our recommended configuration.

172 +

173 +**Nightly**: We create nightly builds every 24 hours. They contain fully-tested code that fixes bugs or security flaws,

174 +or introduces new features to Netdata. Every nightly release is a candidate for then becoming a stable release—when

175 +we're ready, we simply change the release tags on GitHub. That means nightly releases are stable and proven to function

176 +correctly in the vast majority of Netdata use cases. That's why nightly is the _best choice for most Netdata users_.

177 +

178 +**Stable**: We create stable releases whenever we believe the code has reached a major milestone. Most often, stable

179 +releases correlate with the introduction of new, significant features. Stable releases might be a better choice for

180 +those who run Netdata in _mission-critical production systems_, as updates will come more infrequently, and only after

181 +the community helps fix any bugs that might have been introduced in previous releases.

182 +

183 +**Pros of using nightly releases:**

184 +

185 +- Get the latest features and bug fixes as soon as they're available

186 +- Receive security-related fixes immediately

187 +- Use stable, fully-tested code that's always improving

188 +- Leverage the same Netdata experience our community is using

189 +

190 +**Pros of using stable releases:**

191 +

192 +- Protect yourself from the rare instance when major bugs slip through our testing and negatively affect a Netdata

193 + installation

194 +- Retain more control over the Netdata version you use

195 +

196 +### Anonymous statistics

197 +

198 +Starting with v1.30, Netdata collects anonymous usage information by default and sends it to a self-hosted PostHog instance within the Netdata infrastructure. Read about the information collected, and learn how to-opt, on our [anonymous statistics](https://github.com/netdata/netdata/blob/master/docs/anonymous-statistics.md) page.

199 +

200 +The usage statistics are _vital_ for us, as we use them to discover bugs and prioritize new features. We thank you for

201 +_actively_ contributing to Netdata's future.

202 +

203 +### Troubleshooting and known issues

204 +

205 +We are tracking a few issues related to installation and packaging.

206 +

207 +#### Older distributions (Ubuntu 14.04, Debian 8, CentOS 6) and OpenSSL

208 +

209 +If you're running an older Linux distribution or one that has reached EOL, such as Ubuntu 14.04 LTS, Debian 8, or CentOS

210 +6, your Agent may not be able to securely connect to Netdata Cloud due to an outdated version of OpenSSL. These old

211 +versions of OpenSSL cannot perform [hostname validation](https://wiki.openssl.org/index.php/Hostname_validation), which

212 +helps securely encrypt SSL connections.

213 +

214 +If you choose to continue using the outdated version of OpenSSL, your node will still connect to Netdata Cloud, albeit

215 +with hostname verification disabled. Without verification, your Netdata Cloud connection could be vulnerable to

216 +man-in-the-middle attacks.

217 +

218 +#### CentOS 6 and CentOS 8

219 +

220 +To install the Agent on certain CentOS and RHEL systems, you must enable non-default repositories, such as EPEL or

221 +PowerTools, to gather hard dependencies. See the [CentOS 6](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#centos--rhel-6x) and

222 +[CentOS 8](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#centos--rhel-8x) sections for more information.

223 +

224 +#### Access to file is not permitted

225 +

226 +If you see an error similar to `Access to file is not permitted: /usr/share/netdata/web//index.html` when you try to

227 +visit the Agent dashboard at `http://NODE:19999`, you need to update Netdata's permissions to match those of your

228 +system.

229 +

230 +Run `ls -la /usr/share/netdata/web/index.html` to find the file's permissions. You may need to change this path based on

231 +the error you're seeing in your browser. In the below example, the file is owned by the user `root` and the group

232 +`root`.

233 +

234 +```bash

235 +ls -la /usr/share/netdata/web/index.html

236 +-rw-r--r--. 1 root root 89377 May 5 06:30 /usr/share/netdata/web/index.html

237 +```

238 +

239 +These files need to have the same user and group used to install your netdata. Suppose you installed netdata with user

240 +`netdata` and group `netdata`, in this scenario you will need to run the following command to fix the error:

241 +

242 +```bash

243 +# chown -R netdata.netdata /usr/share/netdata/web

244 +```

245 +

246 +#### Multiple versions of OpenSSL

247 +

248 +We've received reports from the community about issues with running the `kickstart.sh` script on systems that have both

249 +a distribution-installed version of OpenSSL and a manually-installed local version. The Agent's installer cannot handle

250 +both.

251 +

252 +#### Clang compiler on Linux

253 +

254 +Our current build process has some issues when using certain configurations of the `clang` C compiler on Linux. See [the

255 +section on `nonrepresentable section on output`

256 +errors](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md#nonrepresentable-section-on-output-errors) for a workaround.

257

126 -### Make your deployment production ready

258

128 -Both [securing Netdata](https://github.com/netdata/netdata/blob/master/docs/configure/secure-nodes.md) and [setting up replication](https://github.com/netdata/netdata/blob/master/streaming/README.md) are strongly recommended.

Add contents of packaging/installer/readme.md (#14461)