diff options
| author | Ilya Mashchenko <ilya@netdata.cloud> | 2020-02-12 12:30:39 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-12 12:30:39 +0300 |
| commit | 162b78443a0a48bf0c012da094760375b755173e (patch) | |
| tree | f90590ae32042ca4ba893eea98a7ecd36e8d9213 | |
| parent | f0ee98c1b6877cfa709a06784383dfc5f905d901 (diff) | |
/collectors/charts.d.plugin: remove deprecated modules (#7962)
* /collectors/charts.d.plugin: skip obsolete modules during loading
* /collectors/charts.d.plugin: remove apache
* /collectors/charts.d.plugin: remove cpu_apps
* /collectors/charts.d.plugin: remove cpufreq
* /collectors/charts.d.plugin: remove exim
* /collectors/charts.d.plugin: remove hddtemp
* /collectors/charts.d.plugin: remove load_average
* /collectors/charts.d.plugin: remove mem_apps
* /collectors/charts.d.plugin: remove mysql
* /collectors/charts.d.plugin: remove nginx
* /collectors/charts.d.plugin: remove phpfpm
* /collectors/charts.d.plugin: remove postfix
* /collectors/charts.d.plugin: remove sensors
* /collectors/charts.d.plugin: remove squid
* /collectors/charts.d.plugin: remove tomcat
* /collectors/charts.d.plugin: update charts.d.conf
* Revert "/collectors/charts.d.plugin: remove sensors"
This reverts commit e3388853
* /collectors/charts.d.plugin: add sensors to Makefile.am
* /docs: remove obsolete modules from Add-more-charts-to-netdata.md
* /docs/generator: remove obsolete modules from buildyaml.sh
* /collectors/charts.d.plugin: remove sensors from obsolete_charts
* /collectors/charts.d.plugin: better debug msg for obsolete modules
* /collectors/charts.d.plugin: better debug msg for obsolete modules
* /collectors/charts.d.plugin: use `replaced by` instead of `obsolete by`
* add BREAKING_CHANGES.md and mention removing deprecated bash modules there
58 files changed, 25 insertions, 2805 deletions
diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md new file mode 100644 index 0000000000..5b741ad54b --- /dev/null +++ b/BREAKING_CHANGES.md @@ -0,0 +1,3 @@ +# Breaking Changes + +- remove deprecated bash modules (`apache`, `cpu_apps`, `cpufreq`, `exim`, `hddtemp`, `load_average`, `mem_apps`, `mysql`, `nginx`, `phpfpm`, `postfix`, `squid`, `tomcat`) [[#7962](https://github.com/netdata/netdata/pull/7962)] diff --git a/collectors/charts.d.plugin/Makefile.am b/collectors/charts.d.plugin/Makefile.am index 618fd5dd63..03c7f0a949 100644 --- a/collectors/charts.d.plugin/Makefile.am +++ b/collectors/charts.d.plugin/Makefile.am @@ -42,22 +42,9 @@ dist_chartsconfig_DATA = \ $(NULL) include ap/Makefile.inc -include apache/Makefile.inc include apcupsd/Makefile.inc -include cpu_apps/Makefile.inc -include cpufreq/Makefile.inc include example/Makefile.inc -include exim/Makefile.inc -include hddtemp/Makefile.inc include libreswan/Makefile.inc -include load_average/Makefile.inc -include mem_apps/Makefile.inc -include mysql/Makefile.inc -include nginx/Makefile.inc include nut/Makefile.inc include opensips/Makefile.inc -include phpfpm/Makefile.inc -include postfix/Makefile.inc include sensors/Makefile.inc -include squid/Makefile.inc -include tomcat/Makefile.inc diff --git a/collectors/charts.d.plugin/apache/Makefile.inc b/collectors/charts.d.plugin/apache/Makefile.inc deleted file mode 100644 index 4b360eae05..0000000000 --- a/collectors/charts.d.plugin/apache/Makefile.inc +++ /dev/null @@ -1,13 +0,0 @@ -# SPDX-License-Identifier: GPL-3.0-or-later - -# THIS IS NOT A COMPLETE Makefile -# IT IS INCLUDED BY ITS PARENT'S Makefile.am -# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT - -# install these files -dist_charts_DATA += apache/apache.chart.sh -dist_chartsconfig_DATA += apache/apache.conf - -# do not install these files, but include them in the distribution -dist_noinst_DATA += apache/README.md apache/Makefile.inc - diff --git a/collectors/charts.d.plugin/apache/README.md b/collectors/charts.d.plugin/apache/README.md deleted file mode 100644 index 53f02a5b85..0000000000 --- a/collectors/charts.d.plugin/apache/README.md +++ /dev/null @@ -1,129 +0,0 @@ -# Apache - -> THIS MODULE IS OBSOLETE. -> USE [THE PYTHON ONE](../../python.d.plugin/apache) - IT SUPPORTS MULTIPLE JOBS AND IT IS MORE EFFICIENT - ---- - -The `apache` collector visualizes key performance data for an apache web server. - -## Example Netdata charts - -For apache 2.2: - - - -For apache 2.4: - - - -## How it works - -It runs `curl "http://apache.host/server-status?auto` to fetch the current status of apache. - -It has been tested with apache 2.2 and apache 2.4. The latter also provides connections information (total and break down by status). - -Apache 2.2 response: - -```sh -curl "http://127.0.0.1/server-status?auto" -Total Accesses: 80057 -Total kBytes: 223017 -CPULoad: .018287 -Uptime: 64472 -ReqPerSec: 1.24173 -BytesPerSec: 3542.15 -BytesPerReq: 2852.59 -BusyWorkers: 1 -IdleWorkers: 49 -Scoreboard: _________________________......................................._W_______________________....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................... -``` - -Apache 2.4 response: - -```sh -curl "http://127.0.0.1/server-status?auto" -127.0.0.1 -ServerVersion: Apache/2.4.18 (Unix) -ServerMPM: event -Server Built: Dec 14 2015 08:05:54 -CurrentTime: Saturday, 23-Jan-2016 14:42:06 EET -RestartTime: Saturday, 23-Jan-2016 04:57:13 EET -ParentServerConfigGeneration: 2 -ParentServerMPMGeneration: 1 -ServerUptimeSeconds: 35092 -ServerUptime: 9 hours 44 minutes 52 seconds -Load1: 0.32 -Load5: 0.32 -Load15: 0.27 -Total Accesses: 32403 -Total kBytes: 34464 -CPUUser: 30.37 -CPUSystem: 29.55 -CPUChildrenUser: 0 -CPUChildrenSystem: 0 -CPULoad: .170751 -Uptime: 35092 -ReqPerSec: .923373 -BytesPerSec: 1005.67 -BytesPerReq: 1089.13 -BusyWorkers: 1 -IdleWorkers: 99 -ConnsTotal: 0 -ConnsAsyncWriting: 0 -ConnsAsyncKeepAlive: 0 -ConnsAsyncClosing: 0 -Scoreboard: __________________________________________________________________________________________W_________............................................................................................................................................................................................................................................................................................................ -``` - -From the apache status output it collects: - -- total accesses (incremental value, rendered as requests/s) -- total bandwidth (incremental value, rendered as bandwidth/s) -- requests per second (this appears to be calculated by apache as an average for its lifetime, while the one calculated by Netdata using the total accesses counter is real-time) -- bytes per second (average for the lifetime of the apache server) -- bytes per request (average for the lifetime of the apache server) -- workers by status (`busy` and `idle`) -- total connections (currently active connections - offered by apache 2.4+) -- async connections per status (`keepalive`, `writing`, `closing` - offered by apache 2.4+) - -## Configuration - -The configuration is stored in `/etc/netdata/charts.d/apache.conf`. -To edit this file on your system run `/etc/netdata/edit-config charts.d/apache.conf`. - -The internal default is: - -```sh -# the URL your apache server is responding with mod_status information. -apache_url="http://127.0.0.1:80/server-status?auto" - -# use this to set custom curl options you may need -apache_curl_opts= - -# set this to a NUMBER to overwrite the update frequency -# it is in seconds -apache_update_every= -``` - -The default `apache_update_every` is configured in Netdata. - -## Auto-detection - -If you have configured your apache server to offer server-status information on localhost clients, the defaults should work fine. - -## Apache Configuration - -Apache configuration differs between distributions. Please check your distribution's documentation for information on enabling apache's `mod_status` module. - -If you are able to run successfully, by hand this command: - -```sh -curl "http://127.0.0.1:80/server-status?auto" -``` - -Netdata will be able to do it too. - -Notice: You may need to have the default `000-default.conf` website enabled in order for the status mod to work. - -[](<>) diff --git a/collectors/charts.d.plugin/apache/apache.chart.sh b/collectors/charts.d.plugin/apache/apache.chart.sh deleted file mode 100644 index 7d09ee6767..0000000000 --- a/collectors/charts.d.plugin/apache/apache.chart.sh +++ /dev/null @@ -1,251 +0,0 @@ -# shellcheck shell=bash -# no need for shebang - this file is loaded from charts.d.plugin -# SPDX-License-Identifier: GPL-3.0-or-later - -# netdata -# real-time performance and health monitoring, done right! -# (C) 2016 Costa Tsaousis <costa@tsaousis.gr> -# - -# the URL to download apache status info -apache_url="http://127.0.0.1:80/server-status?auto" -apache_curl_opts= - -# _update_every is a special variable - it holds the number of seconds -# between the calls of the _update() function -apache_update_every= - -apache_priority=60000 - -# convert apache floating point values -# to integer using this multiplier -# this only affects precision - the values -# will be in the proper units -apache_decimal_detail=1000000 - -declare -a apache_response=() -apache_accesses=0 -apache_kbytes=0 -apache_reqpersec=0 -apache_bytespersec=0 -apache_bytesperreq=0 -apache_busyworkers=0 -apache_idleworkers=0 -apache_connstotal=0 -apache_connsasyncwriting=0 -apache_connsasynckeepalive=0 -apache_connsasyncclosing=0 - -apache_keys_detected=0 -apache_has_conns=0 -apache_key_accesses= -apache_key_kbytes= -apache_key_reqpersec= -apache_key_bytespersec= -apache_key_bytesperreq= -apache_key_busyworkers= -apache_key_idleworkers= -apache_key_scoreboard= -apache_key_connstotal= -apache_key_connsasyncwriting= -apache_key_connsasynckeepalive= -apache_key_connsasyncclosing= -apache_detect() { - local i=0 - for x in "${@}"; do - case "${x}" in - 'Total Accesses') apache_key_accesses=$((i + 1)) ;; - 'Total kBytes') apache_key_kbytes=$((i + 1)) ;; - 'ReqPerSec') apache_key_reqpersec=$((i + 1)) ;; - 'BytesPerSec') apache_key_bytespersec=$((i + 1)) ;; - 'BytesPerReq') apache_key_bytesperreq=$((i + 1)) ;; - 'BusyWorkers') apache_key_busyworkers=$((i + 1)) ;; - 'IdleWorkers') apache_key_idleworkers=$((i + 1)) ;; - 'ConnsTotal') apache_key_connstotal=$((i + 1)) ;; - 'ConnsAsyncWriting') apache_key_connsasyncwriting=$((i + 1)) ;; - 'ConnsAsyncKeepAlive') apache_key_connsasynckeepalive=$((i + 1)) ;; - 'ConnsAsyncClosing') apache_key_connsasyncclosing=$((i + 1)) ;; - 'Scoreboard') apache_key_scoreboard=$((i)) ;; - esac - - i=$((i + 1)) - done - - # we will not check of the Conns* - # keys, since these are apache 2.4 specific - [ -z "${apache_key_accesses}" ] && error "missing 'Total Accesses' from apache server: ${*}" && return 1 - [ -z "${apache_key_kbytes}" ] && error "missing 'Total kBytes' from apache server: ${*}" && return 1 - [ -z "${apache_key_reqpersec}" ] && error "missing 'ReqPerSec' from apache server: ${*}" && return 1 - [ -z "${apache_key_bytespersec}" ] && error "missing 'BytesPerSec' from apache server: ${*}" && return 1 - [ -z "${apache_key_bytesperreq}" ] && error "missing 'BytesPerReq' from apache server: ${*}" && return 1 - [ -z "${apache_key_busyworkers}" ] && error "missing 'BusyWorkers' from apache server: ${*}" && return 1 - [ -z "${apache_key_idleworkers}" ] && error "missing 'IdleWorkers' from apache server: ${*}" && return 1 - [ -z "${apache_key_scoreboard}" ] && error "missing 'Scoreboard' from apache server: ${*}" && return 1 - - if [ ! -z "${apache_key_connstotal}" ] && - [ ! -z "${apache_key_connsasyncwriting}" ] && - [ ! -z "${apache_key_connsasynckeepalive}" ] && - [ ! -z "${apache_key_connsasyncclosing}" ]; then - apache_has_conns=1 - else - apache_has_conns=0 - fi - - return 0 -} - -apache_get() { - local oIFS="${IFS}" ret - # shellcheck disable=2207 - IFS=$':\n' apache_response=($(run curl -Ss ${apache_curl_opts} "${apache_url}")) - ret=$? - IFS="${oIFS}" - - if [ $ret -ne 0 ] || [ "${#apache_response[@]}" -eq 0 ]; then - return 1 - fi - - # the last line on the apache output is "Scoreboard" - # we use this label to detect that the output has a new word count - if [ ${apache_keys_detected} -eq 0 ] || [ "${apache_response[${apache_key_scoreboard}]}" != "Scoreboard" ]; then - apache_detect "${apache_response[@]}" || return 1 - apache_keys_detected=1 - fi - - apache_accesses="${apache_response[${apache_key_accesses}]}" - apache_kbytes="${apache_response[${apache_key_kbytes}]}" - - float2int "${apache_response[${apache_key_reqpersec}]}" ${apache_decimal_detail} - apache_reqpersec=${FLOAT2INT_RESULT} - - float2int "${apache_response[${apache_key_bytespersec}]}" ${apache_decimal_detail} - apache_bytespersec=${FLOAT2INT_RESULT} - - float2int "${apache_response[${apache_key_bytesperreq}]}" ${apache_decimal_detail} - apache_bytesperreq=${FLOAT2INT_RESULT} - - apache_busyworkers="${apache_response[${apache_key_busyworkers}]}" - apache_idleworkers="${apache_response[${apache_key_idleworkers}]}" - - if - [ -z "${apache_accesses}" ] || - [ -z "${apache_kbytes}" ] || - [ -z "${apache_reqpersec}" ] || - [ -z "${apache_bytespersec}" ] || - [ -z "${apache_bytesperreq}" ] || - [ -z "${apache_busyworkers}" ] - [ -z "${apache_idleworkers}" ] - then - error "empty values got from apache server: ${apache_response[*]}" - return 1 - fi - - if [ ${apache_has_conns} -eq 1 ]; then - apache_connstotal="${apache_response[${apache_key_connstotal}]}" - apache_connsasyncwriting="${apache_response[${apache_key_connsasyncwriting}]}" - apache_connsasynckeepalive="${apache_response[${apache_key_connsasynckeepalive}]}" - apache_connsasyncclosing="${apache_response[${apache_key_connsasyncclosing}]}" - fi - - return 0 -} - -# _check is called once, to find out if this chart should be enabled or not -apache_check() { - - apache_get - # shellcheck disable=2181 - if [ $? -ne 0 ]; then - # shellcheck disable=2154 - error "cannot find stub_status on URL '${apache_url}'. Please set apache_url='http://apache.server:80/server-status?auto' in $confd/apache.conf" - return 1 - fi - - # this should return: - # - 0 to enable the chart - # - 1 to disable the chart - - return 0 -} - -# _create is called once, to create the charts -apache_create() { - cat <<EOF -CHART apache_local.bytesperreq '' "apache Lifetime Avg. Response Size" "bytes/request" statistics apache.bytesperreq area $((apache_priority + 8)) $apache_update_every -DIMENSION size '' absolute 1 ${apache_decimal_detail} -CHART apache_local.workers '' "apache Workers" "workers" workers apache.workers stacked $((apache_priority + 5)) $apache_update_every -DIMENSION idle '' absolute 1 1 -DIMENSION busy '' absolute 1 1 -CHART apache_local.reqpersec '' "apache Lifetime Avg. Requests/s" "requests/s" statistics apache.reqpersec line $((apache_priority + 6)) $apache_update_every -DIMENSION requests '' absolute 1 ${apache_decimal_detail} -CHART apache_local.bytespersec '' "apache Lifetime Avg. Bandwidth/s" "kilobits/s" statistics apache.bytespersec area $((apache_priority + 7)) $apache_update_every -DIMENSION sent '' absolute 8 $((apache_decimal_detail * 1000)) -CHART apache_local.requests '' "apache Requests" "requests/s" requests apache.requests line $((apache_priority + 1)) $apache_update_every -DIMENSION requests '' incremental 1 1 -CHART apache_local.net '' "apache Bandwidth" "kilobits/s" bandwidth apache.net area $((apache_priority + 3)) $apache_update_every -DIMENSION sent '' incremental 8 1 -EOF - - if [ ${apache_has_conns} -eq 1 ]; then - cat <<EOF2 -CHART apache_local.connections '' "apache Connections" "connections" connections apache.connections line $((apache_priority + 2)) $apache_update_every -DIMENSION connections '' absolute 1 1 -CHART apache_local.conns_async '' "apache Async Connections" "connections" connections apache.conns_async stacked $((apache_priority + 4)) $apache_update_every -DIMENSION keepalive '' absolute 1 1 -DIMENSION closing '' absolute 1 1 -DIMENSION writing '' absolute 1 1 -EOF2 - fi - - return 0 -} - -# _update is called continuously, to collect the values -apache_update() { - # the first argument to this function is the microseconds since last update - # pass this parameter to the BEGIN statement (see bellow). - - # do all the work to collect / calculate the values - # for each dimension - # remember: KEEP IT SIMPLE AND SHORT - - apache_get || return 1 - - # write the result of the work. - cat <<VALUESEOF -BEGIN apache_local.requests $1 -SET requests = $((apache_accesses)) -END -BEGIN apache_local.net $1 -SET sent = $((apache_kbytes)) -END -BEGIN apache_local.reqpersec $1 -SET requests = $((apache_reqpersec)) -END -BEGIN apache_local.bytespersec $1 -SET sent = $((apache_bytespersec)) -END -BEGIN apache_local.bytesperreq $1 -SET size = $((apache_bytesperreq)) -END -BEGIN apache_local.workers $1 -SET idle = $((apache_idleworkers)) -SET busy = $((apache_busyworkers)) -END -VALUESEOF - - if [ ${apache_has_conns} -eq 1 ]; then - cat <<VALUESEOF2 -BEGIN apache_local.connections $1 -SET connections = $((apache_connstotal)) -END -BEGIN apache_local.conns_async $1 -SET keepalive = $((apache_connsasynckeepalive)) -SET closing = $((apache_connsasyncclosing)) -SET writing = $((apache_connsasyncwriting)) -END -VALUESEOF2 - fi - - return 0 -} diff --git a/collectors/charts.d.plugin/apache/apache.conf b/collectors/charts.d.plugin/apache/apache.conf deleted file mode 100644 index 50914cf320..0000000000 --- a/collectors/charts.d.plugin/apache/apache.conf +++ /dev/null @@ -1,30 +0,0 @@ -# no need for shebang - this file is loaded from charts.d.plugin - -# netdata -# real-time performance and health monitoring, done right! -# (C) 2018 Costa Tsaousis <costa@tsaousis.gr> -# GPL v3+ - -# THIS PLUGIN IS DEPRECATED -# USE THE PYTHON.D ONE - -# the URL to download apache status info -#apache_url="http://127.0.0.1:80/server-status?auto" |