diff options
Diffstat (limited to '')
| -rw-r--r-- | system/.install-type | 1 | ||||
| -rw-r--r-- | system/Makefile.am | 71 | ||||
| -rwxr-xr-x | system/edit-config.in | 83 | ||||
| -rwxr-xr-x | system/install-service.sh.in | 786 | ||||
| -rw-r--r-- | system/netdata-freebsd.in | 53 | ||||
| -rw-r--r-- | system/netdata-init-d.in | 95 | ||||
| -rw-r--r-- | system/netdata-lsb.in | 116 | ||||
| -rw-r--r-- | system/netdata-openrc.in | 88 | ||||
| -rw-r--r-- | system/netdata-updater.service.in | 8 | ||||
| -rw-r--r-- | system/netdata-updater.timer | 12 | ||||
| -rw-r--r-- | system/netdata.conf | 19 | ||||
| -rw-r--r-- | system/netdata.crontab.in | 1 | ||||
| -rw-r--r-- | system/netdata.logrotate.in | 12 | ||||
| -rw-r--r-- | system/netdata.plist.in | 15 | ||||
| -rw-r--r-- | system/netdata.service.in | 76 | ||||
| -rw-r--r-- | system/netdata.service.v235.in | 42 |
16 files changed, 1478 insertions, 0 deletions
diff --git a/system/.install-type b/system/.install-type new file mode 100644 index 0000000..ebac7be --- /dev/null +++ b/system/.install-type @@ -0,0 +1 @@ +INSTALL_TYPE='custom' diff --git a/system/Makefile.am b/system/Makefile.am new file mode 100644 index 0000000..72d123d --- /dev/null +++ b/system/Makefile.am @@ -0,0 +1,71 @@ +# Copyright (C) 2015 Alon Bar-Lev <alon.barlev@gmail.com> +# SPDX-License-Identifier: GPL-3.0-or-later + +MAINTAINERCLEANFILES = $(srcdir)/Makefile.in +CLEANFILES = \ + edit-config \ + netdata-openrc \ + netdata.logrotate \ + netdata.service \ + netdata.service.v235 \ + netdata-init-d \ + netdata-lsb \ + netdata-freebsd \ + netdata.plist \ + netdata.crontab \ + netdata-updater.service \ + $(NULL) + +include $(top_srcdir)/build/subst.inc +SUFFIXES = .in + +dist_config_SCRIPTS = \ + edit-config \ + $(NULL) + +dist_config_DATA = \ + .install-type \ + $(NULL) + +# Explicitly install directories to avoid permission issues due to umask +install-exec-local: + $(INSTALL) -d $(DESTDIR)$(configdir) + $(INSTALL) -d $(DESTDIR)$(libsysdir) + +libexecnetdatadir=$(libexecdir)/netdata +nodist_libexecnetdata_SCRIPTS = \ + install-service.sh \ + $(NULL) + +nodist_libsys_DATA = \ + netdata-openrc \ + netdata.logrotate \ + netdata.service \ + netdata.service.v235 \ + netdata-init-d \ + netdata-lsb \ + netdata-freebsd \ + netdata.plist \ + netdata.crontab \ + netdata-updater.service \ + $(NULL) + +dist_libsys_DATA = \ + netdata-updater.timer \ + $(NULL) + +dist_noinst_DATA = \ + edit-config.in \ + install-service.sh.in \ + netdata-openrc.in \ + netdata.logrotate.in \ + netdata.service.in \ + netdata.service.v235.in \ + netdata-init-d.in \ + netdata-lsb.in \ + netdata-freebsd.in \ + netdata.plist.in \ + netdata.conf \ + netdata.crontab.in \ + netdata-updater.service.in \ + $(NULL) diff --git a/system/edit-config.in b/system/edit-config.in new file mode 100755 index 0000000..050d97c --- /dev/null +++ b/system/edit-config.in @@ -0,0 +1,83 @@ +#!/usr/bin/env sh + +[ -f /etc/profile ] && . /etc/profile + +file="${1}" + +if [ "$(command -v editor)" ]; then + EDITOR="${EDITOR-editor}" +else + EDITOR="${EDITOR-vi}" +fi + +[ -z "${NETDATA_USER_CONFIG_DIR}" ] && NETDATA_USER_CONFIG_DIR="@configdir_POST@" +[ -z "${NETDATA_STOCK_CONFIG_DIR}" ] && NETDATA_STOCK_CONFIG_DIR="@libconfigdir_POST@" + +if [ -z "${file}" ]; then + cat << EOF + +USAGE: + ${0} FILENAME + + Copy and edit the stock config file named: FILENAME + if FILENAME is already copied, it will be edited as-is. + + The EDITOR shell variable is used to define the editor to be used. + + Stock config files at: '${NETDATA_STOCK_CONFIG_DIR}' + User config files at: '${NETDATA_USER_CONFIG_DIR}' + + Available files in '${NETDATA_STOCK_CONFIG_DIR}' to copy and edit: + +EOF + + cd "${NETDATA_STOCK_CONFIG_DIR}" || exit 1 + ls >&2 -R ./*.conf ./*/*.conf + exit 1 + +fi + +edit() { + echo >&2 "Editing '${1}' ..." + + # check we can edit + if [ ! -w "${1}" ]; then + echo >&2 "Cannot write to ${1}! Aborting ..." + exit 1 + fi + + "${EDITOR}" "${1}" + exit $? +} + +copy_and_edit() { + # check we can copy + if [ ! -w "${NETDATA_USER_CONFIG_DIR}" ]; then + echo >&2 "Cannot write to ${NETDATA_USER_CONFIG_DIR}! Aborting ..." + exit 1 + fi + + if [ ! -f "${NETDATA_USER_CONFIG_DIR}/${1}" ]; then + echo >&2 "Copying '${NETDATA_STOCK_CONFIG_DIR}/${1}' to '${NETDATA_USER_CONFIG_DIR}/${1}' ... " + cp -p "${NETDATA_STOCK_CONFIG_DIR}/${1}" "${NETDATA_USER_CONFIG_DIR}/${1}" || exit 1 + fi + + edit "${NETDATA_USER_CONFIG_DIR}/${1}" +} + +# make sure it is not absolute filename +c1="$(echo "${file}" | cut -b 1)" +if [ "${c1}" = "/" ] || [ "${c1}" = "." ]; then + echo >&2 "Please don't use filenames starting with '/' or '.'" + exit 1 +fi + +# already exists +[ -f "${NETDATA_USER_CONFIG_DIR}/${file}" ] && edit "${NETDATA_USER_CONFIG_DIR}/${file}" + +# stock config is valid, copy and edit +[ -f "${NETDATA_STOCK_CONFIG_DIR}/${file}" ] && copy_and_edit "${file}" + +# no such config found +echo >&2 "File '${file}' is not found in '${NETDATA_STOCK_CONFIG_DIR}'" +exit 1 diff --git a/system/install-service.sh.in b/system/install-service.sh.in new file mode 100755 index 0000000..59cff0a --- /dev/null +++ b/system/install-service.sh.in @@ -0,0 +1,786 @@ +#!/usr/bin/env sh + +# SPDX-License-Identifier: GPL-3.0-or-later + +# Handle installation of the Netdata agent as a system service. +# +# Exit codes: +# 0 - Successfully installed service. +# 1 - Invalid arguments or other internal error. +# 2 - Unable to detect system service type. +# 3 - Detected system service type, but type not supported. +# 4 - Detected system service type, but could not install due to other issues. +# 5 - Platform not supported. + +set -e + +SCRIPT_SOURCE="$( + self=${0} + while [ -L "${self}" ] + do + cd "${self%/*}" || exit 1 + self=$(readlink "${self}") + done + cd "${self%/*}" || exit 1 + echo "$(pwd -P)/${self##*/}" +)" + +DUMP_CMDS=0 +ENABLE="auto" +EXPORT_CMDS=0 +INSTALL=1 +LINUX_INIT_TYPES="systemd openrc lsb initd runit" +PLATFORM="$(uname -s)" +SHOW_SVC_TYPE=0 +SVC_SOURCE="@libsysdir_POST@" +SVC_TYPE="detect" +WSL_ERROR_MSG="We appear to be running in WSL and were unable to find a usable service manager. We currently support systemd, LSB init scripts, and traditional init.d style init scripts when running under WSL." + +# ===================================================================== +# Utility functions + +cleanup() { + ec="${?}" + + if [ -n "${NETDATA_SAVE_WARNINGS}" ]; then + if [ -n "${NETDATA_PROPAGATE_WARNINGS}" ]; then + export NETDATA_WARNINGS="${NETDATA_WARNINGS}${SAVED_WARNINGS}" + fi + fi + + trap - EXIT + + exit "${ec}" +} + +info() { + printf >&2 "%s\n" "${*}" +} + +warning() { + if [ -n "${NETDATA_SAVE_WARNINGS}" ]; then + SAVED_WARNINGS="${SAVED_WARNINGS}\n - ${*}" + fi + printf >&2 "WARNING: %s\n" "${*}" +} + +error() { + if [ -n "${NETDATA_SAVE_WARNINGS}" ]; then + SAVED_WARNINGS="${SAVED_WARNINGS}\n - ${*}" + fi + printf >&2 "ERROR: %s\n" "${*}" +} + +get_os_key() { + if [ -f /etc/os-release ]; then + # shellcheck disable=SC1091 + . /etc/os-release || return 1 + echo "${ID}-${VERSION_ID}" + + elif [ -f /etc/redhat-release ]; then + cat /etc/redhat-release + else + echo "unknown" + fi +} + +valid_types() { + case "${PLATFORM}" in + Linux) + echo "detect systemd openrc lsb initd" + ;; + FreeBSD) + echo "detect freebsd" + ;; + Darwin) + echo "detect launchd" + ;; + *) + echo "detect" + ;; + esac +} + +install_generic_service() { + svc_type="${1}" + svc_type_name="${2}" + svc_file="${3}" + svc_enable_hook="${4}" + svc_disable_hook="${5}" + + info "Installing ${svc_type_name} service file." + if [ ! -f "${svc_file}" ] && [ "${ENABLE}" = "auto" ]; then + ENABLE="enable" + fi + + if ! install -p -m 0755 -o 0 -g 0 "${SVC_SOURCE}/netdata-${svc_type}" "${svc_file}"; then + error "Failed to install service file." + exit 4 + fi + + case "${ENABLE}" in + auto) true ;; + disable) + info "Disabling Netdata service." + ${svc_disable_hook} + ;; + enable) + info "Enabling Netdata service." + ${svc_enable_hook} + ;; + esac +} + +dump_cmds() { + [ -n "${NETDATA_START_CMD}" ] && echo "NETDATA_START_CMD='${NETDATA_START_CMD}'" + [ -n "${NETDATA_STOP_CMD}" ] && echo "NETDATA_STOP_CMD='${NETDATA_STOP_CMD}'" + [ -n "${NETDATA_INSTALLER_START_CMD}" ] && echo "NETDATA_INSTALLER_START_CMD='${NETDATA_INSTALLER_START_CMD}'" + return 0 +} + +export_cmds() { + [ -n "${NETDATA_START_CMD}" ] && export NETDATA_START_CMD="${NETDATA_START_CMD}" + [ -n "${NETDATA_STOP_CMD}" ] && export NETDATA_STOP_CMD="${NETDATA_STOP_CMD}" + [ -n "${NETDATA_INSTALLER_START_CMD}" ] && export NETDATA_INSTALLER_START_CMD="${NETDATA_INSTALLER_START_COMMAND}" + return 0 +} + +save_cmds() { + dump_cmds > "${SAVE_CMDS_PATH}" +} + +# ===================================================================== +# Help functions + +usage() { + cat << HEREDOC +USAGE: install-service.sh [options] + where options include: + + --source Specify where to find the service files to install (default ${SVC_SOURCE}). + --type Specify the type of service file to install. Specify a type of 'help' to get a list of valid types for your platform. + --show-type Display information about what service managers are detected. + --cmds Additionally print a list of commands for starting and stopping the agent with the detected service type. + --export-cmds Export the variables that would be printed by the --cmds option. + --cmds-only Don't install, just handle the --cmds or --export-cmds option. + --enable Explicitly enable the service on install (default is to enable if not already installed). + --disable Explicitly disable the service on install. + --help Print this help information. +HEREDOC +} + +help_types() { + cat << HEREDOC +Valid service types for ${PLATFORM} are: +$(valid_types) +HEREDOC +} + +# ===================================================================== +# systemd support functions + +_check_systemd() { + pids='' + p='' + myns='' + ns='' + + # if the directory /lib/systemd/system OR /usr/lib/systemd/system (SLES 12.x) does not exit, it is not systemd + if [ ! -d /lib/systemd/system ] && [ ! -d /usr/lib/systemd/system ]; then + echo "NO" && return 0 + fi + + # if there is no systemctl command, it is not systemd + [ -z "$(command -v systemctl 2>/dev/null || true)" ] && echo "NO" && return 0 + + # if pid 1 is systemd, it is systemd + [ "$(basename "$(readlink /proc/1/exe)" 2> /dev/null)" = "systemd" ] && echo "YES" && return 0 + + # it ‘is’ systemd at this point, but systemd might not be running + # if not, return 2 to indicate ‘systemd, but not running’ + pids=$(safe_pidof systemd 2> /dev/null) + [ -z "${pids}" ] && echo "OFFLINE" && return 0 + + # check if the running systemd processes are not in our namespace + myns="$(readlink /proc/self/ns/pid 2> /dev/null)" + for p in ${pids}; do + ns="$(readlink "/proc/${p}/ns/pid" 2> /dev/null)" + + # if pid of systemd is in our namespace, it is systemd + [ -n "${myns}" ] && [ "${myns}" = "${ns}" ] && echo "YES" && return 0 + done + + # else, it is not systemd + echo "NO" +} + +check_systemd() { + if [ -z "${IS_SYSTEMD}" ]; then + IS_SYSTEMD="$(_check_systemd)" + fi + + echo "${IS_SYSTEMD}" +} + +get_systemd_service_dir() { + if [ -w "/lib/systemd/system" ]; then + echo "/lib/systemd/system" + elif [ -w "/usr/lib/systemd/system" ]; then + echo "/usr/lib/systemd/system" + elif [ -w "/etc/systemd/system" ]; then + echo "/etc/systemd/system" + else + error "Unable to detect systemd service directory." + exit 4 + fi +} + +install_systemd_service() { + SRCFILE="${SVC_SOURCE}/netdata.service" + + if [ "$(systemctl --version | head -n 1 | cut -f 2 -d ' ')" -le 235 ]; then + SRCFILE="${SVC_SOURCE}/netdata.service.v235" + fi + + if [ "${ENABLE}" = "auto" ]; then + if [ "$(check_systemd)" = "YES" ]; then + IS_NETDATA_ENABLED="$(systemctl is-enabled netdata 2> /dev/null || echo "Netdata not there")" + fi + + if [ "${IS_NETDATA_ENABLED}" = "disabled" ]; then + ENABLE="disable" + else + ENABLE="enable" + fi + fi + + info "Installing systemd service..." + if ! install -p -m 0644 -o 0 -g 0 "${SRCFILE}" "$(get_systemd_service_dir)/netdata.service"; then + error "Failed to install systemd service file." + exit 4 + fi + + if [ "$(check_systemd)" = "YES" ]; then + if ! systemctl daemon-reload; then + warning "Failed to reload systemd unit files." + fi + + if ! systemctl ${ENABLE} netdata; then + warning "Failed to ${ENABLE} Netdata service." + fi + fi +} + +systemd_cmds() { + if [ "$(check_systemd)" = "YES" ]; then + NETDATA_START_CMD='systemctl start netdata' + NETDATA_STOP_CMD='systemctl stop netdata' + else # systemd is not running, use external defaults by providing no commands + warning "Detected systemd, but not booted using systemd. Unable to provide commands to start or stop Netdata using the service manager." + fi +} + +# ===================================================================== +# OpenRC support functions + +_check_openrc() { + # if /lib/rc/sh/functions.sh does not exist, it's not OpenRC + [ ! -f /lib/rc/sh/functions.sh ] && echo "NO" && return 0 + + # if there is no /etc/init.d, it's not OpenRC + [ ! -d /etc/init.d ] && echo "NO" && return 0 + + # if there is no rc-update command, it's not OpenRC + [ -z "$(command -v rc-update 2>/dev/null || true)" ] && echo "NO" && return 0 + + # If /run/openrc/softlevel exists, it's OpenRC + [ -f /run/openrc/softlevel ] && echo "YES" && return 0 + + # if PID 1 is openrc-init, it's OpenRC + [ "$(basename "$(readlink /proc/1/exe)" 2> /dev/null)" = "openrc-init" ] && echo "YES" && return 0 + + # if there is an openrc command, it's OpenRC, but not booted as such + [ -n "$(command -v openrc 2>/dev/null || true)" ] && echo "OFFLINE" && return 0 + + # if /etc/init.d/local exists and has `openrc-run` in it's shebang line, it’s OpenRC, but not booted as such + [ -r /etc/init.d/local ] && head -n 1 /etc/init.d/local | grep -q openrc-run && echo "OFFLINE" && return 0 + + # Otherwise, it’s not OpenRC + echo "NO" && return 0 +} + +check_openrc() { + if [ -z "${IS_OPENRC}" ]; then + IS_OPENRC="$(_check_openrc)" + fi + + echo "${IS_OPENRC}" +} + +enable_openrc() { + if [ "$(check_openrc)" = "YES" ]; then + runlevel="$(rc-status -r)" + fi + + runlevel="${runlevel:-default}" + + if ! rc-update add netdata "${runlevel}"; then + warning "Failed to enable Netdata service in runlevel ${runlevel}." + fi +} + +disable_openrc() { + for runlevel in /etc/runlevels/*; do + if [ -e "${runlevel}/netdata" ]; then + runlevel="$(basename "${runlevel}")" + if ! rc-update del netdata "${runlevel}"; then + warning "Failed to disable Netdata service in runlevel ${runlevel}." + fi + fi + done +} + +install_openrc_service() { + install_generic_service openrc OpenRC /etc/init.d/netdata enable_openrc disable_openrc +} + +openrc_cmds() { + if [ "$(check_openrc)" = "YES" ]; then + NETDATA_START_CMD='rc-service netdata start' + NETDATA_STOP_CMD='rc-service netdata stop' + else # Not booted using OpenRC, use external defaults by not providing commands. + warning "Detected OpenRC, but the system is not booted using OpenRC. Unable to provide commands to start or stop Netdata using the service manager." + fi +} + +# ===================================================================== +# LSB init script support functions + +_check_lsb_ignore_systemd() { + # if there is no /etc/init.d directory, it’s not an LSB system + [ ! -d /etc/init.d ] && echo "NO" && return 0 + + # If it's an OpenRC system, then it's not an LSB system + [ "$(check_openrc)" != "NO" ] && echo "NO" && return 0 + + # If /lib/lsb/init-functions exists, it’s an LSB system + [ -f /lib/lsb/init-functions ] && echo "YES" && return 0 + + echo "NO" && return 0 +} + +_check_lsb() { + # if there is _any_ systemd, it’s not an LSB system + [ "$(check_systemd)" != "NO" ] && echo "NO" && return 0 + + _check_lsb_ignore_systemd +} + +check_lsb() { + if [ -z "${IS_LSB}" ]; then + IS_LSB="$(_check_lsb)" + fi + + echo "${IS_LSB}" +} + +enable_lsb() { + if ! update-rc.d netdata defaults; then + warning "Failed to enable Netdata service." + elif ! update-rc.d netdata defaults-disabled; then + warning "Failed to fully enable Netdata service." + fi +} + +disable_lsb() { + if ! update-rc.d netdata remove; then + warning "Failed to disable Netdata service." + fi +} + +install_lsb_service() { + install_generic_service lsb LSB /etc/init.d/netdata enable_lsb disable_lsb +} + +lsb_cmds() { + NETDATA_START_CMD='/etc/init.d/netdata start' + NETDATA_STOP_CMD='/etc/init.d/netdata stop' +} + +# ===================================================================== +# init.d init script support functions + +_check_initd_ignore_systemd() { + # if there is no /etc/init.d directory, it’s not an init.d system + [ ! -d /etc/init.d ] && echo "NO" && return 1 + + # if there is no chkconfig command, it's not a (usable) init.d system + [ -z "$(command -v chkconfig 2>/dev/null || true)" ] && echo "NO" && return 0 + + # if there is _any_ openrc, it’s not init.d + [ "$(check_openrc)" != "NO" ] && echo "NO" && return 0 + + # if it's not an LSB setup, it’s init.d + [ "$(check_lsb)" != "NO" ] && echo "NO" && return 0 + + echo "YES" && return 0 +} + +_check_initd() { + # if there is _any_ systemd, it’s not init.d + [ "$(check_systemd)" != "NO" ] && echo "NO" && return 0 + + _check_initd_ignore_systemd +} + +check_initd() { + if [ -z "${IS_INITD}" ]; then + IS_INITD="$(_check_initd)" + fi + + echo "${IS_INITD}" +} + +enable_initd() { + if ! chkconfig netdata on; then + warning "Failed to enable Netdata service." + fi +} + +disable_initd() { + if ! chkconfig netdata off; then + warning "Failed to disable Netdata service." + fi +} + +install_initd_service() { + install_generic_service init-d init.d /etc/init.d/netdata enable_initd disable_initd +} + +initd_cmds() { + NETDATA_START_CMD='/etc/init.d/netdata start' + NETDATA_STOP_CMD='/etc/init.d/netdata stop' +} + +# ===================================================================== +# runit support functions +# +# Currently not supported, this exists to provide useful error messages. + +_check_runit() { + # if there is no runsvdir command, then it's not runit + [ -z "$(command -v runsvdir 2>/dev/null || true)" ] && echo "NO" && return 0 + + # if there is no runit command, then it's not runit + [ -z "$(command -v runit 2>/dev/null || true)" ] && echo "NO" && return 0 + + # if /run/runit exists, then it's runit + [ -d /run/runit ] && echo "YES" && return 0 + + # if /etc/runit/1 exists and is executable, then it's runit + [ -x /etc/runit/1 ] && echo "YES" && return 0 + + echo "NO" && return 0 +} + +check_runit() { + if [ -z "${IS_RUNIT}" ]; then + IS_RUNIT="$(_check_runit)" + fi + + echo "${IS_RUNIT}" +} + +install_runit_service() { + error "Detected runit, which we do not currently support." + exit 3 +} + +runit_cmds() { + error "Detected runit, which we do not currently support." + exit 3 +} + +# ===================================================================== +# WSL support functions +# +# Cannot be supported, this exists to provide useful error messages. + +_check_wsl() { + # If uname -r contains the string WSL, then it's WSL. + uname -r | grep -q 'WSL' && echo "YES" && return 0 + + # If uname -r contains the string Microsoft, then it's WSL. + # This probably throws a false positive on CBL-Mariner, but it's part of what MS officially recommends for + # detecting if you're running under WSL. + uname -r | grep -q "Microsoft" && echo "YES" && return 0 + + echo "NO" && return 0 +} + +check_wsl() { + if [ -z "${IS_WSL}" ]; then + IS_WSL="$(_check_wsl)" + fi + + echo "${IS_WSL}" +} + +install_wsl_service() { + error "${WSL_ERROR_MSG}" + exit 3 +} + +wsl_cmds() { + error "${WSL_ERROR_MSG}" + exit 3 +} + +# ===================================================================== +# FreeBSD support functions + +enable_freebsd() { + if ! sysrc netdata_enable=YES; then + warning "Failed to enable netdata service." + fi +} + +disable_freebsd() { + if ! sysrc netdata_enable=NO; then + warning "Failed to disable netdata service." + fi +} + +install_freebsd_service() { + install_generic_service freebsd "FreeBSD rc.d" /usr/local/etc/rc.d/netdata enable_freebsd disable_freebsd +} + +freebsd_cmds() { + NETDATA_START_CMD='service netdata start' + NETDATA_STOP_CMD='service netdata stop' + NETDATA_INSTALLER_START_CMD='service netdata onestart' +} + +# ===================================================================== +# macOS support functions + +install_darwin_service() { + info "Installing macOS plist file for launchd." + if ! install -C -S -p -m 0644 -o 0 -g 0 system/netdata.plist /Library/LaunchDaemons/com.github.netdata.plist; then + error "Failed to copy plist file." + exit 4 + fi + + if ! launchctl load /Library/LaunchDaemons/com.github.netdata.plist; then + error "Failed to load plist file." + exit 4 + fi +} + +darwin_cmds() { + NETDATA_START_CMD='launchctl start com.github.netdata' + NETDATA_STOP_CMD='launchctl stop com.github.netdata' +} + +# ===================================================================== +# Linux support functions + +detect_linux_svc_type() { + if [ "${SVC_TYPE}" = "detect" ]; then + found_types='' + + for t in wsl ${LINUX_INIT_TYPES}; do + case "$("check_${t}")" in + YES) + SVC_TYPE="${t}" + break + ;; + NO) continue ;; + OFFLINE) + if [ -z "${found_types}" ]; then + found_types="${t}" + else + found_types="${found_types} ${t}" + fi + ;; + esac + done + + if [ "${SVC_TYPE}" = "detect" ]; then + if [ -z "${found_types}" ]; then + error "Failed to detect what type of service manager is in use." + else + SVC_TYPE="$(echo "${found_types}" | cut -f 1 -d ' ')" + warning "Failed to detect a running service manager, using detected (but not running) ${SVC_TYPE}." + fi + elif [ "${SVC_TYPE}" = "wsl" ]; then + if [ "$(check_systemd)" = "YES" ]; then + # Support for systemd in WSL. + SVC_TYPE="systemd" + elif [ "$(_check_lsb_ignore_systemd)" = "YES" ]; then + # Support for LSB init.d in WSL. + SVC_TYPE="lsb" + elif [ "$(_check_initd_ignore_systemd)" = "YES" ]; then + # Support for ‘generic’ init.d in WSL. + SVC_TYPE="initd" + fi + fi + fi + + echo "${SVC_TYPE}" +} + +install_linux_service() { + t="$(detect_linux_svc_type)" + + if [ -z "${t}" ]; then + exit 2 + fi + + "install_${t}_service" +} + +linux_cmds() { + t="$(detect_linux_svc_type)" + + if [ -z "${t}" ]; then + exit 2 + fi + + "${t}_cmds" +} + +# ===================================================================== +# Service type display function + +show_service_type() { + info "Detected platform: ${PLATFORM}" + + case "${PLATFORM}" in + FreeBSD) + info "Detected service managers:" + info " - freebsd: YES" + info "Would use freebsd service management." + ;; + Darwin) + info "Detected service managers:" + info " - launchd: YES" + info "Would use launchd service management." + ;; + Linux) + [ "$(check_wsl)" = "YES" ] && info "Detected WSL environment." + info "Detected service managers:" + for t in ${LINUX_INIT_TYPES}; do + info " - ${t}: $("check_${t}")" + done + info "Would use $(detect_linux_svc_type) service management." + ;; + *) + info "${PLATFORM} is not supported by this script. No service file would be installed." + esac + + exit 0 +} + +# ===================================================================== +# Argument handling + +parse_args() { + while [ -n "${1}" ]; do + case "${1}" in + "--source" | "-s") + SVC_SOURCE="${2}" + shift 1 + ;; + "--type" | "-t") + if [ "${2}" = "help" ]; then + help_types + exit 0 + else + SVC_TYPE="${2}" + shift 1 + fi + ;; + "--show-type") SHOW_SVC_TYPE=1 ; INSTALL=0 ;; + "--save-cmds") + if [ -z "${2}" ]; then + info "No path specified to save command variables." + exit 1 + else + SAVE_CMDS_PATH="${2}" + shift 1 + fi + ;; + "--cmds" | "-c") DUMP_CMDS=1 ;; + "--cmds-only") INSTALL=0 ;; + "--export-cmds") EXPORT_CMDS=1 ;; + "--enable" | "-e") ENABLE="enable" ;; + "--disable" | "-d") ENABLE="disable" ;; + "--help" | "-h") + usage + exit 0 + ;; + *) + info "Unrecognized option '${1}'." + exit 1 + ;; + esac + shift 1 + done + + if [ "${SVC_SOURCE#@}" = "libsysdir_POST@" ]; then + SVC_SOURCE="$(dirname "${SCRIPT_SOURCE}")/../../lib/netdata/system" + warning "SVC_SOURCE not templated, using ${SVC_SOURCE} as source directory." + fi + + if [ ! -d "${SVC_SOURCE}" ] && [ "${INSTALL}" -eq 1 ]; then + error "${SVC_SOURCE} does not appear to be a directory. Please specify a valid source for service files with the --source option." + exit 1 + fi + + if valid_types | grep -vw "${SVC_TYPE}"; then + error "${SVC_TYPE} is not supported on this platform." + help_types + exit 1 + fi +} + +# ===================================================================== +# Core logic + +main() { + trap "cleanup" EXIT + + parse_args "${@}" + + if [ "${SHOW_SVC_TYPE}" -eq 1 ]; then + show_service_type + else + case "${PLATFORM}" in + FreeBSD) + [ "${INSTALL}" -eq 1 ] && install_freebsd_service + freebsd_cmds + ;; + Darwin) + [ "${INSTALL}" -eq 1 ] && install_darwin_service + darwin_cmds + ;; + Linux) + [ "${INSTALL}" -eq 1 ] && install_linux_service + linux_cmds + ;; + *) + error "${PLATFORM} is not supported by this script." + exit 5 + ;; + esac + + [ "${DUMP_CMDS}" -eq 1 ] && dump_cmds + [ "${EXPORT_CMDS}" -eq 1 ] && export_cmds + [ -n "${SAVE_CMDS_PATH}" ] && save_cmds + fi + + exit 0 +} + +main "${@}" diff --git a/system/netdata-freebsd.in b/system/netdata-freebsd.in new file mode 100644 index 0000000..fd544c8 --- /dev/null +++ b/system/netdata-freebsd.in @@ -0,0 +1,53 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-3.0-or-later + +. /etc/rc.subr + +name=netdata +rcvar=netdata_enable + +piddir="@localstatedir_POST@/run/netdata" +pidfile="${piddir}/netdata.pid" + +command="@sbindir_POST@/netdata" +command_args="-P ${pidfile}" + +required_files="@configdir_POST@/netdata.conf" + +start_precmd="netdata_prestart" +stop_postcmd="netdata_poststop" + +extra_commands="reloadhealth savedb" + +reloadhealth_cmd="netdata_reloadhealth" +savedb_cmd="netdata_savedb" + +netdata_prestart() +{ + [ ! -d "${piddir}" ] && mkdir -p "${piddir}" + chown @netdata_user_POST@:@netdata_user_POST@ "${piddir}" + return 0 +} + +netdata_poststop() +{ + [ -f "${pidfile}" ] && rm "${pidfile}" + return 0 +} + +netdata_reloadhealth() +{ + p=`cat ${pidfile}` + kill -USR2 ${p} && echo "Sent USR2 (reload health) to pid ${p}" + return 0 +} + +netdata_savedb() +{ + p=`cat ${pidfile}` + kill -USR2 ${p} && echo "Sent USR1 (save db) to pid ${p}" + return 0 +} + +load_rc_config $name +run_rc_command "$1" diff --git a/system/netdata-init-d.in b/system/netdata-init-d.in new file mode 100644 index 0000000..c0257ff --- /dev/null +++ b/system/netdata-init-d.in @@ -0,0 +1,95 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-3.0-or-later +# +# netdata Real-time performance monitoring, done right +# chkconfig: 345 99 01 +# description: Netdata is a daemon that collects data in real-time (per second) +# and presents a web site to view and analyze them. The presentation +# is also real-time and full of interactive charts that precisely +# render all collected values. +# processname: netdata + +# Source functions +. /etc/rc.d/init.d/functions + +DAEMON="netdata" +DAEMON_PATH=@sbindir_POST@ +PIDFILE_PATH=@localstatedir_POST@/run/netdata +PIDFILE=$PIDFILE_PATH/$DAEMON.pid +DAEMONOPTS="-P $PIDFILE" +STOP_TIMEOUT="60" + +[ -e /etc/sysconfig/$DAEMON ] && . /etc/sysconfig/$DAEMON + +LOCKFILE=/var/lock/subsys/$DAEMON + +service_start() +{ + [ -x $DAEMON_PATH ] || exit 5 + [ ! -d $PIDFILE_PATH ] && mkdir -p $PIDFILE_PATH + chown @netdata_user_POST@:@netdata_user_POST@ $PIDFILE_PATH + echo -n "Starting $DAEMON..." + daemon $DAEMON_PATH/$DAEMON $DAEMONOPTS + RETVAL=$? + echo + [ $RETVAL -eq 0 ] && touch $LOCKFILE + return $RETVAL +} + +service_stop() +{ + printf "%-50s" "Stopping $DAEMON..." + killproc -p ${PIDFILE} -d ${STOP_TIMEOUT} $DAEMON + RETVAL=$? + echo + [ $RETVAL -eq 0 ] && rm -f ${PIDFILE} ${LOCKFILE} + return $RETVAL +} + +condrestart() +{ + if ! service_status > /dev/null; then + RETVAL=$1 + return $RETVAL + fi + + service_stop + service_start +} + +service_status() +{ + status -p ${PIDFILE} $DAEMON_PATH/$DAEMON +} + +service_status_quiet() +{ + status -p ${PIDFILE} $DAEMON_PATH/$DAEMON >/dev/null 2>&1 +} + +case "$1" in +start) + service_status_quiet && exit 0 + service_start +;; +stop) + service_status_quiet || exit 0 + service_stop +;; +restart) + service_stop + service_start +;; +try-restart) + condrestart 0 + ;; +force-reload) + condrestart 7 +;; +status) + service_status +;; +*) + echo "Usage: $0 {start|stop|restart|try-restart|force-reload|status}" + exit 3 +esac diff --git a/system/netdata-lsb.in b/system/netdata-lsb.in new file mode 100644 index 0000000..e429ad1 --- /dev/null +++ b/system/netdata-lsb.in @@ -0,0 +1,116 @@ +#!/usr/bin/env bash +# +# Netdata LSB start script +# +# Copyright: +# SPDX-License-Identifier: GPL-3.0-or-later +# +# Author: +# Costa Tsaousis <costa@netdata.cloud> +# Pavlos Emm. Katsoulakis <paul@netdata.cloud> + +### BEGIN INIT INFO +# Provides: netdata +# Required-Start: $local_fs $remote_fs $network $named $time +# Required-Stop: $local_fs $remote_fs $network $named $time +# Should-Start: $local_fs $network $named $remote_fs $time $all +# Should-Stop: $local_fs $network $named $remote_fs $time $all +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: Start and stop the netdata real-time monitoring server daemon +# Description: Controls the main netdata monitoring server daemon "netdata". +# and all its plugins. +### END INIT INFO +# +set -e +set -u +${DEBIAN_SCRIPT_DEBUG:+ set -v -x} + +DAEMON="netdata" +DAEMON_PATH=@sbindir_POST@ +PIDFILE_PATH=@localstatedir_POST@/run/netdata +PIDFILE=$PIDFILE_PATH/$DAEMON.pid +DAEMONOPTS="-P $PIDFILE" + +test -x $DAEMON_PATH/$DAEMON || exit 0 + +. /lib/lsb/init-functions + +# Safeguard (relative paths, core dumps..) +cd / +umask 022 + +service_start() { + if [ ! -d $PIDFILE_PATH ]; then + mkdir -p $PIDFILE_PATH + fi + + chown @netdata_user_POST@:@netdata_user_POST@ $PIDFILE_PATH + + log_daemon_msg "Starting real-time performance monitoring" "netdata" + start_daemon -p $PIDFILE $DAEMON_PATH/$DAEMON $DAEMONOPTS + RETVAL=$? + log_end_msg $RETVAL + return $RETVAL +} + +service_stop() { + log_daemon_msg "Stopping real-time performance monitoring" "netdata" + killproc -p ${PIDFILE} $DAEMON_PATH/$DAEMON + RETVAL=$? + log_end_msg $RETVAL + + if [ $RETVAL -eq 0 ]; then + rm -f ${PIDFILE} + fi + return $RETVAL +} + +condrestart() { + if ! service_status > /dev/null; then + RETVAL=$1 + return + fi + + service_stop + service_start +} + +service_status() { + status_of_proc -p $PIDFILE $DAEMON_PATH/$DAEMON netdata +} + + +# +# main() +# + +case "${1:-''}" in + 'start') + service_start + ;; + + 'stop') + service_stop + ;; + + 'restart') + service_stop + service_start + ;; + + 'try-restart') + condrestart 0 + ;; + + 'force-reload') + condrestart 7 + ;; + + 'status') + service_status && exit 0 || exit $? + ;; + *) + echo "Usage: $0 {start|stop|restart|try-restart|force-reload|status}" + exit 1 +esac diff --git a/system/netdata-openrc.in b/system/netdata-openrc.in new file mode 100644 index 0000000..1588789 --- /dev/null +++ b/system/netdata-openrc.in @@ -0,0 +1,88 @@ +#!/sbin/openrc-run +# SPDX-License-Identifier: GPL-3.0-or-later + +# The user netdata is configured to run as. +# If you edit its configuration file to set a different +# user, set it here too, to have its files switch ownership +: "${NETDATA_OWNER:=@netdata_user_POST@:@netdata_user_POST@}" + +# The timeout in seconds to wait for netdata +# to save its database on disk and exit. +: "${NETDATA_WAIT_EXIT_TIMEOUT:=60}" + +# When set to 1, if netdata does not exit in +# NETDATA_WAIT_EXIT_TIMEOUT, we will force it +# to exit. +: "${NETDATA_FORCE_EXIT:=0}" + +# When set to 1, we use netdatacli for reload/rotate/save commands instead of s-s-d. +: "${NETDATA_USE_NETDATACLI:=0}" + +# Specifies the pidfile to use when running in the background. +: "${NETDATA_PIDFILE:=@localstatedir_POST@/run/netdata/netdata.pid}" + +extra_started_commands="reload rotate save" +command_prefix="@sbindir_POST@" +command="${command_prefix}/netdata" +command_args="-P ${NETDATA_PIDFILE} ${NETDATA_EXTRA_ARGS}" +command_args_foreground="-D" +start_stop_daemon_args="-u ${NETDATA_OWNER}" +if [ "${NETDATA_FORCE_EXIT}" -eq 1 ]; then + retry="TERM/${NETDATA_WAIT_EXIT_TIMEOUT}/KILL/1" +else + retry="TERM/${NETDATA_WAIT_EXIT_TIMEOUT}" +fi + +depend() { + use logger + need net + after apache2 squid nginx mysql named opensips upsd hostapd postfix lm_sensors +} + +start_pre() { + checkpath -o ${NETDATA_OWNER} -d @localstatedir_POST@/cache/netdata @localstatedir_POST@/run/netdata + + if [ -z "${supervisor}" ]; then + pidfile="${NETDATA_PIDFILE}" + fi +} + +run_cmd() { + cmd="${1}" + msg="${2}" + failmsg="${3}" + signal="${4}" + + ebegin "${msg}" + if [ "${NETDATA_USE_NETDATACLI}" = 1 ]; then + "${command_prefix}/netdatacli" "${cmd}" >/dev/null + eend $? "${failmsg}" + elif [ "${supervisor}" = "supervise-daemon" ]; then + supervise-daemon "${RC_SVCNAME}" --signal "${signal}" + eend $? "${failmsg}" + else + start-stop-daemon --signal "${signal}" --pidfile "${pidfile}" + eend $? "${failmsg}" + fi +} + +reload() { + run_cmd reload-health \ + "Reloading Netdata health configuration" \ + "Failed to reload Netdata health configuration" \ + SIGUSR2 +} + +rotate() { + run_cmd reopen-logs \ + "Reopening Netdata log files" \ + "Failed to reopen Netdata log files" \ + SIGHUP +} + +save() { + run_cmd save-database \ + "Saving Netdata database" \ + "Failed to save Netdata database" \ + SIGUSR1 +} diff --git a/system/netdata-updater.service.in b/system/netdata-updater.service.in new file mode 100644 index 0000000..d0bd499 --- /dev/null +++ b/system/netdata-updater.service.in @@ -0,0 +1,8 @@ +[Unit] +Description=Daily auto-updates for Netdata +RefuseManualStart=no +RefuseManualStop=yes + +[Service] +Type=oneshot +ExecStart=@pkglibexecdir_POST@/netdata-updater.sh diff --git a/system/netdata-updater.timer b/system/netdata-updater.timer new file mode 100644 index 0000000..8b36e46 --- /dev/null +++ b/system/netdata-updater.timer @@ -0,0 +1,12 @@ +[Unit] +Description=Daily auto-updates for Netdata +RefuseManualStart=no +RefuseManualStop=no + +[Timer] +Persistent=false +OnCalendar=daily +Unit=netdata-updater.service + +[Install] +WantedBy=timers.target diff --git a/system/netdata.conf b/system/netdata.conf new file mode 100644 index 0000000..70edb08 --- /dev/null +++ b/system/netdata.conf @@ -0,0 +1,19 @@ +# netdata configuration +# +# You can download the latest version of this file, using: +# +# wget -O /etc/netdata/netdata.conf http://localhost:19999/netdata.conf +# or +# curl -o /etc/netdata/netdata.conf http://localhost:19999/netdata.conf +# +# You can uncomment and change any of the options below. +# The value shown in the commented settings, is the default value. +# + +[global] + run as user = netdata + + # default storage size - increase for longer data retention + page cache size = 32 + dbengine multihost disk space = 256 + diff --git a/system/netdata.crontab.in b/system/netdata.crontab.in new file mode 100644 index 0000000..8f0527e --- /dev/null +++ b/system/netdata.crontab.in @@ -0,0 +1 @@ +2 57 * * * root @pkglibexecdir_POST@/netdata-updater.sh diff --git a/system/netdata.logrotate.in b/system/netdata.logrotate.in new file mode 100644 index 0000000..a766b6c --- /dev/null +++ b/system/netdata.logrotate.in @@ -0,0 +1,12 @@ +@localstatedir_POST@/log/netdata/*.log { + daily + missingok + rotate 14 + compress + delaycompress + notifempty + sharedscripts + postrotate + /bin/kill -HUP `cat @localstatedir_POST@/run/netdata/netdata.pid 2>/dev/null` 2>/dev/null || true + endscript +} diff --git a/system/netdata.plist.in b/system/netdata.plist.in new file mode 100644 index 0000000..a969b31 --- /dev/null +++ b/system/netdata.plist.in @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> +<!-- SPDX-License-Identifier: GPL-3.0-or-later --> +<plist version="1.0"> +<dict> + <key>Label</key> + <string>com.github.netdata</string> + <key>ProgramArguments</key> + <array> + <string>@sbindir_POST@/netdata</string> + </array> + <key>RunAtLoad</key> + <true/> +</dict> +</plist> diff --git a/system/netdata.service.in b/system/netdata.service.in new file mode 100644 index 0000000..3947392 --- /dev/null +++ b/system/netdata.service.in @@ -0,0 +1,76 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Real time performance monitoring + +# append here other services you want netdata to wait for them to start +After=network.target httpd.service squid.service nfs-server.service mysqld.service mysql.service named.service postfix.service chronyd.service + +[Service] +Type=simple +User=@netdata_user_POST@ +Group=netdata +RuntimeDirectory=netdata +RuntimeDirectoryMode=0775 +PIDFile=/run/netdata/netdata.pid +ExecStart=@sbindir_POST@/netdata -P /run/netdata/netdata.pid -D +ExecStartPre=/bin/mkdir -p @localstatedir_POST@/cache/netdata +ExecStartPre=/bin/chown -R @netdata_user_POST@ @localstatedir_POST@/cache/netdata +ExecStartPre=/bin/mkdir -p /run/netdata +ExecStartPre=/bin/chown -R @netdata_user_POST@ /run/netdata +PermissionsStartOnly=true + +# saving a big db on slow disks may need some time +TimeoutStopSec=150 + +# restart netdata if it crashes +Restart=on-failure +RestartSec=30 + +# Valid policies: other (the system default) | batch | idle | fifo | rr +# To give netdata the max priority, set CPUSchedulingPolicy=rr and CPUSchedulingPriority=99 +CPUSchedulingPolicy=batch + +# This sets the scheduling priority (for policies: rr and fifo). +# Priority gets values 1 (lowest) to 99 (highest). +#CPUSchedulingPriority=1 + +# For scheduling policy 'other' and 'batch', this sets the lowest niceness of netdata (-20 highest to 19 lowest). +Nice=0 + +# Capabilities +# is required for freeipmi and slabinfo plugins +CapabilityBoundingSet=CAP_DAC_OVERRIDE +# is required for apps plugin +CapabilityBoundingSet=CAP_DAC_READ_SEARCH +# is required for freeipmi plugin +CapabilityBoundingSet=CAP_FOWNER CAP_SYS_RAWIO +# is required for apps, perf and slabinfo plugins +CapabilityBoundingSet=CAP_SETPCAP +# is required for perf plugin +CapabilityBoundingSet=CAP_SYS_ADMIN CAP_PERFMON +# is required for apps plugin +CapabilityBoundingSet=CAP_SYS_PTRACE +# is required for ebpf plugin +CapabilityBoundingSet=CAP_SYS_RESOURCE +# is required for fping app +CapabilityBoundingSet=CAP_NET_RAW +# is required for cgroups plugin +CapabilityBoundingSet=CAP_SYS_CHROOT +# is required for nfacct plugin (bandwidth accounting) +CapabilityBoundingSet=CAP_NET_ADMIN +# is required for plugins that use sudo +CapabilityBoundingSet=CAP_SETGID CAP_SETUID + +# Sandboxing +ProtectSystem=full +ProtectHome=read-only +# PrivateTmp break netdatacli functionality. See - https://github.com/netdata/netdata/issues/7587 +#PrivateTmp=true +ProtectControlGroups=on +# We whitelist this because it's the standard location to listen on a UNIX socket. +ReadWriteDirectories=/run/netdata +# This is needed to make email-based alert deliver work if Postfix is the email provider on the system. +ReadWriteDirectories=-/var/spool/postfix/maildrop + +[Install] +WantedBy=multi-user.target diff --git a/system/netdata.service.v235.in b/system/netdata.service.v235.in new file mode 100644 index 0000000..dfdf88b --- /dev/null +++ b/system/netdata.service.v235.in @@ -0,0 +1,42 @@ +# SPDX-License-Identifier: GPL-3.0-or-later +[Unit] +Description=Real time performance monitoring + +# append here other services you want netdata to wait for them to start +After=network.target httpd.service squid.service nfs-server.service mysqld.service mysql.service named.service postfix.service chronyd.service + +[Service] +Type=simple +User=netdata +Group=netdata +RuntimeDirectory=netdata +CacheDirectory=netdata +StateDirectory=netdata +LogsDirectory=netdata +RuntimeDirectoryMode=0775 +StateDirectoryMode=0755 +CacheDirectoryMode=0755 +LogsDirectoryMode=2750 +EnvironmentFile=-/etc/default/netdata +ExecStart=/usr/sbin/netdata -D $EXTRA_OPTS + +# saving a big db on slow disks may need some time +TimeoutStopSec=150 + +# restart netdata if it crashes +Restart=on-failure +RestartSec=30 + +# Valid policies: other (the system default) | batch | idle | fifo | rr +# To give netdata the max priority, set CPUSchedulingPolicy=rr and CPUSchedulingPriority=99 +CPUSchedulingPolicy=batch + +# This sets the scheduling priority (for policies: rr and fifo). +# Priority gets values 1 (lowest) to 99 (highest). +#CPUSchedulingPriority=1 + +# For scheduling policy 'other' and 'batch', this sets the lowest niceness of netdata (-20 highest to 19 lowest). +Nice=0 + +[Install] +WantedBy=multi-user.target |