Merge pull request #4 from mnellemann/agent

Rename client to agent

.drone.yml

@@ -17,8 +17,8 @@ steps:
   - ./gradlew build packages shared:publishLibraryPublicationToGiteaRepository
   - for file in server/build/distributions/*.deb ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
   - for file in server/build/distributions/*.rpm ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
-  - for file in client/build/distributions/*.deb ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
-  - for file in client/build/distributions/*.rpm ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
+  - for file in agent/build/distributions/*.deb ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
+  - for file in agent/build/distributions/*.rpm ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
   - for file in plugins/build/distributions/*.deb ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
   - for file in plugins/build/distributions/*.rpm ; do curl --user "${DRONE_REPO_OWNER}:$${AUTH_TOKEN}" --upload-file "$${file}" "https://git.data.coop/api/packages/${DRONE_REPO_OWNER}/generic/${DRONE_REPO_NAME}/${DRONE_TAG}/$(basename $file)" ; done
   when:

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.2.1] - 2024-08-05
+- Adjust defaults intervals from 10s to 30s
+- Measure sleep overrun
+- Rename client to agent
+  - When upgrading, ensure any *client* related init-scripts are removed
+- Updated 3rd party dependencies
+
 ## [1.1.8] - 2024-05-14
 - Update 3rd party dependencies
 - Avoid infinite timeout on http connections to server (max 1s now)

README.md

@@ -12,7 +12,7 @@ This software is free to use and is licensed under the [Apache 2.0 License](LICE
 Some of my other related projects are:
 
 - [hmci](https://github.com/mnellemann/hmci) for agent-less monitoring of IBM Power servers
-- [svci](https://github.com/mnellemann/svci) for monitoring IBM Spectrum Virtualize (Flashsystems / Storwize / SVC)
+- [svci](https://github.com/mnellemann/svci) for monitoring IBM Storage Virtualize (Flashsystems / Storwize / SVC)
 - [syslogd](https://github.com/mnellemann/syslogd) for redirecting syslog and GELF to other logging destinations
 
 ## Screenshots
@@ -26,18 +26,18 @@ Screenshots of other dashboards are available in the [doc/screenshots](doc/scree
 
 ### Server
 
-The server component receives aggregated metrics from *clients* and saves these into InfluxDB.
+The server component receives aggregated metrics from *agents* and saves these into InfluxDB.
 
 - Downloaded server package from [releases](https://github.com/mnellemann/sysmon/releases).
 - More information and documentation on the [sysmon-server](server/README.md).
 
-### Client & Plugins
+### Agent & Plugins
 
-The client runs on all or some of your hosts and collects metrics, which are then sent to the central sysmon-server component. Plugins are loaded by the client at startup and should also be installed.
+The agent runs on all or some of your hosts and collects metrics, which are then sent to the central sysmon-server component. Plugins are loaded by the agent at startup and should also be installed.
 
-- Downloaded client & plugin packages from [releases](https://github.com/mnellemann/sysmon/releases).
-- More information and documentation on the [sysmon-client](client/README.md).
-. More information and documentation on the [sysmon-plugins](plugins/README.md).
+- Downloaded agent & plugin packages from [releases](https://github.com/mnellemann/sysmon/releases).
+- More information and documentation on the [sysmon-agent](agent/README.md).
+- More information and documentation on the [sysmon-plugins](plugins/README.md).
 
 
 ## Known problems

agent/README.md

@@ -0,0 +1,17 @@
+# Agent
+
+This is the monitoring agent sysmon, which you install (together with sysmon-plugins) on your hosts.
+
+## Installation
+
+Download *.deb* or *.rpm* packages for sysmon-agent *and* sysmon-plugins, and install.
+
+## Development
+
+### Build & Test
+
+Use the gradle build tool, which will download all required dependencies:
+
+```shell
+./gradlew clean build
+```

client/build.gradle → agent/build.gradle

@@ -36,17 +36,17 @@ dependencies {
 
 }
 
-def projectName = "sysmon-client"
+def projectName = "sysmon-agent"
 
 application {
     // Define the main class for the application.
-    mainClass.set('sysmon.client.Application')
-    applicationDefaultJvmArgs = [ "-Xms64m", "-Xmx64m", "-XX:+ExitOnOutOfMemoryError", "-XX:+AlwaysPreTouch" ]
+    mainClass.set('sysmon.agent.Application')
+    applicationDefaultJvmArgs = [ "-Xms16m", "-Xmx64m", "-XX:+ExitOnOutOfMemoryError", "-XX:+AlwaysPreTouch" ]
 }
 
 run {
     systemProperty 'sysmon.pluginsDir', '../plugins/output/'
-    systemProperty 'sysmon.cfgFile', 'doc/sysmon-client.toml'
+    systemProperty 'sysmon.cfgFile', 'doc/sysmon-agent.toml'
     systemProperty 'sysmon.debug', '1'
 }
 
@@ -82,7 +82,7 @@ ospackage {
     user = 'root'
     packager = "Mark Nellemann <mark.nellemann@gmail.com>"
 
-    into '/opt/sysmon/client'
+    into '/opt/sysmon/agent'
 
     from(shadowJar.outputs.files) {
         into 'lib'

client/doc/readme-aix.md → agent/doc/readme-aix.md

@@ -4,16 +4,16 @@ Works on IBM Power VIO (Virtual IO) servers, as well as regular IBM Power AIX in
 
 ## Installation
 
-We require Java 8, which should already be installed on AIX, or is available to install.
+Requires Java 8 (or later), 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 -ivh --ignoreos sysmon-client-*.rpm sysmon-plugins-*.rpm
+rpm -ivh --ignoreos sysmon-agent-*.rpm sysmon-plugins-*.rpm
 ```
 
 ## Configuration
 
-Edit **/etc/sysmon-client.toml** and modify the server URL.
+Edit **/etc/sysmon-agent.toml** and modify the server URL.
 
 ## Upgrades
 
