diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/get-started.mdx | 116 | ||||
| -rw-r--r-- | docs/getting-started/integrations.md | 12 | ||||
| -rw-r--r-- | docs/getting-started/introduction.md | 158 |
3 files changed, 239 insertions, 47 deletions
diff --git a/docs/get-started.mdx b/docs/get-started.mdx index 892baa0ce..aa82e811b 100644 --- a/docs/get-started.mdx +++ b/docs/get-started.mdx @@ -1,67 +1,96 @@ ---- -title: "Get started with Netdata" +<!-- +title: "Install Netdata" description: "Download and install the open-source Netdata monitoring agent on physical/virtual servers, Linux (Ubuntu/Debian/CentOS/etc), Docker, Kubernetes, and many others, often with one command." -type: how-to -sidebar_label: "Get started" -custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/get-started.mdx ---- - -import { OneLineInstallWget } from '@site/src/components/OneLineInstall/' -import { Install, InstallBox } from '@site/src/components/Install/' - -# Get started with Netdata +sidebar_label: "Install Netdata" +custom_edit_url: "https://github.com/netdata/netdata/edit/master/docs/get-started.mdx" +learn_status: "Published" +learn_topic_type: "Tasks" +learn_rel_path: "Getting started" +--> + +import { OneLineInstallWget, OneLineInstallCurl } from '@site/src/components/OneLineInstall/' +import { InstallRegexLink, InstallBoxRegexLink } from '@site/src/components/InstallRegexLink/' +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; Netdata is a free and open-source (FOSS) monitoring agent that collects thousands of hardware and software metrics from any physical or virtual system (we call them _nodes_). These metrics are organized in an easy-to-use and -navigate interface. -Together with [Netdata Cloud](https://learn.netdata.cloud/docs/cloud), you can monitor your entire infrastructure in +Together with [Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/cloud/cloud.mdx), you can monitor your entire infrastructure in real time and troubleshoot problems that threaten the health of your nodes. Netdata 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. +To install Netdata in minutes on your platform: + +1. Sign up to https://app.netdata.cloud/ +2. You will be presented with an empty space, and a prompt to "Connect Nodes" with the install command for each platform +3. Select the platform you want to install Netdata to, copy and paste the script into your node's terminal, and run it + +Upon installation completing successfully, you should be able to see the node live in your Netdata Space! + +Continue reading for more advanced instructions and installation options. + ## Install on Linux with one-line installer The **recommended** way to install Netdata on a Linux node (physical, virtual, container, IoT) is our one-line -[kickstart script](/packaging/installer/methods/kickstart.md). This script automatically installs dependencies and -builds Netdata from its source code. +[kickstart script](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kickstart.md). +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` to begin the installation process. +To install, copy the script, paste it into your node's terminal, and hit `Enter` to begin the installation process. -<OneLineInstallWget /> + <Tabs> + <TabItem value="wget" label=<code>wget</code>> + + <OneLineInstallWget/> + + </TabItem> + <TabItem value="curl" label=<code>curl</code>> + + <OneLineInstallCurl/> + + </TabItem> +</Tabs> + +:::note +If you plan to also Claim the node to Netdata Cloud, +make sure to replace `YOUR_CLAIM_TOKEN` with the claim token of your space, +and `YOUR_ROOM_ID` with the ID of the room you are willing to claim to. +::: Jump down to [what's next](#whats-next) to learn how to view your new dashboard and take your next steps monitoring and troubleshooting with Netdata. ## Other installation options -<Install> - <InstallBox - to="/docs/agent/packaging/docker" +<InstallRegexLink> + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md)" os="Run with Docker" svg="docker" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/kubernetes" + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md)" os="Deploy on Kubernetes" svg="kubernetes" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/macos" + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/macos.md)" os="Install on macOS" svg="macos" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/manual" + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/manual.md)" os="Linux from Git" svg="linux" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/source" + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md)" os="Linux from source" svg="linux" /> - <InstallBox - to="/docs/agent/packaging/installer/methods/offline" + <InstallBoxRegexLink + to="[](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/offline.md)" os="Linux for offline nodes" svg="linux" /> -</Install> +</InstallRegexLink> ## What's next? @@ -73,35 +102,28 @@ Where you go from here is based on your use case, immediate needs, and experienc ### Dashboard -Learn more about [how the dashboard works](/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways -to [interact with charts](/docs/dashboard/interact-charts.mdx). +Learn more about [how the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx), or dive directly into the many ways +to [interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx). ### Configuration -Discover the recommended way to [configure Netdata's settings or behavior](/docs/configure/nodes.md) using our built-in +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 `edit-config` script, then apply that knowledge to mission-critical tweaks, such as [changing how long Netdata stores -metrics](/docs/store/change-metrics-storage.md). +metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). ### Data collection If Netdata didn't autodetect all the hardware, containers, services, or applications running on your node, you should -learn more about [how data collectors work](/docs/collect/how-collectors-work.md). If there's a [supported -collector](/collectors/COLLECTORS.md) for metrics you need, [configure the collector](/docs/collect/enable-configure.md) +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 +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) or read about its requirements to configure your endpoint to publish metrics in the correct format and endpoint. ### Alarms & notifications Netdata comes with hundreds of preconfigured alarms, designed by our monitoring gurus in parallel with our open-source -community, but you may want to [edit alarms](/docs/monitor/configure-alarms.md) or [enable -notifications](/docs/monitor/enable-notifications.md) to customize your Netdata experience. - -### Need to monitor multiple nodes in one place? +community, but you may want to [edit alarms](https://github.com/netdata/netdata/blob/master/docs/monitor/configure-alarms.md) or +[enable notifications](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to customize your Netdata experience. -For robust multi-node monitoring from a single interface, consider [Netdata -Cloud](https://learn.netdata.cloud/docs/cloud), which streams, aggregates, and visualizes metrics from any number of -nodes. It's all the same out-of-the-box, zero-configuration functionality of the open-source monitoring agent, but for -any number of distributed nodes, _entirely for free_. +### Make your deployment production ready -There is an alternative for those who aren't interested in using Netdata Cloud, albeit with some required configuration. -Each node can [stream](/streaming/README.md) its metrics to any other node, and the default -[registry](/registry/README.md) is configurable to create a private "network" of Netdata dashboards. +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. diff --git a/docs/getting-started/integrations.md b/docs/getting-started/integrations.md new file mode 100644 index 000000000..9f38a67d0 --- /dev/null +++ b/docs/getting-started/integrations.md @@ -0,0 +1,12 @@ +<!-- +title: "Integrations" +sidebar_label: "Integrations" +custom_edit_url: null +learn_status: "Published" +learn_topic_type: "Getting started" +learn_rel_path: "Getting started" +learn_docs_purpose: "Present all the Netdata integrations" +learn_doc_type: "AUTOGENERATED" +--> + +This page is autogenerated, this is placeholder document
\ No newline at end of file diff --git a/docs/getting-started/introduction.md b/docs/getting-started/introduction.md new file mode 100644 index 000000000..1ace5e3a6 --- /dev/null +++ b/docs/getting-started/introduction.md @@ -0,0 +1,158 @@ +<!-- +title: "Introduction" +sidebar_label: "Introduction" +custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/getting-started/intro.md" +learn_status: "Published" +sidebar_position: "1" +learn_topic_type: "Getting started" +learn_rel_path: "Getting started" +learn_docs_purpose: "Present netdata in a nutshell" +--> + +## What is Netdata ? + +Netdata is designed by system administrators, DevOps engineers, and developers to collect everything, help you visualize +metrics, troubleshoot complex performance problems, and make data interoperable with the rest of your monitoring stack. + +You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container platforms (Kubernetes +clusters, Docker), and many other operating systems (FreeBSD). + +Netdata is: + +### Simple to deploy + +- **One-line deployment** for Linux distributions, plus support for Kubernetes/Docker infrastructures. +- **Zero configuration and maintenance** required to collect thousands of metrics, every second, from the underlying + OS and running applications. +- **Prebuilt charts and alarms** alert you to common anomalies and performance issues without manual configuration. +- **Distributed storage** to simplify the cost and complexity of storing metrics data from any number of nodes. + +### Powerful and scalable + +- **1% CPU utilization, a few MB of RAM, and minimal disk I/O** to run the monitoring Agent on bare metal, virtual + machines, containers, and even IoT devices. +- **Per-second granularity** for an unlimited number of metrics based on the hardware and applications you're running + on your nodes. +- **Interoperable exporters** let you connect Netdata's per-second metrics with an existing monitoring stack and other + time-series databases. + +### Optimized for troubleshooting + +- **Visual anomaly detection** with a UI/UX that emphasizes the relationships between charts. +- **Customizable dashboards** to pinpoint correlated metrics, respond to incidents, and help you streamline your + workflows. +- **Distributed metrics in a centralized interface** to assist users or teams trace complex issues between distributed + nodes. + +### Secure by design + +- **Distributed data architecture** so fast and efficient, there’s no limit to the number of metrics you can follow. +- Because your data is **stored at the edge**, security is ensured. +- +### Comparison with other monitoring solutions + +Netdata offers many benefits over the existing monitoring landscape, whether they're expensive SaaS products or other +open-source tools. + +| Netdata | Others (open-source and commercial) | +| :-------------------------------------------------------------- | :--------------------------------------------------------------- | +| **High resolution metrics** (1s granularity) | Low resolution metrics (10s granularity at best) | +| Collects **thousands of metrics per node** | Collects just a few metrics | +| Fast UI optimized for **anomaly detection** | UI is good for just an abstract view | +| **Long-term, autonomous storage** at one-second granularity | Centralized metrics in an expensive data lake at 10s granularity | +| **Meaningful presentation**, to help you understand the metrics | You have to know the metrics before you start | +| Install and get results **immediately** | Long sales process and complex installation process | +| Use it for **troubleshooting** performance problems | Only gathers _statistics of past performance_ | +| **Kills the console** for tracing performance issues | The console is always required for troubleshooting | +| Requires **zero dedicated resources** | Require large dedicated resources | + + +Netdata works with tons of applications, notifications platforms, and other time-series databases: + +- **300+ system, container, and application endpoints**: Collectors autodetect metrics from default endpoints and + immediately visualize them into meaningful charts designed for troubleshooting. See [everything we + support](https://github.com/netdata/netdata/blob/master/collectors/COLLECTORS.md). +- **20+ notification platforms**: Netdata's health watchdog sends warning and critical alarms to your [favorite + platform](https://github.com/netdata/netdata/blob/master/docs/monitor/enable-notifications.md) to inform you of anomalies just seconds + after they affect your node. +- **30+ external time-series databases**: Export resampled metrics as they're collected to other [local- and + Cloud-based databases](https://github.com/netdata/netdata/blob/master/docs/export/external-databases.md) for best-in-class + interoperability. + + +## How it works + +Netdata is a highly efficient, highly modular, metrics management engine. Its lockless design makes it ideal for concurrent operations on the metrics. + +You can see a high level representation in the following diagram. + + + +And a higher level diagram in this one. + + + +You can even visit this slightly dated [interactive infographic](https://my-netdata.io/infographic.html) and get lost in a rabbit hole. + +But the best way to get under the hood or in the steering wheel of our highly efficient, low-latency system (supporting multiple readers and one writer on each metric) is to read the rest of our docs, or just to jump in and [get started](app.netdata.com). But here's a good breakdown: + +### Netdata Agent + +Netdata's distributed monitoring Agent collects thousands of metrics from systems, hardware, and applications with zero configuration. It runs permanently on all your physical/virtual servers, containers, cloud deployments, and edge/IoT devices. + +You can install Netdata on most Linux distributions (Ubuntu, Debian, CentOS, and more), container/microservice platforms (Kubernetes clusters, Docker), and many other operating systems (FreeBSD, macOS), with no sudo required. + +### Netdata Cloud +Netdata Cloud is a web application that gives you real-time visibility for your entire infrastructure. With Netdata Cloud, you can view key metrics, insightful charts, and active alarms from all your nodes in a single web interface. When an anomaly strikes, seamlessly navigate to any node to troubleshoot and discover the root cause with the familiar Netdata dashboard. + +Netdata Cloud is free! You can add an entire infrastructure of nodes, invite all your colleagues, and visualize any number of metrics, charts, and alarms entirely for free. + +While Netdata Cloud offers a centralized method of monitoring your Agents, your metrics data is not stored or centralized in any way. Metrics data remains with your nodes and is only streamed to your browser, through Cloud, when you're viewing the Netdata Cloud interface. + + +## Community + +Netdata is an inclusive open-source project and community. Please read our [Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md). + +Find most of the Netdata team in our [community forums](https://community.netdata.cloud). It's the best place to +ask questions, find resources, and engage with passionate professionals. The team is also available and active in our [Discord](https://discord.com/invite/mPZ6WZKKG2) too. + +You can also find Netdata on: + +- [Twitter](https://twitter.com/linuxnetdata) +- [YouTube](https://www.youtube.com/c/Netdata) +- [Reddit](https://www.reddit.com/r/netdata/) +- [LinkedIn](https://www.linkedin.com/company/netdata-cloud/) +- [StackShare](https://stackshare.io/netdata) +- [Product Hunt](https://www.producthunt.com/posts/netdata-monitoring-agent/) +- [Repology](https://repology.org/metapackage/netdata/versions) +- [Facebook](https://www.facebook.com/linuxnetdata/) + +## Contribute + +Contributions are the lifeblood of open-source projects. While we continue to invest in and improve Netdata, we need help to democratize monitoring! + +- Read our [Contributing Guide](https://github.com/netdata/.github/blob/main/CONTRIBUTING.md), which contains all the information you need to contribute to Netdata, such as improving our documentation, engaging in the community, and developing new features. We've made it as frictionless as possible, but if you need help, just ping us on our community forums! +- We have a whole category dedicated to contributing and extending Netdata on our [community forums](https://community.netdata.cloud/c/agent-development/9) +- Found a bug? Open a [GitHub issue](https://github.com/netdata/netdata/issues/new?assignees=&labels=bug%2Cneeds+triage&template=BUG_REPORT.yml&title=%5BBug%5D%3A+). +- View our [Security Policy](https://github.com/netdata/netdata/security/policy). + +Package maintainers should read the guide on [building Netdata from source](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/source.md) for +instructions on building each Netdata component from source and preparing a package. + +## License + +The Netdata Agent is an open source project distributed under [GPLv3+](https://github.com/netdata/netdata/blob/master/LICENSE). Netdata re-distributes other open-source tools and libraries. Please check the +[third party licenses](https://github.com/netdata/netdata/blob/master/REDISTRIBUTED.md). + +## Is it any good? + +Yes. + +_When people first hear about a new product, they frequently ask if it is any good. A Hacker News user +[remarked](https://news.ycombinator.com/item?id=3067434):_ + +> Note to self: Starting immediately, all raganwald projects will have a “Is it any good?” section in the readme, and +> the answer shall be “yes.". +******************************************************************************* |