go-lockss

Go-based tooling for monitoring and troubleshooting LOCKSS nodes.

Table of contents

• Project home
• Overview
• Status
• Features
• Changelog
• Requirements
  • Building source code
  • Running
• Installation
  • From source
  • Using release binaries
• Configuration
  • Command-line arguments
    • hayoh
    • Worth noting
• Examples
  • hayoh
    • No options
• License
• References

Project home

See our GitHub repo for the latest code, to file an issue or submit improvements for review and potential inclusion into the project.

Overview

This project provides a set of library packages and tools to help with monitoring and troubleshooting LOCKSS nodes.

Status

Alpha quality.

In the current state, this project provides a single (usable) application that attempts to automatically obtain the list of peer nodes from a central LOCKSS property/configuration server and check access to 9729/tcp (LCAP) to determine whether the node is accessible for polling, voting and repair purposes.

The plan is to expose underlying libraries for use elsewhere once some additional "bake time" has occurred.

Features

• Single binary
  • a nice side-effect is that this makes deployment to LOCKSS nodes easier
• User configurable logging levels
• User configurable logging format
• User configurable timeouts (config file retrieval, port connection tests)
• User configurable location of LOCKSS configuration/property settings (custom file or URL)
• User configurable additional TCP ports to check
  • the default is to scan the LCAP port provided in the LOCKSS configuration/property XML file

Changelog

See the CHANGELOG.md file for the changes associated with each release of this application. Changes that have been merged to master, but not yet in an official release may also be noted in the file under the Unreleased section. A helpful link to the Git commit history since the last official release is also provided for further review.

Requirements

The following is a loose guideline. Other combinations of Go and operating systems for building and running tools from this repo may work, but have not been tested.

Building source code

• Go
  • see this project's go.mod file for preferred version
  • this project tests against officially supported Go releases
    • the most recent stable release (aka, "stable")
    • the prior, but still supported release (aka, "oldstable")
• GCC
  • if building with custom options (as the provided Makefile does)
• make
  • if using the provided Makefile

Running

• Windows 10
• Ubuntu Linux 18.04+

Installation

From source

1. Download Go
2. Install Go
3. Clone the repo
   1. cd /tmp
   2. git clone https://github.com/atc0005/go-lockss
   3. cd go-lockss
4. Install dependencies (optional)
   • for Ubuntu Linux
     • sudo apt-get install make gcc
   • for CentOS Linux
     1. sudo yum install make gcc
5. Build
   • for current operating system
     • go build -mod=vendor ./cmd/hayoh/
       • forces build to use bundled dependencies in top-level vendor folder
   • for all supported platforms (where make is installed)
     • make all
   • for Windows
     • make windows
   • for Linux
     • make linux
6. Copy the applicable binary to whatever systems needs to run it
   • if using Makefile: look in the subdirectories within /tmp/go-lockss/release_assets/
   • if using go build: look in /tmp/go-lockss/

NOTE: Depending on which Makefile recipe you use the generated binary may be compressed and have an xz extension. If so, you should decompress the binary first before deploying it (e.g., xz -d hayoh-linux-amd64.xz).

Using release binaries

1. Download the latest release binaries
2. Decompress binaries
   • e.g., xz -d hayoh-linux-amd64.xz
3. Deploy
   • Place hayoh in a location of your choice
     • e.g., /usr/local/bin/ (ongoing use) or $HOME/ (one-off use)

NOTE:

DEB and RPM packages are provided as an alternative to manually deploying binaries.

Configuration

Command-line arguments

hayoh

• Flags marked as required must be set via CLI flag
• Flags not marked as required are for settings where a useful default is already defined, or automatically obtained when run on a LOCKSS node

Flag	Required	Default	Repeat	Possible	Description
h, help	No	false	No	h, help	Show Help text along with the list of supported flags.
p, port	No	empty list	Yes	one valid TCP port per flag invocation	Additional TCP port to connect to on remote LOCKSS nodes to verify connectivity. This flag may be repeated for each additional TCP port to check. If not set, this application connects only to the port (usually 9729) specified in the LOCKSS configuration/property XML file.
cf, config-file	No	empty string	No	valid filename	Fully-qualified path to the fully-qualified path to an on-disk copy of the LOCKSS configuration/property XML file, usually named lockss.xml. This is NOT the same file as the /etc/lockss/config.dat file used to bootstrap the LOCKSS daemon at startup time.
cs, config-server	No	Maybe	No	valid URL	Fully-qualified URL to the LOCKSS configuration/property XML file.
v, version	No	false	No	v, version	Whether to display application version and then immediately exit application.
ll, log-level	No	info	No	fatal, error, warn, info, debug	Log message priority filter. Log messages with a lower level are ignored.
lf, log-format	No	text	No	cli, json, logfmt, text, discard	Use the specified apex/log package "handler" to output log messages in that handler's format.
pt, port-timeout	No	2	No	any positive whole number	Maximum number of seconds allowed for a connection test against a remote TCP port before timing out.
ct, config-read-timeout	No	10	No	any positive whole number	Maximum number of seconds allowed for a request for the LOCKSS configuration XML file before timing out.

Worth noting

• When run on a LOCKSS node, and if the config-server setting is not specified, an attempt is made to automatically lookup the central configuration/properties server from the local /etc/lockss/config.dat file.

• Log format names map directly to the Handlers provided by the apex/log package. Their descriptions are copied from the official README and provided below for reference:

  Log Format ("Handler")	Description
  cli	human-friendly CLI output
  json	provides log output in JSON format
  logfmt	plain-text logfmt output
  text	human-friendly colored output
  discard	discards all logs

Examples

hayoh

No options

This output is from running hayoh (commit d7a2103) without any options:

$ ./hayoh

[2020-08-16 08.17:56] Starting hayoh version "d7a2103" ...
[2020-08-16 07.30:33] Checking 1 ports on 11 peer nodes ...

Peer            Port    Open    Error
----            ----    ----    -----
1.2.3.4         9729    true
5.6.7.8         9729    true
2.3.4.5         9729    true
2.6.4.3         9729    true
1.3.6.7         9729    true
9.7.6.5         9729    false   dial tcp 9.7.6.5:9729: connect: connection refused
3.2.1.6         9729    false   dial tcp 3.2.1.6:9729: connect: connection refused
7.4.2.1         9729    false   dial tcp 7.4.2.1:9729: i/o timeout
7.5.2.1         9729    false   dial tcp 7.5.2.1:9729: i/o timeout
7.8.9.0         9729    false   dial tcp 7.8.9.0:9729: i/o timeout
5.6.4.2         9729    false   dial tcp 5.6.4.2:9729: i/o timeout

Summary:

- 1 unique ports checked on each of 11 hosts.
- 45% (5/11) of peer nodes are reachable (at least one open port) from this system.
- 45% (5/11) of ports scanned are reachable from this system.

License

Taken directly from the LICENSE file:

MIT License

Copyright (c) 2020-Present Adam Chalkley

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

References

Various references used when developing this project can be found in our references doc.