@@ -23,8 +23,8 @@ To upgrade the packages:
 rpm -Uvh --ignoreos sysmon-*.rpm
 ```
 
-To restart sysmon-client process after upgrade:
+To restart sysmon-agent process after upgrade:
 
 ```shell
-/etc/rc.d/init.d/sysmon-client stop; /etc/rc.d/init.d/sysmon-client start
+/etc/rc.d/init.d/sysmon-agent stop; /etc/rc.d/init.d/sysmon-agent start
 ```

client/doc/readme-linux.md → agent/doc/readme-linux.md

@@ -11,13 +11,13 @@ Java 8 (or later) runtime is required.
 
 ## Installation
 
-[Download](https://github.com/mnellemann/sysmon/releases) the latest client and plugins rpm or deb files.
+[Download](https://github.com/mnellemann/sysmon/releases) the latest agent and plugins rpm/deb packages.
 
 ### RedHat Linux
 
 ```shell
 sudo dnf install java-11-openjdk-headless
-sudo rpm -ivh sysmon-client-*.noarch.rpm sysmon-plugins-*.rpm
+sudo rpm -ivh sysmon-agent-*.noarch.rpm sysmon-plugins-*.rpm
 ```
 
 Use *yum* if *dnf* is not available.
@@ -26,18 +26,18 @@ Use *yum* if *dnf* is not available.
 
 ```shell
 sudo zypper install java-11-openjdk-headless
-sudo zypper install sysmon-client-*.noarch.rpm sysmon-plugins-*.rpm
+sudo zypper install sysmon-agent-*.noarch.rpm sysmon-plugins-*.rpm
 ```
 
 ### Debian/Ubuntu Linux
 
 ```shell
 sudo apt install default-jre-headless
