diff options
-rw-r--r-- | README.md | 4 | ||||
-rw-r--r-- | claim/README.md | 14 | ||||
-rw-r--r-- | docs/guides/export/export-netdata-metrics-graphite.md | 2 | ||||
-rw-r--r-- | docs/guides/monitor/lamp-stack.md | 2 | ||||
-rw-r--r-- | docs/guides/monitor/pi-hole-raspberry-pi.md | 2 | ||||
-rw-r--r-- | docs/guides/step-by-step/step-00.md | 14 | ||||
-rw-r--r-- | docs/guides/step-by-step/step-09.md | 4 | ||||
-rw-r--r-- | exporting/WALKTHROUGH.md | 3 | ||||
-rw-r--r-- | exporting/prometheus/README.md | 23 | ||||
-rw-r--r-- | packaging/installer/methods/kickstart.md | 7 | ||||
-rw-r--r-- | packaging/installer/methods/macos.md | 113 | ||||
-rw-r--r-- | packaging/installer/methods/source.md | 55 | ||||
-rw-r--r-- | web/api/exporters/prometheus/README.md | 6 |
13 files changed, 103 insertions, 146 deletions
@@ -120,9 +120,9 @@ and builds all dependencies, including those required to connect to [Netdata Clo choose, and enables [automatic nightly updates](https://learn.netdata.cloud/docs/agent/packaging/installer#nightly-vs-stable-releases) and [anonymous statistics](https://learn.netdata.cloud/docs/agent/anonymous-statistics). - +<!-- candidate for reuse --> ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` To view the Netdata dashboard, navigate to `http://localhost:19999`, or `http://NODE:19999`. diff --git a/claim/README.md b/claim/README.md index 3666d1eca4..30f5a85f12 100644 --- a/claim/README.md +++ b/claim/README.md @@ -73,7 +73,7 @@ When coming from [Nodes view page](https://learn.netdata.cloud/docs/cloud/visua If you want to connect a node that is running on a Linux environment, the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to: ``` -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud ``` The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting). @@ -101,7 +101,7 @@ The default user is `netdata`. Yours may be different, so pay attention to the o and run the script. ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud ``` ### Connect an agent running in Docker @@ -227,7 +227,7 @@ you don't see the node in your Space after 60 seconds, see the [troubleshooting To connect a node that is running on a macOS environment the script that will be provided to you by Netdata Cloud is the [kickstart](/packaging/installer/methods/macos.md#install-netdata-with-our-automatic-one-line-installation-script) which will install the Netdata Agent on your node, if it isn't already installed, and connect the node to Netdata Cloud. It should be similar to: ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud ``` The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if you don't see the node in your Space after 60 seconds, see the [troubleshooting information](#troubleshooting). @@ -267,7 +267,7 @@ You can now move on to connecting. When you connect with the [kickstart](/packag append the same proxy setting you added to `netdata.conf`. ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy socks5h://203.0.113.0:1080 +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud --claim-proxy http://[user:pass@]host:ip ``` Hit **Enter**. The script should return `Agent was successfully claimed.`. If the connecting to Netdata Cloud process returns errors, or if @@ -474,13 +474,13 @@ Our suggestion is to first run kickstart to upgrade your agent by running the co **Linux** ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` **macOS** ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --install /usr/local/ +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ ``` ### Claiming script @@ -499,7 +499,7 @@ using `sudo`, or as the user running the Agent (typically `netdata`), and passin -hostname=HOSTNAME where HOSTNAME is the result of the hostname command by default. -proxy=PROXY_URL - where PROXY_URL is the endpoint of a SOCKS5 proxy. + where PROXY_URL is the endpoint of a HTTP or HTTPS proxy. ``` For example, the following command connects an Agent and adds it to rooms `room1` and `room2`: diff --git a/docs/guides/export/export-netdata-metrics-graphite.md b/docs/guides/export/export-netdata-metrics-graphite.md index ad18980b5e..2bea1c5527 100644 --- a/docs/guides/export/export-netdata-metrics-graphite.md +++ b/docs/guides/export/export-netdata-metrics-graphite.md @@ -32,7 +32,7 @@ If you don't have the Netdata Agent installed already, visit the [installation g for the recommended instructions for your system. In most cases, you can use the one-line installation script: ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` Once installation finishes, open your browser and navigate to `http://NODE:19999`, replacing `NODE` with the IP address diff --git a/docs/guides/monitor/lamp-stack.md b/docs/guides/monitor/lamp-stack.md index fbf9ae0b4e..100dc7dd7a 100644 --- a/docs/guides/monitor/lamp-stack.md +++ b/docs/guides/monitor/lamp-stack.md @@ -60,7 +60,7 @@ If you don't have the free, open-source Netdata monitoring agent installed on yo kickstart command](/docs/get-started.mdx): ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` The Netdata Agent is now collecting metrics from your node every second. You don't need to jump into the dashboard yet, diff --git a/docs/guides/monitor/pi-hole-raspberry-pi.md b/docs/guides/monitor/pi-hole-raspberry-pi.md index 0d093c486c..8d0fb06a81 100644 --- a/docs/guides/monitor/pi-hole-raspberry-pi.md +++ b/docs/guides/monitor/pi-hole-raspberry-pi.md @@ -53,7 +53,7 @@ On Raspberry Pis running Raspbian, the best way to install Netdata is our one-li you to install dependencies, then compiles Netdata from source via [GitHub](https://github.com/netdata/netdata). ```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` Once installed on a Raspberry Pi 4 with no accessories, Netdata starts collecting roughly 1,500 metrics every second and diff --git a/docs/guides/step-by-step/step-00.md b/docs/guides/step-by-step/step-00.md index 490cbbc9f5..0d052f2560 100644 --- a/docs/guides/step-by-step/step-00.md +++ b/docs/guides/step-by-step/step-00.md @@ -46,9 +46,17 @@ This script will install Netdata from source, keep it up to date with nightly re [registry](/registry/README.md), and sends [_anonymous statistics_](/docs/anonymous-statistics.md) about how you use Netdata. We use this information to better understand how we can improve the Netdata experience for all our users. -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` +To install Netdata, run the following as your normal user: + +´´´bash +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh +´´´ +Or, if you have cURL but not wget (such as on macOS): + +´´´bash +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh +´´´ + Once finished, you'll have Netdata installed, and you'll be set up to get _nightly updates_ to get the latest features, improvements, and bugfixes. diff --git a/docs/guides/step-by-step/step-09.md b/docs/guides/step-by-step/step-09.md index c5b2ecd54e..6e29d84c52 100644 --- a/docs/guides/step-by-step/step-09.md +++ b/docs/guides/step-by-step/step-09.md @@ -122,10 +122,6 @@ libraries to make this exporting connection exist. Since you most likely install script, all you have to do is run that script again. Don't worry—any configuration changes you made along the way will be retained! -```bash -bash <(curl -Ss https://my-netdata.io/kickstart.sh) -``` - Now, from your Netdata config directory, initialize and edit a `exporting.conf` file to tell Netdata where to find the database you just created. diff --git a/exporting/WALKTHROUGH.md b/exporting/WALKTHROUGH.md index c17ee16503..d6ede8235b 100644 --- a/exporting/WALKTHROUGH.md +++ b/exporting/WALKTHROUGH.md @@ -68,8 +68,9 @@ link](/packaging/installer/README.md), the Netdata devs give us several one-line any issues with these one liners and their bootstrapping scripts so far (If you guys run into anything do share). Run the following command in your container. +<!-- candidate for reuse --> ```sh -bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --dont-wait ``` After the install completes you should be able to hit the Netdata dashboard at <http://localhost:19999/> (replace diff --git a/exporting/prometheus/README.md b/exporting/prometheus/README.md index ef6f613580..8b56b68a64 100644 --- a/exporting/prometheus/README.md +++ b/exporting/prometheus/README.md @@ -7,10 +7,6 @@ sidebar_label: Using Netdata with Prometheus # Using Netdata with Prometheus -> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.7. The new Prometheus exporting -> connector for Netdata supports a lot more features and is aligned to the development of the rest of the Netdata -> exporting connectors. - Prometheus is a distributed monitoring system which offers a very simple setup along with a robust data model. Recently Netdata added support for Prometheus. I'm going to quickly show you how to install both Netdata and Prometheus on the same server. We can then use Grafana pointed at Prometheus to obtain long term metrics Netdata offers. I'm assuming we @@ -21,10 +17,20 @@ are starting at a fresh ubuntu shell (whether you'd like to follow along in a VM ### Installing Netdata There are number of ways to install Netdata according to [Installation](/packaging/installer/README.md). The suggested way -of installing the latest Netdata and keep it upgrade automatically. Using one line installation: +of installing the latest Netdata and keep it upgrade automatically. -```sh -bash <(curl -Ss https://my-netdata.io/kickstart.sh) +<!-- candidate for reuse --> + +To install Netdata, run the following as your normal user: + +```bash +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh +``` + +Or, if you have cURL but not wget (such as on macOS): + +```bash +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh ``` At this point we should have Netdata listening on port 19999. Attempt to take your browser here: @@ -208,9 +214,6 @@ this and click on 'targets' We should see the Netdata host as a scraped target. ## Netdata support for Prometheus -> IMPORTANT: the format Netdata sends metrics to Prometheus has changed since Netdata v1.6. The new format allows easier -> queries for metrics and supports both `as collected` and normalized metrics. - Before explaining the changes, we have to understand the key differences between Netdata and Prometheus. ### understanding Netdata metrics diff --git a/packaging/installer/methods/kickstart.md b/packaging/installer/methods/kickstart.md index 1531f48aca..be0d3aa92d 100644 --- a/packaging/installer/methods/kickstart.md +++ b/packaging/installer/methods/kickstart.md @@ -19,7 +19,7 @@ The kickstart script works on all Linux distributions and macOS environments. By To install Netdata, run the following as your normal user: ```bash -wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh ``` Or, if you have cURL but not wget (such as on macOS): @@ -89,15 +89,14 @@ area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces). - `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node after the install. - `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in. -- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of - `socks5[h]://[user:pass@]host:ip` for a SOCKS5 proxy, or `http://[user:pass@]host:ip` for an HTTP(S) proxy. +- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details. - `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. For example: ```bash -wget -O ./kickstart.sh https://my-netdata.io/kickstart.sh && sh ./kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2 +wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh --claim-token=TOKEN --claim-rooms=ROOM1,ROOM2 ``` Please note that to run it you will either need to have root privileges or run it with the user that is running the agent, more details on the [Connect an agent without root privileges](/claim/README.md#connect-an-agent-without-root-privileges) section. diff --git a/packaging/installer/methods/macos.md b/packaging/installer/methods/macos.md index 2d9061e076..b1b82de989 100644 --- a/packaging/installer/methods/macos.md +++ b/packaging/installer/methods/macos.md @@ -5,94 +5,102 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/packaging/instal # Install Netdata on macOS -Netdata works on macOS, albeit with some limitations. The number of charts displaying system metrics is limited, but you -can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might -have installed on your macOS system. You could also use a macOS system as the parent node in a [streaming -configuration](/streaming/README.md). +Netdata works on macOS, albeit with some limitations. +The number of charts displaying system metrics is limited, but you can use any of Netdata's [external plugins](/collectors/plugins.d/README.md) to monitor any services you might have installed on your macOS system. +You could also use a macOS system as the parent node in a [streaming configuration](/streaming/README.md). -We recommend you to **[install Netdata with the our automatic one-line installation script](#install-netdata-with-our-automatic-one-line-installation-script)**, +You can install Netdata in one of the three following ways: - -As an alternative you also have community-created and -maintained [**Homebrew -package**](#install-netdata-with-the-homebrew-package). - -- [Install Netdata via the Homebrew package](#install-netdata-with-the-homebrew-package) +- **[Install Netdata with the our automatic one-line installation script (recommended)](#install-netdata-with-our-automatic-one-line-installation-script)**, +- [Install Netdata via Homebrew](#install-netdata-with-the-homebrew-package) - [Install Netdata from source](#install-netdata-from-source) -Being community-created and -maintained we don't guarantee that the features made available on our installation script will also be available or give support to it. +Each of these installation option requires [Homebrew](https://brew.sh/) for handling dependencies. + +> The Netdata Homebrew package is community-created and -maintained. +> Community-maintained packages _may_ receive support from Netdata, but are only a best-effort affair. Learn more about [Netdata's platform support policy](/packaging/platform_support). ## Install Netdata with our automatic one-line installation script -To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) script you will just need to run: +**Local Netdata Agent installation** +To install Netdata using our automatic [kickstart](/packaging/installer/README.md#automatic-one-line-installation-script) open a new terminal and run: ```bash -wget -O /tmp/netdata-kickstart.sh https://my-netdata.io/kickstart.sh && sh /tmp/netdata-kickstart.sh +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh ``` +The Netdata Agent is be installed under `/usr/local/netdata`. Dependencies are handled via Homebrew. -With this script, you are also able to connect your nodes directly to Netdata Cloud if you wish, see more details on [Connect an agent running in macOS](/claim/README.md#connect-an-agent-running-in-macos) - -This currently only supports building Netdata locally, and requires dependencies to be handled either via Homebrew -or MacPorts (we preferentially use Homebrew if both are found). By default, this will install Netdata under -`/usr/local/netdata`. +**Automatically connect to Netdata Cloud during installation** +<!-- Potential reuse: https://learn.netdata.cloud/docs/agent/claim#connect-an-agent-running-in-macos--> +<!--Potential reuse https://learn.netdata.cloud/docs/agent/packaging/installer/methods/kickstart#connect-node-to-netdata-cloud-during-installation The following information is copied from this link.--> -## Install Netdata with the Homebrew package +The `kickstart.sh` script accepts additional parameters to automatically [connect](/claim/README.md) your node to Netdata +Cloud immediately after installation. Find the `token` and `rooms` strings by [signing in to Netdata +Cloud](https://app.netdata.cloud/sign-in?cloudRoute=/spaces), then clicking on **Connect Nodes** in the [Spaces management +area](https://learn.netdata.cloud/docs/cloud/spaces#manage-spaces). -If you don't have [Homebrew](https://brew.sh/) installed already, begin with their installation script: +- `--claim-token`: Specify a unique claiming token associated with your Space in Netdata Cloud to be used to connect to the node + after the install. +- `--claim-rooms`: Specify a comma-separated list of tokens for each War Room this node should appear in. +- `--claim-proxy`: Specify a proxy to use when connecting to the cloud in the form of `http://[user:pass@]host:ip` for an HTTP(S) proxy. + See [connecting through a proxy](/claim/README.md#connect-through-a-proxy) for details. +- `--claim-url`: Specify a URL to use when connecting to the cloud. Defaults to `https://app.netdata.cloud`. +For example: ```bash -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" +curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh --install /usr/local/ --claim-token TOKEN --claim-rooms ROOM1,ROOM2 --claim-url https://app.netdata.cloud ``` +The Netdata Agent is installed under `/usr/local/netdata` on your machine. Your machine will also show up as a node in your Netdata Cloud. -Next, you can use Homebrew's package, which installs Netdata all its dependencies in a single step: +If you experience issues while claiming your node, follow the steps in our [Troubleshooting](claim/README.md#troubleshooting) documentation. +## Install Netdata via Homebrew + +To install Netdata and all its dependencies, run Homebrew using the following command: ```sh brew install netdata ``` +Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. -> Homebrew will place your Netdata configuration directory at `/usr/local/etc/netdata/`. Use the `edit-config` script -> and the files in this directory to configure Netdata. For reference, you can find stock configuration files at -> `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`. +Use the `edit-config` script and the files in this directory to configure Netdata. For reference, you can find stock configuration files at `/usr/local/Cellar/netdata/{NETDATA_VERSION}/lib/netdata/conf.d/`. Skip on ahead to the [What's next?](#whats-next) section to find links to helpful post-installation guides. ## Install Netdata from source -We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies -manually. - -First open your terminal of choice and install the Xcode development packages. +We don't recommend installing Netdata from source on macOS, as it can be difficult to configure and install dependencies manually. -```bash -xcode-select --install -``` +1. Open your terminal of choice and install the Xcode development packages: -Click **Install** on the Software Update popup window that appears. Then, use the same terminal session to use Homebrew -to install some of Netdata's prerequisites. You can omit `cmake` in case you do not want to use -[Netdata Cloud](https://learn.netdata.cloud/docs/cloud/). + ```bash + xcode-select --install + ``` -```bash -brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake -``` +2. Click **Install** on the Software Update popup window that appears. +3. Use the same terminal session to install some of Netdata's prerequisites using Homebrew. If you don't want to use [Netdata Cloud](https://learn.netdata.cloud/docs/cloud/), you can omit `cmake`. -If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download + ```bash + brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl libtool cmake + ``` + +4. Optional: If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata. -Next, download Netdata from our GitHub repository: +5. Download Netdata from our GitHub repository: -```bash -git clone https://github.com/netdata/netdata.git --recursive -``` + ```bash + git clone https://github.com/netdata/netdata.git --recursive + ``` -Finally, `cd` into the newly-created directory and then start the installer script: +6. `cd` into the newly-created directory and then start the installer script: -```bash -cd netdata/ -sudo ./netdata-installer.sh --install /usr/local -``` + ```bash + cd netdata/ + sudo ./netdata-installer.sh --install /usr/local + ``` -> Your Netdata configuration directory will be at `/usr/local/netdata/`, and your stock configuration directory will -> be at **`/usr/local/lib/netdata/conf.d/`.** -> +> Your Netdata configuration directory will be at `/usr/local/netdata/`. +> Your stock configuration directory will be at `/usr/local/lib/netdata/conf.d/`. > The installer will also install a startup plist to start Netdata when your macOS system boots. ## What's next? @@ -102,8 +110,5 @@ When you're finished with installation, check out our [single-node](/docs/quicks Or, skip straight to [configuring the Netdata Agent](/docs/configure/nodes.md). -Read through Netdata's [documentation](https://learn.netdata.cloud/docs), which is structured based on actions and -solutions, to enable features like health monitoring, alarm notifications, long-term metrics storage, exporting to -external databases, and more. [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fpackaging%2Finstaller%2Fmethods%2Fmacos&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) diff --git a/packaging/installer/methods/source.md b/packaging/installer/methods/source.md index 5345a1a4c8..737ea166aa 100644 --- a/packaging/installer/methods/source.md +++ b/packaging/installer/methods/source.md @@ -48,61 +48,6 @@ libraries and their header files must be copied into specific locations in the source tree to be used. ### Netdata cloud - -Netdata Cloud functionality requires custom builds of libmosquitto and -libwebsockets. - -#### libmosquitto - -Netdata maintains a custom fork of libmosquitto at -https://github.com/netdata/mosquitto with patches to allow for proper -integration with libwebsockets, which is needed for correct operation of -Netdata Cloud functionality. To prepare this library for the build system: - -1. Verify the tag that Netdata expects to be used by checking the contents - of `packaging/mosquitto.version` in your Netdata sources. -2. Obtain the sources for that version by either: - - Navigating to https://github.com/netdata/mosquitto/releases and - downloading and unpacking the source code archive for that release. - - Cloning the repository with `git` and checking out the required tag. -3. If building on a platform other than Linux, prepare the mosquitto - sources by running `cmake -D WITH_STATIC_LIBRARIES:boolean=YES .` in - the mosquitto source directory. -4. Build mosquitto by running `make -C lib` in the mosquitto source directory. -5. In the Netdata source directory, create a directory called `externaldeps/mosquitto`. -6. Copy `lib/mosquitto.h` from the mosquitto source directory to - `externaldeps/mosquitto/mosquitto.h` in the Netdata source tree. -7. Copy `lib/libmosquitto.a` from the mosquitto source directory to - `externaldeps/mosquitto/libmosquitto.a` in the Netdata source tree. If - building on a platform other than Linux, the file that needs to be - copied will instead be named `lib/libmosquitto_static.a`, but it - still needs to be copied to `externaldeps/mosquitto/libmosquitto.a`. - -#### libwebsockets - -Netdata uses the standard upstream version of libwebsockets located at -https://github.com/warmcat/libwebsockets, but requires a build with SOCKS5 -support, which is not enabled by most pre-built versions. Currently, -we do not support using a system copy of libwebsockets. To prepare this -library for the build system: - -1. Verify the tag that Netdata expects to be used by checking the contents - of `packaging/libwebsockets.version` in your Netdata sources. -2. Obtain the sources for that version by either: - - Navigating to https://github.com/warmcat/libwebsockets/releases and - downloading and unpacking the source code archive for that release. - - Cloning the repository with `git` and checking out the required tag. -3. Prepare the libwebsockets sources by running `cmake -D - LWS_WITH_SOCKS5:bool=ON .` in the libwebsockets source directory. -4. Build libwebsockets by running `make` in the libwebsockets source - directory. -5. In the Netdata source directory, create a directory called - `externaldeps/libwebsockets`. -6. Copy `lib/libwebsockets.a` from the libwebsockets source directory to - `externaldeps/libwebsockets/libwebsockets.a` in the Netdata source tree. -7. Copy the entire contents of `include/` from the libwebsockets source - directory to `externaldeps/libwebsockets/include` in the Netdata source tree. - #### JSON-C Netdata requires the use of JSON-C for JSON parsing when using Netdata diff --git a/web/api/exporters/prometheus/README.md b/web/api/exporters/prometheus/README.md index d26c6e4695..48b85555e4 100644 --- a/web/api/exporters/prometheus/README.md +++ b/web/api/exporters/prometheus/README.md @@ -1,10 +1,10 @@ <!-- -title: "prometheus exporter" +title: "Prometheus exporter" custom_edit_url: https://github.com/netdata/netdata/edit/master/web/api/exporters/prometheus/README.md --> -# prometheus exporter +# Prometheus exporter -The prometheus exporter for Netdata is located at the [backends section for prometheus](/backends/prometheus/README.md). +Read the Prometheus exporter documentation: [Using Netdata with Prometheus](/exporting/prometheus/README.md). [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fweb%2Fapi%2Fexporters%2Fprometheus%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>) |