# Copyright 1999-2024 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 EAPI="7" JAVA_PKG_OPT_USE="collectd_plugins_java" LUA_COMPAT=( lua5-{1..4} ) PYTHON_COMPAT=( python3_{10..12} ) inherit autotools fcaps java-pkg-opt-2 linux-info lua-single perl-functions python-single-r1 systemd tmpfiles udev DESCRIPTION="Collects system statistics and provides mechanisms to store the values" HOMEPAGE="https://collectd.org/" SRC_URI="https://github.com/${PN}/${PN}/releases/download/${P}/${P}.tar.bz2" LICENSE="MIT GPL-2 GPL-2+ GPL-3 GPL-3+" SLOT="0" KEYWORDS="~alpha amd64 arm ~arm64 x86" IUSE="contrib debug java perl selinux static-libs udev xfs" # The plugin lists have to follow here since they extend IUSE # Plugins that don't build (e.g. dependencies not in Gentoo) # apple_sensors: Requires libIOKit # amqp1: Requires libqpid-proton # aquaero: Requires aerotools-ng/libaquaero5 # barometer: Requires libi2c (i2c_smbus_read_i2c_block_data) # dpdkevents: Requires dpdk # dpdkstat: Requires dpdk # dpdk_telemetry: Requires dpdk # grpc: Requires libgrpc # intel_pmu: Requires libjevents (pmu-tools) # intel_rdt: Requires libpqos from intel-cmt-cat project # lpar: Requires libperfstat (AIX only) # mic: Requires Intel Many Integrated Core Architecture API # (part of Intel's Xeon Phi software) # netapp: Requires libnetapp (http://communities.netapp.com/docs/DOC-1110) # onewire: Requires sys-fs/owfs which was removed from repository # pf: Requires BSD packet filter # pinba: Requires MySQL Pinba engine (http://pinba.org/) # redfish: Requires libredfish # tape: Requires libkstat (Solaris only) # tokyotyrant: Requires tokyotyrant # write_riemann: Requires riemann-c-client # xmms: Requires libxmms (v1) # zone: Solaris only... COLLECTD_IMPOSSIBLE_PLUGINS="apple_sensors amqp1 aquaero barometer dpdkevents dpdkstat dpdk_telemetry grpc intel_pmu intel_rdt lpar mic netapp onewire pf pinba redfish tape tokyotyrant write_riemann xmms zone" # Plugins that have been (compile) tested and can be enabled via COLLECTD_PLUGINS COLLECTD_TESTED_PLUGINS="aggregation amqp apache apcups ascent battery bind buddyinfo capabilities ceph cgroups check_uptime chrony connectivity conntrack contextswitch cpu cpufreq cpusleep csv curl curl_json curl_xml dbi df disk dns drbd email entropy ethstat exec fhcount filecount fscache gps gpu_nvidia hddtemp hugepages interface ipc ipmi iptables ipvs irq java lua load logfile logparser log_logstash madwifi match_empty_counter match_hashed match_regex match_timediff match_value mbmon mcelog md memcachec memcached memory modbus mqtt multimeter mysql netlink network network nfs nginx notify_desktop notify_email notify_nagios ntpd numa nut olsrd onewire openldap openvpn oracle ovs_events ovs_stats pcie_errors perl ping postgresql powerdns procevent processes protocols python redis routeros rrdcached rrdtool sensors serial sigrok smart snmp snmp_agent statsd swap synproxy sysevent syslog table tail tail_csv target_notification target_replace target_scale target_set tcpconns teamspeak2 ted thermal threshold turbostat ubi unixsock uptime users uuid varnish virt vmem vserver wireless write_graphite write_http write_influxdb_udp write_kafka write_log write_mongodb write_prometheus write_redis write_sensu write_stackdriver write_syslog write_tsdb xencpu zfs_arc zookeeper" COLLECTD_DISABLED_PLUGINS="${COLLECTD_IMPOSSIBLE_PLUGINS}" COLLECTD_ALL_PLUGINS=${COLLECTD_TESTED_PLUGINS} for plugin in ${COLLECTD_ALL_PLUGINS}; do IUSE="${IUSE} collectd_plugins_${plugin}" done unset plugin # Now come the dependencies. COMMON_DEPEND=" acct-group/collectd acct-user/collectd dev-libs/libgcrypt:= dev-libs/libltdl:0= sys-libs/libcap perl? ( dev-lang/perl:=[ithreads] ) udev? ( virtual/udev ) xfs? ( sys-fs/xfsprogs ) collectd_plugins_amqp? ( net-libs/rabbitmq-c ) collectd_plugins_apache? ( net-misc/curl:0= ) collectd_plugins_ascent? ( net-misc/curl:0= dev-libs/libxml2:2= ) collectd_plugins_bind? ( net-misc/curl:0= dev-libs/libxml2:2= ) collectd_plugins_ceph? ( dev-libs/yajl:= ) collectd_plugins_capabilities? ( dev-libs/jansson net-libs/libmicrohttpd:= ) collectd_plugins_connectivity? ( dev-libs/yajl:= net-libs/libmnl ) collectd_plugins_curl? ( net-misc/curl:0= ) collectd_plugins_curl_json? ( net-misc/curl:0= dev-libs/yajl:= ) collectd_plugins_curl_xml? ( net-misc/curl:0= dev-libs/libxml2:2= ) collectd_plugins_dbi? ( dev-db/libdbi ) collectd_plugins_dns? ( net-libs/libpcap ) collectd_plugins_gps? ( sci-geosciences/gpsd:= ) collectd_plugins_gpu_nvidia? ( dev-util/nvidia-cuda-toolkit ) collectd_plugins_ipmi? ( >=sys-libs/openipmi-2.0.16-r1 ) collectd_plugins_iptables? ( >=net-firewall/iptables-1.4.13:0= ) collectd_plugins_log_logstash? ( dev-libs/yajl:= ) collectd_plugins_lua? ( ${LUA_DEPS} ) collectd_plugins_memcachec? ( dev-libs/libmemcached ) collectd_plugins_modbus? ( dev-libs/libmodbus ) collectd_plugins_mqtt? ( app-misc/mosquitto ) collectd_plugins_mysql? ( dev-db/mysql-connector-c:= ) collectd_plugins_netlink? ( net-libs/libmnl ) collectd_plugins_nginx? ( net-misc/curl:0= ) collectd_plugins_notify_desktop? ( x11-libs/libnotify ) collectd_plugins_notify_email? ( net-libs/libesmtp:= ) collectd_plugins_nut? ( >=sys-power/nut-2.7.2-r2 ) collectd_plugins_openldap? ( net-nds/openldap:= ) collectd_plugins_oracle? ( dev-db/oracle-instantclient[sdk] ) collectd_plugins_ovs_events? ( dev-libs/yajl:= ) collectd_plugins_ovs_stats? ( dev-libs/yajl:= ) collectd_plugins_perl? ( dev-lang/perl:=[ithreads] ) collectd_plugins_ping? ( net-libs/liboping ) collectd_plugins_postgresql? ( dev-db/postgresql:= ) collectd_plugins_procevent? ( dev-libs/yajl:= ) collectd_plugins_python? ( ${PYTHON_DEPS} ) collectd_plugins_redis? ( dev-libs/hiredis:= ) collectd_plugins_routeros? ( net-libs/librouteros ) collectd_plugins_rrdcached? ( net-analyzer/rrdtool:= ) collectd_plugins_rrdtool? ( net-analyzer/rrdtool:= ) collectd_plugins_sensors? ( sys-apps/lm-sensors:= ) collectd_plugins_sigrok? ( >=sci-libs/libsigrok-0.4:= dev-libs/glib:2 ) collectd_plugins_smart? ( dev-libs/libatasmart:0= ) collectd_plugins_snmp? ( net-analyzer/net-snmp:= ) collectd_plugins_snmp_agent? ( net-analyzer/net-snmp:= ) collectd_plugins_sysevent? ( dev-libs/yajl:= ) collectd_plugins_varnish? ( www-servers/varnish:= ) collectd_plugins_virt? ( app-emulation/libvirt:= dev-libs/libxml2:2= ) collectd_plugins_write_http? ( net-misc/curl:0= dev-libs/yajl:= ) collectd_plugins_write_kafka? ( >=dev-libs/librdkafka-0.9.0.99:= dev-libs/yajl:= ) collectd_plugins_write_mongodb? ( >=dev-libs/mongo-c-driver-1.8.2:= ) collectd_plugins_write_prometheus? ( >=dev-libs/protobuf-c-1.2.1-r1:= net-libs/libmicrohttpd:= ) collectd_plugins_write_redis? ( dev-libs/hiredis:= ) collectd_plugins_write_stackdriver? ( net-misc/curl:0= dev-libs/yajl:= ) collectd_plugins_xencpu? ( app-emulation/xen-tools:= ) " # FIXME: should virtual/jdk be here as well? BDEPEND="virtual/pkgconfig" # Enforcing !=sys-kernel/linux-headers-4.5 > due to #577846 DEPEND="${COMMON_DEPEND} collectd_plugins_iptables? ( || ( <=sys-kernel/linux-headers-4.4 >=sys-kernel/linux-headers-4.6 ) ) collectd_plugins_java? ( >=virtual/jdk-1.8 )" RDEPEND="${COMMON_DEPEND} collectd_plugins_java? ( >=virtual/jre-1.8 ) collectd_plugins_syslog? ( virtual/logger ) selinux? ( sec-policy/selinux-collectd )" REQUIRED_USE=" collectd_plugins_lua? ( ${LUA_REQUIRED_USE} ) collectd_plugins_python? ( ${PYTHON_REQUIRED_USE} ) collectd_plugins_smart? ( udev ) contrib? ( perl )" PATCHES=( "${FILESDIR}"/${PN}-5.11.0-libsigrok-0.4+.patch "${FILESDIR}"/${PN}-5.12.0-python3_11.patch "${FILESDIR}"/${PN}-5.12.0-clang16-configure.patch "${FILESDIR}"/${PN}-5.12.0-nut-c99.patch ) # @FUNCTION: collectd_plugin_kernel_linux # @DESCRIPTION: # USAGE: # kernel_options is a list of kernel configurations options; the check tests whether at least # one of them is enabled. If no, depending on the third argument an elog, ewarn, or eerror message # is emitted. collectd_plugin_kernel_linux() { local multi_opt opt if has ${1} ${COLLECTD_ALL_PLUGINS}; then if use collectd_plugins_${1}; then for opt in ${2}; do if linux_chkconfig_present ${opt}; then return 0; fi done multi_opt=${2//\ /\ or\ } case ${3} in (info) elog "The ${1} plugin can use kernel features that are disabled now; enable ${multi_opt} in your kernel" ;; (warn) ewarn "The ${1} plugin uses kernel features that are disabled now; enable ${multi_opt} in your kernel" ;; (error) eerror "The ${1} plugin needs kernel features that are disabled now; enable ${multi_opt} in your kernel" ;; (*) die "function collectd_plugin_kernel_linux called with invalid third argument" ;; esac fi fi } collectd_linux_kernel_checks() { if ! linux_chkconfig_present PROC_FS; then ewarn "/proc file system support is disabled, many plugins will not be able to read any statistics from your system unless you enable PROC_FS in your kernel" fi if ! linux_chkconfig_present SYSFS; then ewarn "/sys file system support is disabled, many plugins will not be able to read any statistics from your system unless you enable SYSFS in your kernel" fi # battery.c: /proc/pmu/battery_%i # battery.c: /proc/acpi/battery collectd_plugin_kernel_linux battery ACPI_BATTERY warn # cgroups.c: /sys/fs/cgroup/ collectd_plugin_kernel_linux cgroups CGROUPS warn # cpufreq.c: /sys/devices/system/cpu/cpu%d/cpufreq/ collectd_plugin_kernel_linux cpufreq SYSFS warn collectd_plugin_kernel_linux cpufreq CPU_FREQ_STAT warn # drbd.c: /proc/drbd collectd_plugin_kernel_linux drbd BLK_DEV_DRBD warn # conntrack.c: /proc/sys/net/netfilter/* collectd_plugin_kernel_linux conntrack NETFILTER warn # fscache.c: /proc/fs/fscache/stats collectd_plugin_kernel_linux fscache FSCACHE warn # nfs.c: /proc/net/rpc/nfs # nfs.c: /proc/net/rpc/nfsd collectd_plugin_kernel_linux nfs NFS_COMMON warn # serial.c: /proc/tty/driver/serial # serial.c: /proc/tty/driver/ttyS collectd_plugin_kernel_linux serial SERIAL_CORE warn # swap.c: /proc/meminfo collectd_plugin_kernel_linux swap SWAP warn # thermal.c: /proc/acpi/thermal_zone # thermal.c: /sys/class/thermal collectd_plugin_kernel_linux thermal ACPI_THERMAL warn # turbostat.c: /dev/cpu/%d/msr collectd_plugin_kernel_linux turbostat X86_MSR warn # vmem.c: /proc/vmstat collectd_plugin_kernel_linux vmem VM_EVENT_COUNTERS warn # vserver.c: /proc/virtual collectd_plugin_kernel_linux vserver VSERVER warn # uuid.c: /sys/hypervisor/uuid collectd_plugin_kernel_linux uuid SYSFS info # wireless.c: /proc/net/wireless collectd_plugin_kernel_linux wireless "WIRELESS MAC80211 IEEE80211" warn # zfs_arc.c: /proc/spl/kstat/zfs/arcstats collectd_plugin_kernel_linux zfs_arc "SPL ZFS" warn } pkg_setup() { if use kernel_linux; then linux-info_pkg_setup if linux_config_exists; then einfo "Checking your linux kernel configuration:" collectd_linux_kernel_checks else elog "Cannot find a linux kernel configuration. Continuing anyway." fi fi if use collectd_plugins_java; then java-pkg-opt-2_pkg_setup fi use collectd_plugins_lua && lua-single_pkg_setup use collectd_plugins_python && python-single-r1_pkg_setup } src_prepare() { default # There's some strange prefix handling in the default config file, resulting in # paths like "/usr/var/..." sed -i -e "s:@prefix@/var:/var:g" src/collectd.conf.in || die # Adjust upstream's systemd unit # - Get rid of EnvironmentFile directive; These files don't exist on Gentoo! # - Add User=collectd to run collectd as user "collectd" per default sed -i \ -e '/^EnvironmentFile=.*/d' \ -e '/^\[Service\]/aUser=collectd' \ contrib/systemd.${PN}.service || die eautoreconf } src_configure() { # Now come the lists of os-dependent plugins. Any plugin that is not listed anywhere here # should work independent of the operating system. local linux_plugins="barometer battery cpu cpufreq disk drbd entropy ethstat hugepages interface iptables ipvs irq ipc load memory md netlink nfs numa processes serial swap tcpconns thermal turbostat users vmem wireless zfc_arc" local need_libstatgrab=0 local libstatgrab_plugins="cpu disk interface load memory swap users" local bsd_plugins="cpu tcpconns ${libstatgrab_plugins} zfc_arc" local darwin_plugins="apple_sensors battery cpu disk interface memory processes tcpconns" local osdependent_plugins="${linux_plugins} ${bsd_plugins} ${darwin_plugins}" local myos_plugins="" if use kernel_linux; then einfo "Enabling Linux plugins." myos_plugins=${linux_plugins} elif use kernel_Darwin; then einfo "Enabling Darwin plugins." myos_plugins=${darwin_plugins} fi local myconf="--disable-werror" # Do we debug? myconf+=" $(use_enable debug)" # udev support? # Required for smart plugin via REQUIRED_USE; Optional for disk plugin if use udev; then myconf+=" --with-libudev" else myconf+=" --without-libudev" fi local plugin # Disable what needs to be disabled. for plugin in ${COLLECTD_DISABLED_PLUGINS}; do if [[ "${plugin}" == 'dpdkstat' ]]; then myconf+=" --without-libdpdk" else myconf+=" --disable-${plugin}" fi done # Set enable/disable for each single plugin. for plugin in ${COLLECTD_ALL_PLUGINS}; do if has ${plugin} ${osdependent_plugins}; then # plugin is os-dependent ... if has ${plugin} ${myos_plugins}; then # ... and available in this os myconf+=" $(use_enable collectd_plugins_${plugin} ${plugin})" else # ... and NOT available in this os if use collectd_plugins_${plugin}; then ewarn "You try to enable the ${plugin} plugin, but it is not available for this" ewarn "kernel. Disabling it automatically." fi myconf+=" --disable-${plugin}" fi elif [[ "${plugin}" = "collectd_plugins_perl" ]]; then if use collectd_plugins_perl && ! use perl; then ewarn "Perl plugin disabled as perl bindings disabled by -perl use flag" myconf+= --disable-perl else myconf+=" $(use_enable collectd_plugins_${plugin} ${plugin})" fi else myconf+=" $(use_enable collectd_plugins_${plugin} ${plugin})" fi done if [ "${need_libstatgrab}" -eq 1 ]; then myconf+=" --with-libstatgrab" else myconf+=" --without-libstatgrab" fi # JAVA_HOME is set by eclasses. if use collectd_plugins_java; then myconf+=" --with-java" fi # Need libiptc ONLY for iptables. If we try to use it otherwise bug 340109 happens. # lots of libs are only needed for plugins, if they are disabled, also disable the lib use collectd_plugins_iptables || myconf+=" --with-libiptc=no" use collectd_plugins_openldap || myconf+=" --with-libldap=no" use collectd_plugins_redis || use collectd_plugins_write_redis || myconf+=" --with-libhiredis=no" use collectd_plugins_smart || myconf+=" --with-libatasmart=no" use collectd_plugins_gps || myconf+=" --with-libgps=no" if use collectd_plugins_gpu_nvidia; then myconf+=" --with-cuda=${EPREFIX}/opt/cuda" else myconf+=" --with-cuda=no" fi if use perl; then myconf+=" --with-perl-bindings=INSTALLDIRS=vendor" else myconf+=" --without-perl-bindings" fi # No need for v5upgrade myconf+=" --disable-target_v5upgrade" # Python if use collectd_plugins_python; then myconf+=" --with-libpython=yes" export PYTHON_CONFIG=$(python_get_PYTHON_CONFIG) else myconf+=" --with-libpython=no" fi # XFS support myconf+=" $(use_enable xfs)" # Finally, run econf. KERNEL_DIR="${KERNEL_DIR}" econf --config-cache \ $(use_enable static-libs static) \ --localstatedir=/var ${myconf} } src_install() { emake DESTDIR="${D}" install perl_delete_localpod find "${ED}"/usr/ -name "*.la" -delete || die if use collectd_plugins_java; then java-pkg_regjar "${ED}"/usr/share/${PN}/java/*.jar fi if use collectd_plugins_disk && use udev; then udev_newrules contrib/99-storage-collectd.rules 60-persistent-storage-collectd.rules fi fowners root:collectd /etc/collectd.conf fperms u=rw,g=r,o= /etc/collectd.conf einstalldocs if use contrib; then insinto /usr/share/${PN} doins -r contrib fi keepdir /var/lib/${PN} fowners collectd:collectd /var/lib/${PN} newinitd "${FILESDIR}/${PN}.initd-r3" ${PN} newconfd "${FILESDIR}/${PN}.confd-r2" ${PN} systemd_newunit "contrib/systemd.${PN}.service" ${PN}.service insinto /etc/logrotate.d newins "${FILESDIR}/${PN}.logrotate" ${PN} newtmpfiles "${FILESDIR}"/${PN}.tmpfile ${PN}.conf sed \ -e 's:^.*PIDFile "/var/run/collectd.pid":#PIDFile "/run/collectd.pid":' \ -i "${ED}"/etc/collectd.conf || die sed \ -e 's:^# SocketFile "/var/run/collectd-unixsock":# SocketFile "/run/collectd/collectd.socket":' \ -i "${ED}"/etc/collectd.conf || die sed \ -e 's:^.*LoadPlugin perl$:# The new, correct way to load the perl plugin -- \n# \n# Globals true\n# :' \ -i "${ED}"/etc/collectd.conf || die sed \ -e 's:^.*LoadPlugin python$:# The new, correct way to load the python plugin -- \n# \n# Globals true\n# :' \ -i "${ED}"/etc/collectd.conf || die } pkg_postinst() { tmpfiles_process "${PN}.conf" if use filecaps; then local caps=() use collectd_plugins_ceph && caps+=('CAP_DAC_OVERRIDE') use collectd_plugins_exec && caps+=('CAP_SETUID' 'CAP_SETGID') use collectd_plugins_iptables && caps+=('CAP_NET_ADMIN') use collectd_plugins_filecount && caps+=('CAP_DAC_READ_SEARCH') if use collectd_plugins_dns || use collectd_plugins_ping; then caps+=('CAP_NET_RAW') fi if use collectd_plugins_turbostat || use collectd_plugins_smart; then caps+=('CAP_SYS_RAWIO') fi if [ ${#caps[@]} -gt 0 ]; then local caps_str=$(IFS=","; echo "${caps[*]}") fcaps ${caps_str} usr/sbin/collectd elog "Capabilities for ${EROOT}/usr/sbin/collectd set to:" elog " ${caps_str}+EP" elog local systemd_unit="$(systemd_get_systemunitdir)/collectd.service" if [[ -e "${systemd_unit}" ]]; then caps_str="${caps[*]}" sed -i -e "s:^CapabilityBoundingSet=.*:CapabilityBoundingSet=${caps_str}:" "${systemd_unit}" || \ die "Failed to set CapabilityBoundingSet in '${systemd_unit}'" elog "CapabilityBoundingSet in '${systemd_unit}'" elog "updated to match capabilities set above." elog else if has_version "sys-apps/systemd"; then # Bug 596852 ewarn "Failed to update CapabilityBoundingSet in '${systemd_unit}'" ewarn "because unit was not found. Please file a bug about this." fi fi fi fi elog "Note: Collectd is only the collector." elog " You need to install 'data' sources (applications) locally or" elog " remotely on your own." elog elog "Collectd is configured to run as unprivileged user by default." elog "You may want to revisit the configuration." elog if use collectd_plugins_email; then ewarn "The email plug-in is deprecated. To submit statistics please use the unixsock plugin." fi if use collectd_plugins_smart; then elog "" elog "If you are using smart plugin and don't run collectd as root make sure" elog "that the collectd user is allowed to access the disk you want to monitor" elog "(can be done via udev rule for example) and that collectd has the required" elog "capabilities set (which is the default when package was emerged with" elog "'filecaps' USE flag set)." fi if use contrib; then elog "The scripts in /usr/share/doc/${PF}/collection3 for generating graphs need dev-perl/HTML-Parser," elog "dev-perl/CGI, dev-perl/Config-General and net-analyzer/rrdtool[perl] to be installed." fi }