-sudo dpkg -i sysmon-client-*.deb sysmon-plugins-*.deb
+sudo dpkg -i sysmon-agent-*.deb sysmon-plugins-*.deb
 ```
 
 ## Configuration
 
-Edit **/etc/sysmon-client.toml** and modify the server URL.
+Edit **/etc/sysmon-agent.toml** and modify the server URL.
 
-Check logs for errors with: ```journalctl -u sysmon-client```
+Check logs for errors with: ```journalctl -u sysmon-agent```

client/doc/sysmon-client.service → agent/doc/sysmon-agent.service

@@ -1,12 +1,12 @@
 [Unit]
-Description=Sysmon Client
+Description=Sysmon Agent
 
 [Service]
 #User=nobody
 #Group=nobody
 TimeoutSec=20
 Restart=on-failure
-ExecStart=/opt/sysmon/client/bin/client
+ExecStart=/opt/sysmon/agent/bin/agent
 
 [Install]
 WantedBy=default.target

client/doc/sysmon-client.sh → agent/doc/sysmon-agent.sh

@@ -9,12 +9,12 @@
 # Description:       Enable service provided by daemon.
 ### END INIT INFO
 
-dir="/opt/sysmon/client"
-cmd="/opt/sysmon/client/bin/client"
+dir="/opt/sysmon/agent"
+cmd="/opt/sysmon/agent/bin/agent"
 args=""
 user=""
 
-name="sysmon-client"
+name="sysmon-agent"
 pid_file="/var/run/$name.pid"
 stdout_log="/var/log/$name.log"
 stderr_log="/var/log/$name.err"

client/doc/sysmon-client.toml → agent/doc/sysmon-agent.toml

@@ -1,5 +1,5 @@
 ###
-### Sysmon Client
+### Sysmon Agent
 ###
 ### Example configuration with some default values.
 ###
@@ -22,11 +22,11 @@ interval = '60m'
 
 [extension.base_disk]
 enabled = true
-interval = '10s'
+interval = '30s'
 
 [extension.base_filesystem]
 enabled = true
-interval = '10s'
+interval = '30s'
 exclude_type = [ "tmpfs", "ahafs" ]
 exclude_mount = [ "/boot/efi" ]
 

client/scripts/install.sh → agent/scripts/install.sh

@@ -1,6 +1,10 @@
 #!/bin/sh
 
 install_config() {
+    # Migrate from old (name) configuration file
+    test -f "/etc/sysmon-client.toml" && mv "/etc/sysmon-client.toml" "/etc/${service_name}.toml"
+
+    # Install default configuration file
     test -f "/etc/${service_name}.toml" || cp "${config_source}" "/etc/${service_name}.toml"
 }
 
@@ -24,8 +28,8 @@ install_sysv_linux() {
 install_sysv_aix() {
     test -f "/etc/rc.d/init.d/${service_name}" || cp "${sysv_source}" "/etc/rc.d/init.d/${service_name}"
     chmod 0755 "/etc/rc.d/init.d/${service_name}"
-    ln -sf /etc/rc.d/init.d/sysmon-client /etc/rc.d/rc2.d/Ssysmon-client
-    ln -sf /etc/rc.d/init.d/sysmon-client /etc/rc.d/rc2.d/Ksysmon-client
+    ln -sf /etc/rc.d/init.d/sysmon-agent /etc/rc.d/rc2.d/Ssysmon-agent
+    ln -sf /etc/rc.d/init.d/sysmon-agent /etc/rc.d/rc2.d/Ksysmon-agent
 }
 
 install_sysv() {

client/scripts/remove.sh → agent/scripts/remove.sh

@@ -19,8 +19,8 @@ remove_sysv_linux() {
 
 remove_sysv_aix() {
     /etc/rc.d/init.d/${service_name} stop
-    rm -f /etc/rc.d/init.d/sysmon-client /etc/rc.d/rc2.d/Ksysmon-client
-    rm -f /etc/rc.d/rc2.d/Ssysmon-client
+    rm -f /etc/rc.d/init.d/sysmon-agent /etc/rc.d/rc2.d/Ksysmon-agent
+    rm -f /etc/rc.d/rc2.d/Ssysmon-agent
 }
 
 remove_sysv() {

agent/scripts/shared.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+service_name="sysmon-agent"
+sysv_source="/opt/sysmon/agent/doc/sysmon-agent.sh"
+config_source="/opt/sysmon/agent/doc/sysmon-agent.toml"
+systemd_source="/opt/sysmon/agent/doc/sysmon-agent.service"
+

client/src/main/java/sysmon/client/ClientRouteBuilder.java → agent/src/main/java/sysmon/agent/AgentRouteBuilder.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import org.apache.camel.Exchange;
 import org.apache.camel.LoggingLevel;
@@ -26,9 +26,9 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-public class ClientRouteBuilder extends RouteBuilder {
+public class AgentRouteBuilder extends RouteBuilder {
 
-    private static final Logger log = LoggerFactory.getLogger(ClientRouteBuilder.class);
+    private static final Logger log = LoggerFactory.getLogger(AgentRouteBuilder.class);
 
     private final Set<String> scriptFiles = new HashSet<>();
 

client/src/main/java/sysmon/client/Application.java → agent/src/main/java/sysmon/agent/Application.java

@@ -1,7 +1,7 @@
 /*
  * This Java source file was generated by the Gradle 'init' task.
  */
-package sysmon.client;
+package sysmon.agent;
 
 import org.apache.camel.main.Main;
 import org.slf4j.simple.SimpleLogger;
@@ -12,10 +12,10 @@
 import java.net.UnknownHostException;
 import java.util.concurrent.Callable;
 
-@CommandLine.Command(name = "sysmon-client", mixinStandardHelpOptions = true)
+@CommandLine.Command(name = "sysmon-agent", mixinStandardHelpOptions = true)
 public class Application implements Callable<Integer> {
 
-    @CommandLine.Option(names = { "-c", "--conf" }, description = "Configuration file [default: '/etc/sysmon-client.toml'].", paramLabel = "<file>", defaultValue = "/etc/sysmon-client.toml")
+    @CommandLine.Option(names = { "-c", "--conf" }, description = "Configuration file [default: '/etc/sysmon-agent.toml'].", paramLabel = "<file>", defaultValue = "/etc/sysmon-agent.toml")
     private File configurationFile;
 
     @CommandLine.Option(names = { "-d", "--debug" }, description = "Enable debugging (default: ${DEFAULT_VALUE}).")
@@ -84,7 +84,7 @@ public Integer call() {
         main.bind("pluginPath", pluginPath);
         main.bind("myServerUrl", configuration.getServer());
         main.bind("myHostname", hostname);
-        main.configure().addRoutesBuilder(ClientRouteBuilder.class);
+        main.configure().addRoutesBuilder(AgentRouteBuilder.class);
 
         // now keep the application running until the JVM is terminated (ctrl + c or sigterm)
         try {

client/src/main/java/sysmon/client/ComboAppender.java → agent/src/main/java/sysmon/agent/ComboAppender.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import sysmon.shared.ComboResult;
 import sysmon.shared.MetricResult;

client/src/main/java/sysmon/client/Configuration.java → agent/src/main/java/sysmon/agent/Configuration.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

client/src/main/java/sysmon/client/ListOfResultsStrategy.java → agent/src/main/java/sysmon/agent/ListOfResultsStrategy.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import org.apache.camel.Exchange;
 import org.apache.camel.processor.aggregate.AbstractListAggregationStrategy;

client/src/main/java/sysmon/client/MetricEnrichProcessor.java → agent/src/main/java/sysmon/agent/MetricEnrichProcessor.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;

client/src/main/java/sysmon/client/ScriptWrapper.java → agent/src/main/java/sysmon/agent/ScriptWrapper.java

@@ -1,4 +1,4 @@
-package sysmon.client;
+package sysmon.agent;
 
 import groovy.lang.GroovyClassLoader;
 import groovy.lang.GroovyObject;

client/src/main/resources/application.properties → agent/src/main/resources/application.properties

@@ -15,7 +15,7 @@
 ## limitations under the License.
 ## ---------------------------------------------------------------------------
 
-camel.main.name = sysmon-client
+camel.main.name = agent
 camel.main.jmxEnabled = false
 camel.main.lightweight = true
 camel.component.seda.queue-size = 100

client/src/test/groovy/sysmon/client/AppTest.groovy → agent/src/test/groovy/sysmon/agent/AppTest.groovy

@@ -1,4 +1,4 @@
-package sysmon.client
+package sysmon.agent
 
 import spock.lang.Specification
 

build.gradle

@@ -37,8 +37,8 @@ subprojects {
 tasks.register("packages") {
     group "build"
 
-    dependsOn ":client:buildDeb"
-    dependsOn ":client:buildRpm"
+    dependsOn ":agent:buildDeb"
+    dependsOn ":agent:buildRpm"
 
     dependsOn ":server:buildDeb"
     dependsOn ":server:buildRpm"