Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 3.29 KB

macos.md

File metadata and controls

86 lines (60 loc) · 3.29 KB
Raw

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 to monitor any services you might have installed on your macOS system. You could also use a macOS system as the master node in a streaming configuration.

We recommend installing Netdata with the community-created and -maintained Homebrew package.

Install Netdata with the Homebrew package

If you don't have Homebrew installed already, begin with their installation script:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Next, you can use Homebrew's package, which installs Netdata all its dependencies in a single step:

brew install 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/.

Skip on ahead to the What's 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.

xcode-select --install

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.

brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c [email protected]

If you want to use the database engine to store your metrics, you need to download and install the Judy library before proceeding compiling Netdata.

Next, download Netdata from our GitHub repository:

git clone https://github.com/netdata/netdata.git

Finally, cd into the newly-created directory and then start the installer script:

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/.

The installer will also install a startup plist to start Netdata when your Mac boots.

What's next?

When you finish installing Netdata, be sure to visit our step-by-step tutorial for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.

Or, if you're a monitoring and system administration pro, skip ahead to our getting started guide for a quick overview.