#!/usr/bin/env bash #shellcheck disable=SC2001 # netdata # real-time performance and health monitoring, done right! # (C) 2016 Costa Tsaousis # SPDX-License-Identifier: GPL-3.0-or-later # # Script to find a better name for cgroups # export PATH="${PATH}:/sbin:/usr/sbin:/usr/local/sbin" export LC_ALL=C # ----------------------------------------------------------------------------- PROGRAM_NAME="$(basename "${0}")" logdate() { date "+%Y-%m-%d %H:%M:%S" } log() { local status="${1}" shift echo >&2 "$(logdate): ${PROGRAM_NAME}: ${status}: ${*}" } warning() { log WARNING "${@}" } error() { log ERROR "${@}" } info() { log INFO "${@}" } fatal() { log FATAL "${@}" exit 1 } function docker_like_get_name_command() { local command="${1}" local id="${2}" info "Running command: ${command} ps --filter=id=\"${id}\" --format=\"{{.Names}}\"" NAME="$(${command} ps --filter=id="${id}" --format="{{.Names}}")" return 0 } function docker_like_get_name_api() { local host_var="${1}" local host="${!host_var}" local path="/containers/${2}/json" if [ -z "${host}" ]; then warning "No ${host_var} is set" return 1 fi if ! command -v jq > /dev/null 2>&1; then warning "Can't find jq command line tool. jq is required for netdata to retrieve container name using ${host} API, falling back to docker ps" return 1 fi if [ -S "${host}" ]; then info "Running API command: curl --unix-socket \"${host}\" http://localhost${path}" JSON=$(curl -sS --unix-socket "${host}" "http://localhost${path}") else info "Running API command: curl \"${host}${path}\"" JSON=$(curl -sS "${host}${path}") fi NAME=$(echo "${JSON}" | jq -r .Name,.Config.Hostname | grep -v null | head -n1 | sed 's|^/||') return 0 } # get_lbl_val returns the value for the label with the given name. # Returns "null" string if the label doesn't exist. # Expected labels format: 'name="value",...'. function get_lbl_val() { local labels want_name labels="${1}" want_name="${2}" IFS=, read -ra labels <<< "$labels" local lname lval for l in "${labels[@]}"; do IFS="=" read -r lname lval <<< "$l" if [ "$want_name" = "$lname" ] && [ -n "$lval" ]; then echo "${lval:1:-1}" # trim " return 0 fi done echo "null" return 1 } function add_lbl_prefix() { local orig_labels prefix orig_labels="${1}" prefix="${2}" IFS=, read -ra labels <<< "$orig_labels" local new_labels for l in "${labels[@]}"; do new_labels+="${prefix}${l}," done echo "${new_labels:0:-1}" # trim last ',' } # k8s_get_kubepod_name resolves */kubepods/* cgroup name. # pod level cgroup name format: 'pod__' # container level cgroup name format: 'cntr___' function k8s_get_kubepod_name() { # GKE /sys/fs/cgroup/*/ tree: # |-- kubepods # | |-- burstable # | | |-- pod98cee708-023b-11eb-933d-42010a800193 # | | | |-- 922161c98e6ea450bf665226cdc64ca2aa3e889934c2cff0aec4325f8f78ac03 # | | `-- a5d223eec35e00f5a1c6fa3e3a5faac6148cdc1f03a2e762e873b7efede012d7 # | `-- pode314bbac-d577-11ea-a171-42010a80013b # | |-- 7d505356b04507de7b710016d540b2759483ed5f9136bb01a80872b08f771930 # | `-- 88ab4683b99cfa7cc8c5f503adf7987dd93a3faa7c4ce0d17d419962b3220d50 # # Minikube (v1.8.2) /sys/fs/cgroup/*/ tree: # |-- kubepods.slice # | |-- kubepods-besteffort.slice # | | |-- kubepods-besteffort-pod10fb5647_c724_400c_b9cc_0e6eae3110e7.slice # | | | |-- docker-36e5eb5056dfdf6dbb75c0c44a1ecf23217fe2c50d606209d8130fcbb19fb5a7.scope # | | | `-- docker-87e18c2323621cf0f635c53c798b926e33e9665c348c60d489eef31ee1bd38d7.scope # # NOTE: cgroups plugin uses '_' to join dir names, so it is ___... local fn="${FUNCNAME[0]}" local id="${1}" if [[ ! $id =~ ^kubepods ]]; then warning "${fn}: '${id}' is not kubepod cgroup." return 1 fi local clean_id="$id" clean_id=${clean_id//.slice/} clean_id=${clean_id//.scope/} local name pod_uid cntr_id if [[ $clean_id == "kubepods" ]]; then name="$clean_id" elif [[ $clean_id =~ .+(besteffort|burstable|guaranteed)$ ]]; then # kubepods_ # kubepods_kubepods- name=${clean_id//-/_} name=${name/#kubepods_kubepods/kubepods} elif [[ $clean_id =~ .+pod[a-f0-9_-]+_docker-([a-f0-9]+)$ ]]; then # ...pod_docker- (POD_UID w/ "_") cntr_id=${BASH_REMATCH[1]} elif [[ $clean_id =~ .+pod[a-f0-9-]+_([a-f0-9]+)$ ]]; then # ...pod_ cntr_id=${BASH_REMATCH[1]} elif [[ $clean_id =~ .+pod([a-f0-9_-]+)$ ]]; then # ...pod (POD_UID w/ and w/o "_") pod_uid=${BASH_REMATCH[1]} pod_uid=${pod_uid//_/-} fi if [ -n "$name" ]; then echo "$name" return 0 fi if [ -z "$pod_uid" ] && [ -z "$cntr_id" ]; then warning "${fn}: can't extract pod_uid or container_id from the cgroup '$id'." return 1 fi [ -n "$pod_uid" ] && info "${fn}: cgroup '$id' is a pod(uid:$pod_uid)" [ -n "$cntr_id" ] && info "${fn}: cgroup '$id' is a container(id:$cntr_id)" if ! command -v jq > /dev/null 2>&1; then warning "${fn}: 'jq' command not available." return 1 fi local kube_system_ns local tmp_kube_system_ns_file="${TMPDIR:-"/tmp/"}netdata-cgroups-kube-system-ns" [ -f "$tmp_kube_system_ns_file" ] && kube_system_ns=$(cat "$tmp_kube_system_ns_file" 2> /dev/null) local pods if [ -n "${KUBERNETES_SERVICE_HOST}" ] && [ -n "${KUBERNETES_PORT_443_TCP_PORT}" ]; then local token header host url token="$(< /var/run/secrets/kubernetes.io/serviceaccount/token)" header="Authorization: Bearer $token" host="$KUBERNETES_SERVICE_HOST:$KUBERNETES_PORT_443_TCP_PORT" if [ -z "$kube_system_ns" ]; then url="https://$host/api/v1/namespaces/kube-system" # FIX: check HTTP response code if ! kube_system_ns=$(curl -sSk -H "$header" "$url" 2>&1); then warning "${fn}: error on curl '${url}': ${kube_system_ns}." else echo "$kube_system_ns" > "$tmp_kube_system_ns_file" 2> /dev/null fi fi url="https://$host/api/v1/pods" [ -n "$MY_NODE_NAME" ] && url+="?fieldSelector=spec.nodeName==$MY_NODE_NAME" # FIX: check HTTP response code if ! pods=$(curl -sSk -H "$header" "$url" 2>&1); then warning "${fn}: error on curl '${url}': ${pods}." return 1 fi elif ps -C kubelet > /dev/null 2>&1 && command -v kubectl > /dev/null 2>&1; then if [ -z "$kube_system_ns" ]; then if ! kube_system_ns=$(kubectl get namespaces kube-system -o json 2>&1); then warning "${fn}: error on 'kubectl': ${kube_system_ns}." else echo "$kube_system_ns" > "$tmp_kube_system_ns_file" 2> /dev/null fi fi [[ -z ${KUBE_CONFIG+x} ]] && KUBE_CONFIG="/etc/kubernetes/admin.conf" if ! pods=$(kubectl --kubeconfig="$KUBE_CONFIG" get pods --all-namespaces -o json 2>&1); then warning "${fn}: error on 'kubectl': ${pods}." return 1 fi else warning "${fn}: not inside the k8s cluster and 'kubectl' command not available." return 1 fi local kube_system_uid if [ -n "$kube_system_ns" ] && ! kube_system_uid=$(jq -r '.metadata.uid' <<< "$kube_system_ns" 2>&1); then warning "${fn}: error on 'jq' parse kube_system_ns: ${kube_system_uid}." fi local jq_filter jq_filter+='.items[] | "' jq_filter+='namespace=\"\(.metadata.namespace)\",' jq_filter+='pod_name=\"\(.metadata.name)\",' jq_filter+='pod_uid=\"\(.metadata.uid)\",' #jq_filter+='\(.metadata.labels | to_entries | map("pod_label_"+.key+"=\""+.value+"\"") | join(",") | if length > 0 then .+"," else . end)' jq_filter+='\((.metadata.ownerReferences[]? | select(.controller==true) | "controller_kind=\""+.kind+"\",controller_name=\""+.name+"\",") // "")' jq_filter+='node_name=\"\(.spec.nodeName)\",' jq_filter+='" + ' jq_filter+='(.status.containerStatuses[]? | "' jq_filter+='container_name=\"\(.name)\",' jq_filter+='container_id=\"\(.containerID)\"' jq_filter+='") | ' jq_filter+='sub("docker://";"")' # containerID: docker://a346da9bc0e3eaba6b295f64ac16e02f2190db2cef570835706a9e7a36e2c722 local containers if ! containers=$(jq -r "${jq_filter}" <<< "$pods" 2>&1); then warning "${fn}: error on 'jq' parse pods: ${containers}." return 1 fi # available labels: # namespace, pod_name, pod_uid, container_name, container_id, node_name local labels if [ -n "$cntr_id" ]; then if labels=$(grep "$cntr_id" <<< "$containers" 2> /dev/null); then labels+=',kind="container"' [ -n "$kube_system_uid" ] && [ "$kube_system_uid" != "null" ] && labels+=",cluster_id=\"$kube_system_uid\"" name="cntr" name+="_$(get_lbl_val "$labels" namespace)" name+="_$(get_lbl_val "$labels" pod_name)" name+="_$(get_lbl_val "$labels" container_name)" labels=$(add_lbl_prefix "$labels" "k8s_") name+=" $labels" fi elif [ -n "$pod_uid" ]; then if labels=$(grep "$pod_uid" -m 1 <<< "$containers" 2> /dev/null); then labels="${labels%%,container_*}" labels+=',kind="pod"' [ -n "$kube_system_uid" ] && [ "$kube_system_uid" != "null" ] && labels+=",cluster_id=\"$kube_system_uid\"" name="pod" name+="_$(get_lbl_val "$labels" namespace)" name+="_$(get_lbl_val "$labels" pod_name)" labels=$(add_lbl_prefix "$labels" "k8s_") name+=" $labels" fi fi # jq filter nonexistent field and nonexistent label value is 'null' if [[ $name =~ _null(_|$) ]]; then warning "${fn}: invalid name: $name (cgroup '$id')" name="" fi echo "$name" [ -n "$name" ] return } function k8s_get_name() { local fn="${FUNCNAME[0]}" local id="${1}" NAME=$(k8s_get_kubepod_name "$id") if [ -z "${NAME}" ]; then warning "${fn}: cannot find the name of cgroup with id '${id}'. Setting name to ${id} and disabling it." NAME="${id}" NAME_NOT_FOUND=3 else NAME="k8s_${NAME}" local name labels name=${NAME%% *} labels=${NAME#* } if [ "$name" != "$labels" ]; then info "${fn}: cgroup '${id}' has chart name '${name}', labels '${labels}" else info "${fn}: cgroup '${id}' has chart name '${NAME}'" fi fi } function docker_get_name() { local id="${1}" if hash docker 2> /dev/null; then docker_like_get_name_command docker "${id}" else docker_like_get_name_api DOCKER_HOST "${id}" || docker_like_get_name_command podman "${id}" fi if [ -z "${NAME}" ]; then warning "cannot find the name of docker container '${id}'" NAME_NOT_FOUND=2 NAME="${id:0:12}" else info "docker container '${id}' is named '${NAME}'" fi } function docker_validate_id() { local id="${1}" if [ -n "${id}" ] && { [ ${#id} -eq 64 ] || [ ${#id} -eq 12 ]; }; then docker_get_name "${id}" else error "a docker id cannot be extracted from docker cgroup '${CGROUP}'." fi } function podman_get_name() { local id="${1}" # for Podman, prefer using the API if we can, as netdata will not normally have access # to other users' containers, so they will not be visible when running `podman ps` docker_like_get_name_api PODMAN_HOST "${id}" || docker_like_get_name_command podman "${id}" if [ -z "${NAME}" ]; then warning "cannot find the name of podman container '${id}'" NAME_NOT_FOUND=2 NAME="${id:0:12}" else info "podman container '${id}' is named '${NAME}'" fi } function podman_validate_id() { local id="${1}" if [ -n "${id}" ] && [ ${#id} -eq 64 ]; then podman_get_name "${id}" else error "a podman id cannot be extracted from docker cgroup '${CGROUP}'." fi } # ----------------------------------------------------------------------------- [ -z "${NETDATA_USER_CONFIG_DIR}" ] && NETDATA_USER_CONFIG_DIR="@configdir_POST@" [ -z "${NETDATA_STOCK_CONFIG_DIR}" ] && NETDATA_STOCK_CONFIG_DIR="@libconfigdir_POST@" DOCKER_HOST="${DOCKER_HOST:=/var/run/docker.sock}" PODMAN_HOST="${PODMAN_HOST:=/run/podman/podman.sock}" CGROUP="${1}" NAME_NOT_FOUND=0 NAME= # ----------------------------------------------------------------------------- if [ -z "${CGROUP}" ]; then fatal "called without a cgroup name. Nothing to do." fi for CONFIG in "${NETDATA_USER_CONFIG_DIR}/cgroups-names.conf" "${NETDATA_STOCK_CONFIG_DIR}/cgroups-names.conf"; do if [ -f "${CONFIG}" ]; then NAME="$(grep "^${CGROUP} " "${CONFIG}" | sed 's/[[:space:]]\+/ /g' | cut -d ' ' -f 2)" if [ -z "${NAME}" ]; then info "cannot find cgroup '${CGROUP}' in '${CONFIG}'." else break fi #else # info "configuration file '${CONFIG}' is not available." fi done if [ -z "${NAME}" ]; then if [[ ${CGROUP} =~ ^.*kubepods.* ]]; then k8s_get_name "${CGROUP}" fi fi if [ -z "${NAME}" ]; then if [[ ${CGROUP} =~ ^.*docker[-_/\.][a-fA-F0-9]+[-_\.]?.*$ ]]; then # docker containers #shellcheck disable=SC1117 DOCKERID="$(echo "${CGROUP}" | sed "s|^.*docker[-_/]\([a-fA-F0-9]\+\)[-_\.]\?.*$|\1|")" docker_validate_id "${DOCKERID}" elif [[ ${CGROUP} =~ ^.*ecs[-_/\.][a-fA-F0-9]+[-_\.]?.*$ ]]; then # ECS #shellcheck disable=SC1117 DOCKERID="$(echo "${CGROUP}" | sed "s|^.*ecs[-_/].*[-_/]\([a-fA-F0-9]\+\)[-_\.]\?.*$|\1|")" docker_validate_id "${DOCKERID}" elif [[ ${CGROUP} =~ ^.*libpod-[a-fA-F0-9]+.*$ ]]; then # Podman PODMANID="$(echo "${CGROUP}" | sed "s|^.*libpod-\([a-fA-F0-9]\+\).*$|\1|")" podman_validate_id "${PODMANID}" elif [[ ${CGROUP} =~ machine.slice[_/].*\.service ]]; then # systemd-nspawn NAME="$(echo "${CGROUP}" | sed 's/.*machine.slice[_\/]\(.*\)\.service/\1/g')" elif [[ ${CGROUP} =~ machine.slice_machine.*-qemu ]]; then # libvirtd / qemu virtual machines # NAME="$(echo ${CGROUP} | sed 's/machine.slice_machine.*-qemu//; s/\/x2d//; s/\/x2d/\-/g; s/\.scope//g')" NAME="qemu_$(echo "${CGROUP}" | sed 's/machine.slice_machine.*-qemu//; s/\/x2d[[:digit:]]*//; s/\/x2d//g; s/\.scope//g')" elif [[ ${CGROUP} =~ machine_.*\.libvirt-qemu ]]; then # libvirtd / qemu virtual machines NAME="qemu_$(echo "${CGROUP}" | sed 's/^machine_//; s/\.libvirt-qemu$//; s/-/_/;')" elif [[ ${CGROUP} =~ qemu.slice_([0-9]+).scope && -d /etc/pve ]]; then # Proxmox VMs FILENAME="/etc/pve/qemu-server/${BASH_REMATCH[1]}.conf" if [[ -f $FILENAME && -r $FILENAME ]]; then NAME="qemu_$(grep -e '^name: ' "/etc/pve/qemu-server/${BASH_REMATCH[1]}.conf" | head -1 | sed -rn 's|\s*name\s*:\s*(.*)?$|\1|p')" else error "proxmox config file missing ${FILENAME} or netdata does not have read access. Please ensure netdata is a member of www-data group." fi elif [[ ${CGROUP} =~ lxc_([0-9]+) && -d /etc/pve ]]; then # Proxmox Containers (LXC) FILENAME="/etc/pve/lxc/${BASH_REMATCH[1]}.conf" if [[ -f ${FILENAME} && -r ${FILENAME} ]]; then NAME=$(grep -e '^hostname: ' "/etc/pve/lxc/${BASH_REMATCH[1]}.conf" | head -1 | sed -rn 's|\s*hostname\s*:\s*(.*)?$|\1|p') else error "proxmox config file missing ${FILENAME} or netdata does not have read access. Please ensure netdata is a member of www-data group." fi elif [[ ${CGROUP} =~ lxc.payload.* ]]; then # LXC 4.0 NAME="$(echo "${CGROUP}" | sed 's/lxc\.payload\.\(.*\)/\1/g')" fi [ -z "${NAME}" ] && NAME="${CGROUP}" [ ${#NAME} -gt 100 ] && NAME="${NAME:0:100}" fi info "cgroup '${CGROUP}' is called '${NAME}'" echo "${NAME}" exit ${NAME_NOT_FOUND}