flowbber.plugins.sinks.archive

Archive

This sink writes all collected data to a JSON file.

Dependencies:

pip3 install flowbber[archive]

Usage:

[[sinks]]
type = "archive"
id = "..."

    [sinks.config]
    output = "data.json"
    override = true
    create_parents = true
    pretty = false
{
    "sinks": [
        {
            "type": "archive",
            "id": "...",
            "config": {
                "output": "data.json",
                "override": true,
                "create_parents": true,
                "pretty": false
            }
        }
    ]
}

output

Path to JSON file to write the collected data.

  • Default: N/A

  • Optional: False

  • Schema:

    {
        'type': 'string',
        'empty': False,
    }
    
  • Secret: False

override

Override output file if already exists.

  • Default: False

  • Optional: True

  • Schema:

    {
        'type': 'boolean',
    }
    
  • Secret: False

create_parents

Create output file parent directories if don’t exist.

  • Default: False

  • Optional: True

  • Schema:

    {
        'type': 'boolean',
    }
    
  • Secret: False

pretty

Pretty output.

  • Default: False

  • Optional: True

  • Schema:

    {
        'type': 'boolean',
    }
    
  • Secret: False

Classes

  • ArchiveSink: Common sink base class that adds a include and exclude configuration
class flowbber.plugins.sinks.archive.ArchiveSink(index, type_, id_, optional=False, timeout=None, config=None)

Inheritance

Inheritance diagram of ArchiveSink