Skip to content

Latest commit

 

History

History
158 lines (120 loc) · 7.69 KB

README.md

File metadata and controls

158 lines (120 loc) · 7.69 KB
Raw

Get Netdata

import { OneLineInstall } from '../src/components/OneLineInstall/' import { Install, InstallBox } from '../src/components/InstallBox/'

Netdata uses the open-source Netdata Agent and Netdata Cloud web application together to help you collect every metric, visualize the health of your nodes, and troubleshoot complex performance problems. Once you've signed in to Netdata Cloud and installed the Netdata Agent on all your nodes, you can claim your nodes and see their real-time metrics on a single interface.

Sign in to Netdata Cloud

If you don't already have a free Netdata Cloud account, go ahead and create one.

Choose your preferred authentication method and follow the onboarding process to create your Space.

Install the Netdata Agent

The Netdata Agent runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. It runs on Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no sudo required.

⚠️ Many distributions ship with third-party packages of Netdata, which we cannot maintain or keep up-to-date. For the best experience, use one of the methods described or linked to below.

The recommended way to install the Netdata Agent on a Linux system is our one-line kickstart script. This script automatically installs dependencies and builds Netdata from its source code.

Copy the script, paste it into your node's terminal, and hit Enter.

Open your favorite browser and navigate to http://localhost:19999 or http://REMOTE-HOST:19999 to open the dashboard.

Watch how the one-line installer works <iframe width="820" height="460" src="https://www.youtube.com/embed/tVIp7ycK60A" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Other operating systems/methods

Want to install Netdata on a Kubernetes cluster, with Docker, or using a different method? Not a Linux user? Choose your platform to see specific instructions.

Even more options available in our packaging documentation.

Claim your node on Netdata Cloud

You need to claim your nodes to see them in Netdata Cloud. Claiming establishes a secure TLS connection to Netdata Cloud using the Agent-Cloud link, and proves you have write and administrative access to that node.

When you view a node in Netdata Cloud, the Agent running on that node streams metrics, metadata, and alarm status to Netdata Cloud, which in turn streams those metrics to your web browser. Netdata Cloud does not store or log metrics values.

To claim a node, you need to run the claiming script. In Netdata Cloud, click on your Space's name, then Manage your Space in the dropdown. Click Nodes in the panel that appears. Copy the script and run it in your node's terminal. The script looks like the following, with long strings instead of TOKEN and ROOM1,ROOM2:

sudo netdata-claim.sh -token=TOKEN -rooms=ROOM1,ROOM2 -url=https://app.netdata.cloud

The script returns Agent was successfully claimed. after creating a new RSA pair and establishing the link to Netdata Cloud. If the script returns an error, try our troubleshooting tips.

💡 Our claiming reference guide also contains instructions for claiming Docker containers, Kubernetes cluster parent pods, via a proxy, and more.

Watch how claiming nodes works <iframe width="820" height="460" src="https://www.youtube.com/embed/UAzVvhMab8g" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

For more information on the claiming process, why we implemented it, and how it works, see the claim and Agent-Cloud link reference docs.

Troubleshooting

If you experience issues with installing the Netdata Agent, see our installation reference. Our reinstall doc can help clean up your installation and get you back to monitoring.

For Netdata Cloud issues, see the Netdata Cloud reference docs.

What's next?

At this point, you have set up your free Netdata Cloud account, installed the Netdata Agent on your node(s), and claimed one or more nodes to your Space. You're ready to start monitoring, visualizing, and troubleshooting with Netdata. We have two quickstart guides based on the scope of what you need to monitor.

Interested in monitoring a single node? Check out our single-node monitoring quickstart.

If you're looking to monitor an entire infrastructure with Netdata, see the infrastructure monitoring quickstart.

Or, skip ahead to Agent configuration.

Related reference documentation

analytics