Local Filesystem Observer setup guide - snowplow-archive/sauna GitHub Wiki

HOME > GUIDE FOR DEVOPS > SETTING UP SAUNA > OBSERVERS > LOCAL FILESYSTEM OBSERVER SETUP GUIDE

• 1. Overview
• 2. Compatibility
• 3. Local filesystem setup
• 4. Sauna setup
  • 4.1 Avro Schema
  • 4.2 Example

This observer monitors a directory in the local filesystem - when a new file is created in the given path, Sauna will trigger a responder action.

This observer was released in Sauna version 0.1.0.

Ensure that:

• The directory exists on the same machine as the Sauna server is running on;
• The directory is readable and writable (as files will be deleted after they're processed) by Sauna.

The Local Filesystem Observer must be configured using a self-describing Avro which validates against this Schema:

iglu:com.snowplowanalytics.sauna.observers/LocalFilesystemConfig/avro/1-0-0

We can enable this observer by placing the following Avro configurations to the configuration directory (the config files must use .avro or .json extensions):

{
    "schema": "iglu:com.snowplowanalytics.sauna.observers/LocalFilesystemConfig/avro/1-0-0",

    "data": {
        "enabled": true,
        "id": "MyLocalObserver",
        "parameters": {
            "saunaRoot": "/opt/sauna"
        }
    }
}

The observer's id must be unique among all configuration files.