dcp-worker 4.3.0 → 4.3.2

package/README.md

@@ -58,9 +58,7 @@ Evaluator in real time.  `dcp-worker -h` shows a help screen; to run in interact
 
 Administrators with a large number of workers may wish to configure [syslog](https://en.wikipedia.org/wiki/Syslog)
 logging, and use an off-the-shelf logging aggregation service. The full gamut of options relating to
-syslog output are documented in the `dcp-worker` help screen. Note that only one type of output at a
-time is currently possible with `dcp-worker`; Linux administrators who want both system journals and
-syslog output will need to configure their local syslog service to receive messages from systemd.
+syslog output are documented in the `dcp-worker` help screen.
 
 The Worker can log its activities to a variety of destinations (dependent on operating system), and
 emits logs when new jobs are fetched, job slices are completed, and so on.

package/bin/dcp-worker

@@ -53,7 +53,8 @@ const replHelpers = {
   },
 };
 telnetd.init(replHelpers);
-require('dcp-client').init().then(main).catch(handleUnhandled);
+const dcpClientOptions = { dcpConfig: { worker: { logging: { syslog: {} } } } };
+require('dcp-client').init(dcpClientOptions).then(main).catch(handleUnhandled);
 
 function usage()
 {
@@ -83,7 +84,8 @@ Options:
       --logfile=filename             Change filename, implies --logger=logfile
       --overwrite-logfile            Overwrite previous log files instead of appending
       --syslog=url                   Change syslog url, implies --logger=syslog. Syslog
-                                     facility (eg. local7) is the URL pathname.
+                                     facility (eg. local7) is the pathname, structured
+                                     data is encoded in search params; id+name=value.
       --syslog=facility              Change syslog facility, implies --logger=syslog.
       --min-level=[logger,]level     Set the lowest level of log sent to a given logger
       --min-level=[console,]level    Set the lowest level of log sent to the console
@@ -203,7 +205,7 @@ function processCliOptsPhase1(argv, operatingMode)
   const loggingOptions = {
     minLevel:    { all: undefined },  /* minimum logging levels for console and per logger */
     loggers:     [],                  /* names of loggers (places logs go besides console) */
-    syslogUrl:   dcpConfig.worker.logging?.syslog?.url || new URL('udp://localhost:514/local7'),
+    syslogUrl:   new URL(dcpConfig.worker.logging?.syslog?.url || 'udp://localhost:514/local7'),
     logfile:     path.resolve(path.dirname(require.main.filename), dcpConfig.worker.logging?.logfile || '../log/dcp-worker.log'),
   };
   const evaluatorOptions = {
@@ -685,7 +687,8 @@ async function main()
     if (!handleWorkerError.count)
     {
       console.error('Unrecoverable', error.code ? `${error.name} (${error.code})` : error.name,
-                    '- shutting down the worker:', error.message);
+                    '- shutting down the worker:',
+                    process.env.DCP_SUPERVISOR_DEBUG_DISPLAY_MAX_INFO ? error : error.message);
     }
 
     /* Let the supervisor try to finish slices for up to three minutes after a single unrecoverable error. */
@@ -705,7 +708,7 @@ async function main()
   {
     const amount = await DistributiveWorker.checkUnclaimedEarnings();
     if (amount.gt(0))
-      console.note(` ! not claming earnings in the amount of ${amount} ⊇ (can claim later)`);
+      console.info(` ! not claming earnings in the amount of ${amount} ⊇ (can claim later)`);
   }
 
   console.info(' * Ready.\n');

package/lib/utils.js

@@ -114,7 +114,7 @@ function uniq(array)
 
 /**
  * Syslog URLs are bit special - the pathname of the URL encodes the syslog facility. Additionally, a
- * plain string treated as just a pathname and no other components
+ * plain string treated as just a pathname.
  *
  * existingUrl                       newArg                             result
  * -------------------------------   --------------------------------   ----------------------------------

package/lib/worker-loggers/syslog.js

@@ -69,6 +69,22 @@ exports.open = function syslog$$open(options)
   if (!syslogTarget)
     throw new Error('missing syslog target');
 
+  if (options.syslogUrl.search)
+  {
+    /* search encodes RFC5424 structured data of the form ?id+param1=value1&id+param2=value2 into
+     * { id: { param1: value1, param2: value2 } } for consumption by the syslog-client-tls package.
+     */
+    const elements = {};
+    options.syslogUrl.searchParams.forEach((sdValue, name) => {
+      const [ sdId, sdParamName ] = name.split(' ');
+      if (!elements[sdId])
+        elements[sdId] = {};
+      elements[sdId][sdParamName] = sdValue;
+    });
+    syslogOptions.structuredData = elements;
+    debug('dcp-worker:logger')(`syslog data includes ${Object.keys(elements).length} structured data elements`);
+  }
+
   debug('dcp-worker:logger')('connecting to syslogd at ' + options.syslogUrl);
   syslogClient = syslog.createClient(options.syslogUrl.hostname, syslogOptions);
   processName = require('path').basename(process.mainModule.filename) || 'dcp-worker';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "4.3.0",
+  "version": "4.3.2",
   "description": "Node.js Worker for Distributive Compute Platform",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -44,7 +44,7 @@
     "posix-getopt": "^1.2.1",
     "semver": "^7.3.8",
     "syslog-client": "1.1.1",
-    "syslog-client-tls": "1.2.1",
+    "syslog-client-tls": "github:wesgarland/node-syslog-client#0d734f33767bc6a8275552d3daa51712cc2d306d",
     "websocket": "1.0.34"
   },
   "optionalDependencies": {