sayoko

Gobbler-SewerRat integration

Overview

sayoko is a service to ensure that only the latest version of each Gobbler asset is included in the SewerRat index. It does so by adding a .SewerRatignore file to the subdirectories corresponding to all non-latest versions of each asset, either by scanning the log directory for updates or by periodically checking the entire Gobbler registry. Each project modified in this manner is then re-registered in SewerRat index, providing users with a more up-to-date search of Gobbler assets.

Instructions

The usual go build . command produces the sayoko binary. We can then run it as shown below, using an account that has write permissions to the Gobbler registry.

./sayoko \
    -registry PATH_TO_GOBBLER_REGISTRY
    -url URL_FOR_SEWERRAT_REST_API

By default, this will scan the log directory every 10 minutes and will do a full registry check every 24 hours. These intervals can be modified with the -log and -full flags, respectively.

After every log scan, sayoko produces a .sayoko_last_scan file containing the RFC3339-formatted time of the most recent log. This avoids redundant re-processing of the same log files when sayoko itself is restarted. Advanced users can exploit this by modifying the timestamp in this file to force sayoko to process logs after a desired timepoint. The path of this timestamp file can also be modified via the -timestamp flag.

Developer notes

Download the latest SewerRat binary and run it with default arguments. Once the SewerRat service has started successfully, testing can be performed with the usual go test commands.