diff --git a/README.md b/README.md index 81bcb88..69f6021 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This software is free to use and is licensed under the [Apache 2.0 License](LICE - Example dashboards are provided in the [doc/](doc) folder, which can be imported into your Grafana installation. - Screenshots are available in the [downloads](https://bitbucket.org/mnellemann/sysmon/downloads/) section. -![Sysmon Icon](doc/monitoring-eye-svgrepo-com.png) +![Sysmon Icon](doc/monitoring-eye-320x320.png) ## Components @@ -15,17 +15,18 @@ Runs on your hosts and collects metrics, which are sent to the central *server*. [More information](client/README.md). +### Plugins + +Loaded by the *client* and provides extensions for doing the actual collecting of metrics. + +[More information](plugins/README.md). + ### Server Receives aggregated metrics from *clients* and saves these into InfluxDB. [More information](server/README.md). -### Plugins - -Loaded by the *client* and provides extensions for doing the actual collecting of metrics. - -[More information](plugins/README.md). ## Known problems diff --git a/client/README.md b/client/README.md index d5d165a..2d23ac9 100644 --- a/client/README.md +++ b/client/README.md @@ -1,6 +1,12 @@ # Client -Client component. +This is the client component of SysMon. Install on the hosts for which you want to collect metrics. + +## Installation + +Download *.deb* or *.rpm* packages for sysmon-client *and* sysmon-plugins, and install. + +See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions. ## Development diff --git a/client/build.gradle b/client/build.gradle index d838cd0..71b6bd9 100644 --- a/client/build.gradle +++ b/client/build.gradle @@ -3,9 +3,9 @@ import org.redline_rpm.header.Os plugins { id 'application' - id "com.github.johnrengelman.shadow" version "7.0.0" - id "net.nemerosa.versioning" version "2.14.0" - id "nebula.ospackage" version "8.6.1" + id "com.github.johnrengelman.shadow" version "7.1.0" + id "net.nemerosa.versioning" version "2.15.1" + id "nebula.ospackage" version "9.0.0" } dependencies { diff --git a/client/doc/AIX.md b/client/doc/AIX.md index cea5076..db4374e 100644 --- a/client/doc/AIX.md +++ b/client/doc/AIX.md @@ -13,9 +13,4 @@ rpm -i --ignoreos sysmon-client.rpm sysmon-plugins.rpm ## Run automatically at boot -Change the *sysmon-server* URL for your environment. - -```shell -mkitab 'sysmon:2:respawn:env JAVA_HOME=/usr/java8_64 /opt/sysmon/client/bin/client -s http://10.20.30.40:9925/metrics >/tmp/sysmon.log 2>&1' -init q -``` +See the [sysv-init.md](sysv-init.md) file for instructions. \ No newline at end of file diff --git a/client/doc/sysmon-client.service b/client/doc/sysmon-client.service index cee5c52..e6e25d9 100644 --- a/client/doc/sysmon-client.service +++ b/client/doc/sysmon-client.service @@ -2,6 +2,8 @@ Description=Sysmon Client Service [Service] +#User=nobody +#Group=nobody TimeoutSec=20 Restart=on-failure ExecStart=/opt/sysmon/client/bin/client -s http://10.20.30.40:9925/metrics diff --git a/client/doc/sysmon-client.sh b/client/doc/sysmon-client.sh new file mode 100644 index 0000000..e958d1f --- /dev/null +++ b/client/doc/sysmon-client.sh @@ -0,0 +1,100 @@ +#!/bin/sh +### BEGIN INIT INFO +# Provides: +# Required-Start: $remote_fs $syslog +# Required-Stop: $remote_fs $syslog +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: Start daemon at boot time +# Description: Enable service provided by daemon. +### END INIT INFO + +dir="/opt/sysmon/client" +cmd="/opt/sysmon/client/bin/client" +args="-s http://10.20.30.40:9925/metrics" +user="" + +name=`basename $0` +pid_file="/var/run/$name.pid" +stdout_log="/var/log/$name.log" +stderr_log="/var/log/$name.err" + +get_pid() { + cat "$pid_file" +} + +is_running() { + [ -f "$pid_file" ] && ps -p `get_pid` > /dev/null 2>&1 +} + +case "$1" in + start) + if is_running; then + echo "Already started" + else + echo "Starting $name" + cd "$dir" + if [ -z "$user" ]; then + $cmd $args >> "$stdout_log" 2>> "$stderr_log" & + else + sudo -u "$user" $cmd $args >> "$stdout_log" 2>> "$stderr_log" & + fi + echo $! > "$pid_file" + if ! is_running; then + echo "Unable to start, see $stdout_log and $stderr_log" + exit 1 + fi + fi + ;; + stop) + if is_running; then + echo -n "Stopping $name.." + kill `get_pid` + for i in 1 2 3 4 5 6 7 8 9 10 + # for i in `seq 10` + do + if ! is_running; then + break + fi + + echo -n "." + sleep 1 + done + echo + + if is_running; then + echo "Not stopped; may still be shutting down or shutdown may have failed" + exit 1 + else + echo "Stopped" + if [ -f "$pid_file" ]; then + rm "$pid_file" + fi + fi + else + echo "Not running" + fi + ;; + restart) + $0 stop + if is_running; then + echo "Unable to stop, will not attempt to start" + exit 1 + fi + $0 start + ;; + status) + if is_running; then + echo "Running" + else + echo "Stopped" + exit 1 + fi + ;; + *) + echo "Usage: $0 {start|stop|restart|status}" + exit 1 + ;; +esac + +exit 0 diff --git a/client/doc/sysv-init.md b/client/doc/sysv-init.md new file mode 100644 index 0000000..909ddb7 --- /dev/null +++ b/client/doc/sysv-init.md @@ -0,0 +1,6 @@ +# SysV init Notes + +- Copy the *sysmon-client.sh* into *sysmon-client* in the correct location for init scripts on your operating system. +- Edit the file to specify sysmon-server URL in the *args* variable. +- SymLink to the required run-levels. + diff --git a/client/src/main/java/sysmon/client/Application.java b/client/src/main/java/sysmon/client/Application.java index 22ee7ec..7756c9d 100644 --- a/client/src/main/java/sysmon/client/Application.java +++ b/client/src/main/java/sysmon/client/Application.java @@ -8,9 +8,8 @@ import org.slf4j.impl.SimpleLogger; import picocli.CommandLine; import java.io.File; -import java.io.IOException; -import java.net.InetAddress; import java.net.URL; +import java.net.InetAddress; import java.net.UnknownHostException; import java.util.concurrent.Callable; @@ -40,7 +39,7 @@ public class Application implements Callable { @Override - public Integer call() throws IOException { + public Integer call() { String sysmonDebug = System.getProperty("sysmon.debug"); if(sysmonDebug != null || enableDebug) { @@ -61,7 +60,7 @@ public class Application implements Callable { try { hostname = InetAddress.getLocalHost().getHostName(); } catch (UnknownHostException e) { - System.err.println("Could not detect hostname. Use the '-n' or '--hostname' option to specify it."); + System.err.println("Could not detect hostname. Use the '-n' or '--hostname' option to specify."); return -1; } } diff --git a/doc/ansible/README.md b/doc/ansible/README.md deleted file mode 100644 index a89fbd8..0000000 --- a/doc/ansible/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Example Ansible Playbooks - -For installing on AIX and RPM-based Linux. \ No newline at end of file diff --git a/doc/ansible/sysmon-client-aix.yml b/doc/ansible/sysmon-client-aix.yml deleted file mode 100644 index 785177f..0000000 --- a/doc/ansible/sysmon-client-aix.yml +++ /dev/null @@ -1,63 +0,0 @@ ---- -# -# Example ansible playbook for installation of sysmon client on AIX. -# More information at: https://bitbucket.org/mnellemann/sysmon -# -# ansible-galaxy collection install community.general -# ansible-playbook -i aixhost, -u root sysmon-client-aix.yml -# -# NOTE: Ensure correct timezone and time - -- name: "Install Sysmon Client and Plugins on AIX" - hosts: all - gather_facts: yes - vars: - server_url: http://sysmon-server:9925/metrics - - tasks: - - - name: Sysmon Client | Ensure hostname resolves - ansible.builtin.lineinfile: - path: /etc/hosts - state: present - line: "127.0.1.1 {{ ansible_hostname }}" - - - name: Sysmon Client | Copy sysmon-client.rpm - ansible.builtin.copy: - src: "{{ item }}" - dest: /opt/sysmon-client.rpm - with_fileglob: - - ../../client/build/distributions/sysmon-client-*.noarch.rpm - - - name: Sysmon Client | Copy sysmon-plugins.rpm - ansible.builtin.copy: - src: "{{ item }}" - dest: /opt/sysmon-plugins.rpm - with_fileglob: - - ../../plugins/build/distributions/sysmon-plugins-*.noarch.rpm - - - name: Sysmon Client | Install sysmon-client.rpm - ansible.builtin.command: /usr/bin/rpm -i --ignoreos /opt/sysmon-client.rpm - args: - creates: /opt/sysmon/client - - - name: Sysmon Client | Install sysmon-plugins.rpm - ansible.builtin.command: /usr/bin/rpm -i --ignoreos /opt/sysmon-plugins.rpm - args: - creates: /opt/sysmon/plugins - - - name: Sysmon Client | Create inittab entry for sysmon-client - community.general.aix_inittab: - name: sysmon - runlevel: '2' - action: respawn - command: env JAVA_HOME=/usr/java8_64 /opt/sysmon/client/bin/client -s {{ server_url }} >/tmp/sysmon.log 2>&1 - state: present - become: yes - notify: - - reload inittab - - handlers: - - - name: reload inittab - command: init q diff --git a/doc/ansible/sysmon-client-linux.yml b/doc/ansible/sysmon-client-linux.yml deleted file mode 100644 index 4bfcb0d..0000000 --- a/doc/ansible/sysmon-client-linux.yml +++ /dev/null @@ -1,61 +0,0 @@ ---- -# -# Example ansible playbook for installation of sysmon client on Linux (RPM based). -# More information at: https://bitbucket.org/mnellemann/sysmon -# -# ansible-playbook -i linuxhost, -u root sysmon-client-linux.yml -# -# NOTE: Ensure correct timezone and time - -- name: "Install Sysmon Client and Plugins on Linux (RPM based)" - hosts: all - gather_facts: no - vars: - server_url: http://sysmon-server:9925/metrics - - tasks: - - - name: Sysmon Client | Copy sysmon-client.rpm - ansible.builtin.copy: - src: "{{ item }}" - dest: /opt/sysmon-client.rpm - with_fileglob: - - ../../client/build/distributions/sysmon-client-*.noarch.rpm - - - name: Sysmon Client | Copy sysmon-plugins.rpm - ansible.builtin.copy: - src: "{{ item }}" - dest: /opt/sysmon-plugins.rpm - with_fileglob: - - ../../plugins/build/distributions/sysmon-plugins-*.noarch.rpm - - - name: Sysmon Client | Install OpenJDK (headless) - yum: - name: "java-11-openjdk-headless" - state: present - - - name: Sysmon Client | Install sysmon-client.rpm - yum: - name: /opt/sysmon-client.rpm - state: present - disable_gpg_check: true - - - name: Sysmon Plugins | Install sysmon-plugins.rpm - yum: - name: /opt/sysmon-plugins.rpm - state: present - disable_gpg_check: true - - - name: Sysmon Client | Create service file - template: src=sysmon-client.service.j2 dest=/lib/systemd/system/sysmon-client.service mode=644 - notify: - - reload systemctl - - - name: Sysmon Client | Start service - service: name=sysmon-client.service state=started enabled=yes - - - handlers: - - - name: reload systemctl - command: systemctl daemon-reload diff --git a/doc/ansible/templates/sysmon-client.service.j2 b/doc/ansible/templates/sysmon-client.service.j2 deleted file mode 100644 index 25ea9a2..0000000 --- a/doc/ansible/templates/sysmon-client.service.j2 +++ /dev/null @@ -1,10 +0,0 @@ -[Unit] -Description=Sysmon Client Service - -[Service] -TimeoutStartSec=3 -Restart=always -ExecStart=/opt/sysmon/client/bin/client -s {{server_url}} - -[Install] -WantedBy=default.target diff --git a/doc/ansible/timezone-aix.yml b/doc/ansible/timezone-aix.yml deleted file mode 100644 index 97c426a..0000000 --- a/doc/ansible/timezone-aix.yml +++ /dev/null @@ -1,33 +0,0 @@ ---- -# -# Example ansible playbook for timezone and NTP setup on AIX. -# -# ansible-playbook -i aixhost, -u root timezone-aix.yml -# - -- name: "Timezone and NTP on AIX" - hosts: all - gather_facts: no - vars: - timezone: Europe/Copenhagen - ntp_server: dk.pool.ntp.org - - tasks: - - - name: Configure timezone - ansible.builtin.replace: - path: /etc/environment - regexp: '^TZ=(.*)$' - replace: "TZ={{ timezone }}" - - - name: Update time from NTP server - ansible.builtin.command: "env TZ={{ timezone }} /usr/sbin/ntpdate {{ ntp_server }}" - - - name: Create cron entry for updating time periodically - ansible.builtin.cron: - name: ntpdate - weekday: "*" - minute: "1" - hour: "*" - user: root - job: "/usr/sbin/ntpdate {{ ntp_server }}" diff --git a/doc/monitoring-eye-320x320.png b/doc/monitoring-eye-320x320.png new file mode 100644 index 0000000..b76724a Binary files /dev/null and b/doc/monitoring-eye-320x320.png differ diff --git a/doc/monitoring-eye-svgrepo-com.png b/doc/monitoring-eye-512x512.png similarity index 100% rename from doc/monitoring-eye-svgrepo-com.png rename to doc/monitoring-eye-512x512.png diff --git a/gradle.properties b/gradle.properties index f44dec5..6f8fccf 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,6 @@ -version=0.1.6 +version=0.1.7 pf4jVersion=3.6.0 slf4jVersion=1.7.32 -camelVersion=3.11.3 -picocliVersion=4.6.1 -oshiVersion=5.8.3 \ No newline at end of file +camelVersion=3.14.0 +picocliVersion=4.6.2 +oshiVersion=5.8.6 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e708b1c..7454180 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 0f80bbf..d2880ba 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.2-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index 4f906e0..1b6c787 100755 --- a/gradlew +++ b/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015-2021 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,67 +17,101 @@ # ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar @@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -106,80 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi -fi - -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi - -# For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi - # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" - fi - i=`expr $i + 1` - done - case $i in - 0) set -- ;; - 1) set -- "$args0" ;; - 2) set -- "$args0" "$args1" ;; - 3) set -- "$args0" "$args1" "$args2" ;; - 4) set -- "$args0" "$args1" "$args2" "$args3" ;; - 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=`save "$@"` +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/plugins/README.md b/plugins/README.md index 6e6b5b9..38ebedf 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -2,6 +2,6 @@ Collection of standard sysmon plugins. -- [base](os-base/) - base OS metrics +- [base](os-base/) - Base OS metrics (through [oshi](https://github.com/oshi/oshi)) - [aix](os-aix/) - AIX (and Power) specific metrics - [linux](os-linux/) - Linux specific metrics \ No newline at end of file diff --git a/plugins/build.gradle b/plugins/build.gradle index c5919ca..858482f 100644 --- a/plugins/build.gradle +++ b/plugins/build.gradle @@ -1,7 +1,7 @@ import org.redline_rpm.header.Os plugins { - id "nebula.ospackage" version "8.6.1" + id "nebula.ospackage" version "9.0.0" } @@ -48,7 +48,7 @@ subprojects { attributes( 'Plugin-Id' : "${pluginId}", 'Plugin-Class' : "${pluginClass}", - 'Plugin-Version' : "${version}", + 'Plugin-Version' : "${archiveVersion}", 'Plugin-Provider' : "System Monitor", 'Plugin-Description': "${pluginDescription}" ) diff --git a/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixNetstatExtension.java b/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixNetstatExtension.java index ee29f75..b797305 100644 --- a/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixNetstatExtension.java +++ b/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixNetstatExtension.java @@ -83,8 +83,8 @@ public class AixNetstatExtension implements MetricExtension { @Override public MetricResult getMetrics() throws Exception { - HashMap tagsMap = null; - HashMap fieldsMap = null; + HashMap tagsMap; + HashMap fieldsMap; try (InputStream buf = PluginHelper.executeCommand("netstat -s -f inet")) { AixNetstatParser parser = processCommandOutput(buf); diff --git a/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixProcessorStat.java b/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixProcessorStat.java index 7c4f576..18daf4c 100644 --- a/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixProcessorStat.java +++ b/plugins/os-aix/src/main/java/sysmon/plugins/os_aix/AixProcessorStat.java @@ -86,8 +86,8 @@ public class AixProcessorStat { //String lparstat = lines.get(lines.size() -1); String[] splitStr = Objects.requireNonNull(lastLine).trim().split("\\s+"); - if(type.equalsIgnoreCase("shared") && splitStr.length < 9 || - type.equalsIgnoreCase("dedicated") && splitStr.length < 8) { + if(type == null || (type.equalsIgnoreCase("shared") && splitStr.length < 9) || + (type.equalsIgnoreCase("dedicated") && splitStr.length < 8) ) { throw new UnsupportedOperationException("lparstat string error: " + lastLine); } diff --git a/plugins/os-base/README.md b/plugins/os-base/README.md index e0790fe..8470b4e 100644 --- a/plugins/os-base/README.md +++ b/plugins/os-base/README.md @@ -40,7 +40,7 @@ Metrics reported are: ## Filesystem Extension ### Metrics -- + - **free_bytes** - Free bytes for filesystem. - **total_bytes** - Total bytes for filesystem. - **free_inoed** - Free inodes for filesystem. diff --git a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseDetailsExtension.java b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseDetailsExtension.java index e03640f..912e6bf 100644 --- a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseDetailsExtension.java +++ b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseDetailsExtension.java @@ -4,15 +4,11 @@ import org.pf4j.Extension; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import oshi.SystemInfo; -import oshi.hardware.HWDiskStore; -import oshi.hardware.HardwareAbstractionLayer; import sysmon.shared.Measurement; import sysmon.shared.MetricExtension; import sysmon.shared.MetricResult; -import java.util.ArrayList; import java.util.HashMap; -import java.util.List; import java.util.Map; @Extension diff --git a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseNetstatExtension.java b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseNetstatExtension.java index 3f57f33..bf1a383 100644 --- a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseNetstatExtension.java +++ b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BaseNetstatExtension.java @@ -4,15 +4,11 @@ import org.pf4j.Extension; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import oshi.SystemInfo; -import oshi.hardware.HWDiskStore; -import oshi.hardware.HardwareAbstractionLayer; import sysmon.shared.Measurement; import sysmon.shared.MetricExtension; import sysmon.shared.MetricResult; -import java.util.ArrayList; import java.util.HashMap; -import java.util.List; import java.util.Map; @Extension diff --git a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BasePlugin.java b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BasePlugin.java index 4be658b..18eb6e5 100644 --- a/plugins/os-base/src/main/java/sysmon/plugins/os_base/BasePlugin.java +++ b/plugins/os-base/src/main/java/sysmon/plugins/os_base/BasePlugin.java @@ -4,6 +4,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.pf4j.Plugin; import org.pf4j.PluginWrapper; +import oshi.PlatformEnum; import oshi.SystemInfo; import oshi.hardware.HardwareAbstractionLayer; @@ -30,7 +31,8 @@ public class BasePlugin extends Plugin { } } catch (UnsupportedOperationException e) { - log.warn(e.getMessage()); + log.warn("getHardwareAbstractionLayer() - {}", e.getMessage()); + return null; } return hardwareAbstractionLayer; @@ -43,9 +45,10 @@ public class BasePlugin extends Plugin { if(systemInfo == null) { systemInfo = new SystemInfo(); } - + systemInfo.getOperatingSystem(); } catch (UnsupportedOperationException e) { - log.warn(e.getMessage()); + log.warn("getSystemInfo() - {}", e.getMessage()); + return null; } return systemInfo; diff --git a/plugins/os-ibmi/README.md b/plugins/os-ibmi/README.md index b13f57d..c191c34 100644 --- a/plugins/os-ibmi/README.md +++ b/plugins/os-ibmi/README.md @@ -1,4 +1,4 @@ # IBM i Plugin -TODO. Nothing here yet. +This is just for testing purposes. diff --git a/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/IbmIPlugin.java b/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/IbmIPlugin.java index c622954..e7c1fb9 100644 --- a/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/IbmIPlugin.java +++ b/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/IbmIPlugin.java @@ -1,18 +1,66 @@ package sysmon.plugins.os_ibmi; +import com.ibm.as400.access.AS400; +import com.ibm.as400.access.SystemStatus; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.pf4j.Plugin; import org.pf4j.PluginWrapper; +import oshi.SystemInfo; +import oshi.hardware.HardwareAbstractionLayer; public class IbmIPlugin extends Plugin { private static final Logger log = LoggerFactory.getLogger(IbmIPlugin.class); + private static SystemStatus systemStatus; + private static AS400 as400; + public IbmIPlugin(PluginWrapper wrapper) { super(wrapper); } + + public static SystemStatus getSystemStatus() { + + try { + if (as400 == null) { + as400 = IbmIPlugin.getAS400(); + } + if(systemStatus == null) { + systemStatus = new SystemStatus(as400); + } + } catch (Exception exception) { + log.error("getSystemStatus() - {}", exception.getMessage()); + return null; + } + + return systemStatus; + } + + + public static AS400 getAS400() { + + String osArch = System.getProperty("os.arch").toLowerCase(); + String osName = System.getProperty("os.name").toLowerCase(); + + if(!osArch.equals("ppc64") && !osName.equals("os/400")) { + log.info("getAS400() - OS Arch: {}", osArch); + log.info("getAS400() - OS Name: {}", osName); + return null; + } + + try { + as400 = new AS400("localhost", "*CURRENT"); + //as400 = new AS400("10.32.64.142"); + } catch (Exception exception) { + log.error("getAS400() - {}", exception.getMessage()); + return null; + } + + return as400; + } + } diff --git a/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/TestExtension.java b/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/TestExtension.java index 01aff11..74080dd 100644 --- a/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/TestExtension.java +++ b/plugins/os-ibmi/src/main/java/sysmon/plugins/os_ibmi/TestExtension.java @@ -4,13 +4,14 @@ import com.ibm.as400.access.*; import org.pf4j.Extension; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import sysmon.shared.Measurement; import sysmon.shared.MetricExtension; import sysmon.shared.MetricResult; import java.io.IOException; +import java.util.HashMap; import java.util.Map; -// Disable for now... //@Extension public class TestExtension implements MetricExtension { @@ -25,7 +26,6 @@ public class TestExtension implements MetricExtension { private boolean enabled = true; private boolean threaded = false; - private AS400 as400; private SystemStatus systemStatus; @@ -41,29 +41,8 @@ public class TestExtension implements MetricExtension { @Override public boolean isSupported() { - - String osArch = System.getProperty("os.arch").toLowerCase(); - String osName = System.getProperty("os.name").toLowerCase(); - - System.err.println("OS Arch: " + osArch); - System.err.println("OS Name: " + osName); - - try { - //as400 = new AS400("localhost", "CURRENT"); - as400 = new AS400("10.32.64.142"); - systemStatus = new SystemStatus(as400); - } catch (Exception exception) { - log.error(exception.getMessage()); - } - - if(as400.isLocal()) { - log.info("as400 isLocal() true"); - } else { - log.info("as400 isLocal() FALSE"); - } - - - return true; + systemStatus = IbmIPlugin.getSystemStatus(); + return systemStatus != null; } @Override @@ -101,22 +80,32 @@ public class TestExtension implements MetricExtension { try { int jobsInSystem = systemStatus.getJobsInSystem(); - log.info("Jobs In System: " + jobsInSystem); + log.info("Jobs In System: {}", jobsInSystem); int batchJobsRunning = systemStatus.getBatchJobsRunning(); - log.info("Batch Jobs Running: " + batchJobsRunning); + log.info("Batch Jobs Running: {}", batchJobsRunning); int activeThreads = systemStatus.getActiveThreadsInSystem(); - log.info("Active Threads: " + activeThreads); + log.info("Active Threads: {}", activeThreads); int activeJobs = systemStatus.getActiveJobsInSystem(); - log.info("Active Jobs: " + activeJobs); + log.info("Active Jobs: {}", activeJobs); int onlineUsers = systemStatus.getUsersCurrentSignedOn(); - log.info("Online Users: " + onlineUsers); + log.info("Online Users: {}", onlineUsers); + + HashMap fieldsMap = new HashMap() {{ + put("jobs_total", jobsInSystem); + put("jobs_running", batchJobsRunning); + put("jobs_active", activeJobs); + put("threads", activeThreads); + put("users", onlineUsers); + + }}; + return new MetricResult(name, new Measurement(new HashMap<>(), fieldsMap)); } catch (AS400SecurityException | ErrorCompletingRequestException | InterruptedException | IOException | ObjectDoesNotExistException e) { - log.error(e.getMessage()); + log.error("getMetrics() {}", e.getMessage()); e.printStackTrace(); } diff --git a/server/README.md b/server/README.md index 4546314..0947758 100644 --- a/server/README.md +++ b/server/README.md @@ -1,10 +1,12 @@ # Server -Server component. +This is the server component of SysMon. ## Installation -TODO. +Download *.deb* or *.rpm* package and install. + +See the [doc/systemd.md](doc/systemd.md) or [doc/sysv-init.md](doc/sysv-init.md) files for further instructions. ### Influx Database diff --git a/server/build.gradle b/server/build.gradle index e0f95b3..dab05f6 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -3,9 +3,9 @@ import org.redline_rpm.header.Os plugins { id 'application' - id "com.github.johnrengelman.shadow" version "7.0.0" - id "net.nemerosa.versioning" version "2.14.0" - id "nebula.ospackage" version "8.6.1" + id "com.github.johnrengelman.shadow" version "7.1.0" + id "net.nemerosa.versioning" version "2.15.1" + id "nebula.ospackage" version "9.0.0" } dependencies { diff --git a/server/doc/AIX.md b/server/doc/AIX.md new file mode 100644 index 0000000..1c0bbcd --- /dev/null +++ b/server/doc/AIX.md @@ -0,0 +1,18 @@ +# AIX Notes + +Works on IBM Power AIX installations. + +## Installation + +We require Java 8, which should already be installed on AIX, or is available to install. +The RPM packages are *"noarch"* Java bytecode, so we can use the **--ignoreos** option to install: + +```shell +rpm -i --ignoreos sysmon-server.rpm +``` + +You can find InfluxDB and Grafana packaged for AIX on the [https://www.power-devops.com/](https://www.power-devops.com/) website. + +## Run automatically at boot + +See the [sysv-init.md](sysv-init.md) file for instructions. \ No newline at end of file diff --git a/server/doc/sysmon-server.sh b/server/doc/sysmon-server.sh new file mode 100644 index 0000000..60f4b38 --- /dev/null +++ b/server/doc/sysmon-server.sh @@ -0,0 +1,100 @@ +#!/bin/sh +### BEGIN INIT INFO +# Provides: +# Required-Start: $remote_fs $syslog +# Required-Stop: $remote_fs $syslog +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: Start daemon at boot time +# Description: Enable service provided by daemon. +### END INIT INFO + +dir="/opt/sysmon/server" +cmd="/opt/sysmon/server/bin/server" +args="-d" +user="" + +name=`basename $0` +pid_file="/var/run/$name.pid" +stdout_log="/var/log/$name.log" +stderr_log="/var/log/$name.err" + +get_pid() { + cat "$pid_file" +} + +is_running() { + [ -f "$pid_file" ] && ps -p `get_pid` > /dev/null 2>&1 +} + +case "$1" in + start) + if is_running; then + echo "Already started" + else + echo "Starting $name" + cd "$dir" + if [ -z "$user" ]; then + $cmd $args >> "$stdout_log" 2>> "$stderr_log" & + else + sudo -u "$user" $cmd $args >> "$stdout_log" 2>> "$stderr_log" & + fi + echo $! > "$pid_file" + if ! is_running; then + echo "Unable to start, see $stdout_log and $stderr_log" + exit 1 + fi + fi + ;; + stop) + if is_running; then + echo -n "Stopping $name.." + kill `get_pid` + for i in 1 2 3 4 5 6 7 8 9 10 + # for i in `seq 10` + do + if ! is_running; then + break + fi + + echo -n "." + sleep 1 + done + echo + + if is_running; then + echo "Not stopped; may still be shutting down or shutdown may have failed" + exit 1 + else + echo "Stopped" + if [ -f "$pid_file" ]; then + rm "$pid_file" + fi + fi + else + echo "Not running" + fi + ;; + restart) + $0 stop + if is_running; then + echo "Unable to stop, will not attempt to start" + exit 1 + fi + $0 start + ;; + status) + if is_running; then + echo "Running" + else + echo "Stopped" + exit 1 + fi + ;; + *) + echo "Usage: $0 {start|stop|restart|status}" + exit 1 + ;; +esac + +exit 0 diff --git a/server/doc/sysv-init.md b/server/doc/sysv-init.md new file mode 100644 index 0000000..9bd78aa --- /dev/null +++ b/server/doc/sysv-init.md @@ -0,0 +1,6 @@ +# SysV init Notes + +- Copy the *sysmon-server.sh* into *sysmon-server* in the correct location for init scripts on your operating system. +- Edit the file if you need to specify any options in the *args* variable. +- SymLink to the required run-levels. +