REFERENCE.md

Reference

Table of Contents

Classes

• hindsight: Manage Hidsight service configuration
• hindsight::config: Internal class, should not be called directly. Manages directory structure for Hindsight configuration files
• hindsight::install: Ensures installation of system packages (RPM/deb/etc.) This class is called from hindsight for install.
• hindsight::params: Default param values
• hindsight::service: Manage Hindsight service

Defined types

• hindsight::plugin: Hindsight plugin configuration

Functions

• hindsight_escape: Escape string values

Classes

hindsight

Manage Hidsight service configuration

Parameters

The following parameters are available in the hindsight class:

• max_message_size
• package
• modules
• user
• group
• service_name
• service_ensure
• manage_service
• service_prestart
• conf_dir
• output_dir
• decoders_dir
• run_dir
• analysis_lua_path
• analysis_lua_cpath
• purge_configs
• analysis_threads
• io_lua_path
• io_lua_cpath
• analysis_defaults
• input_defaults
• output_defaults
• package_ensure
• hostname
• output_size

max_message_size

Data type: String

max size in bytes default: 8e6 (8MB)

package

Data type: String

Hindsight package name to be installed via system package

Default value: $hindsight::params::package

modules

Data type: Array[String]

Optional modules (luasandbox extensions e.g. ['luasandbox-lpeg'])

Default value: $hindsight::params::modules

user

Data type: String

The owner of config files

Default value: $hindsight::params::user

group

Data type: String

The group for config files

Default value: $hindsight::params::group

service_name

Data type: String

Name of service running Hindsight daemon

Default value: $hindsight::params::service_name

service_ensure

Data type: Variant[Boolean,String]

Possible values running,stoppped,true, false

Default value: $hindsight::params::service_ensure

manage_service

Data type: Boolean

Whether Puppet should manage the service

Default value: $hindsight::params::manage_service

service_prestart

Data type: Array[String]

Array of commands to be executed before hindsight service start

Default value: []

conf_dir

Data type: Stdlib::Absolutepath

Directory where main Hidsight configuration resides

Default value: $hindsight::params::conf_dir

output_dir

Data type: Stdlib::Absolutepath

Path where the protobuf streams, checkpoints and statistics are stored.

Default value: $hindsight::params::output_dir

decoders_dir

Data type: Stdlib::Absolutepath

Path to decoders

Default value: $hindsight::params::decoders_dir

run_dir

Data type: Stdlib::Absolutepath

Base path containing the running configis and dynamically loaded lua, by default conf_dir/run

Default value: $hindsight::params::run_dir

analysis_lua_path

Data type: Stdlib::Absolutepath

Path used by the analysis plugins to look for Lua modules

Default value: $hindsight::params::analysis_lua_path

analysis_lua_cpath

Data type: Stdlib::Absolutepath

Path used by the analysis plugins to look for Lua C modules

Default value: $hindsight::params::analysis_lua_cpath

purge_configs

Data type: Boolean

Removed configs that are not managed by this module

Default value: $hindsight::params::purge_configs

analysis_threads

Data type: Integer

Number of threads for analysis

Default value: 1

io_lua_path

Data type: Stdlib::Absolutepath

Path to look for Lua io modules

Default value: $hindsight::params::io_lua_path

io_lua_cpath

Data type: Stdlib::Absolutepath

Path to look for C io modules

Default value: $hindsight::params::io_lua_cpath

analysis_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

Default value: $hindsight::params::analysis_defaults

input_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

Default value: $hindsight::params::input_defaults

output_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

Default value: $hindsight::params::output_defaults

package_ensure

Data type: String

Ensure passed to installed packages

Default value: 'installed'

hostname

Data type: Optional[String]

Manually set hostname

Default value: undef

output_size

Data type: Integer

in bytes (default 64MiB)

Default value: 64 * 1024 * 1024

hindsight::config

Internal class, should not be called directly. Manages directory structure for Hindsight configuration files

Parameters

The following parameters are available in the hindsight::config class:

• user
• group
• conf_dir
• output_dir
• run_dir
• analysis_lua_path
• analysis_lua_cpath
• io_lua_path
• io_lua_cpath
• analysis_threads
• purge_configs
• analysis_defaults
• input_defaults
• output_defaults
• file_ensure
• dir_ensure
• hostname
• max_message_size
• output_size

user

Data type: String

The owner of config files

group

Data type: String

The group for config files

conf_dir

Data type: Stdlib::Absolutepath

Directory where main Hidsight configuration resides

output_dir

Data type: Stdlib::Absolutepath

Path where the protobuf streams, checkpoints and statistics are stored.

run_dir

Data type: Stdlib::Absolutepath

Base path containing the running configis and dynamically loaded lua, by default conf_dir/run

analysis_lua_path

Data type: Stdlib::Absolutepath

Path used by the analysis plugins to look for Lua modules

analysis_lua_cpath

Data type: Stdlib::Absolutepath

Path used by the analysis plugins to look for Lua C modules

io_lua_path

Data type: Stdlib::Absolutepath

Path to look for Lua io modules

io_lua_cpath

Data type: Stdlib::Absolutepath

Path to look for C io modules

analysis_threads

Data type: Integer

Number of threads for analysis

purge_configs

Data type: Boolean

Removed configs that are not managed by this module

analysis_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

input_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

output_defaults

Data type: Hash

Hash overriding default sandbox configuration variables. See https://mozilla-services.github.io/hindsight/configuration.html

file_ensure

Data type: String

Ensure passed to config files

Default value: 'file'

dir_ensure

Data type: String

Ensure passed to directories

Default value: 'directory'

hostname

Data type: Optional[String]

Manually set hostname

max_message_size

Data type: String

in bytes

output_size

Data type: Integer

in bytes

hindsight::install

== Class hindsight::install

Parameters

The following parameters are available in the hindsight::install class:

• package
• modules
• package_ensure

package

Data type: String

Hindsight package name to be installed via system package

modules

Data type: Array[String]

Optional modules (luasandbox extensions e.g. ['luasandbox-lpeg'])

package_ensure

Data type: String

Common ensure for all packages, e.g.: present | absent

Default value: 'installed'

hindsight::params

Default param values

hindsight::service

Manage Hindsight service

Parameters

The following parameters are available in the hindsight::service class:

• service
• ensure
• conf_dir
• prestart
• nofile

service

Data type: String

Name of service running Hindsight daemon

ensure

Data type: Variant[Boolean,String]

Possible values running,stoppped,true, false

conf_dir

Data type: Stdlib::Absolutepath

Directory where main Hidsight configuration resides

prestart

Data type: Array[String]

Array of commands to be executed before hindsight service start

Default value: []

nofile

Data type: Optional[String]

Limit number of file descriptor for hindsight service. Format: soft:hard, e.g. 2048:4096

Default value: undef

Defined types

hindsight::plugin

Hindsight plugin configuration

Parameters

The following parameters are available in the hindsight::plugin defined type:

• filename
• target
• ensure
• order
• config
• manage_service
• service_name
• run_dir
• content
• source

filename

Data type: String

Name of Lua file to require

target

Data type: String

Filename to write configuration (.cfg will be appended)

ensure

Data type: Enum['present','absent']

Config file ensure (either present or absent)

Default value: 'present'

order

Data type: Integer[1]

Concat order (in config file)

Default value: 1

config

Data type: Hash

Plugin configuration

Default value: {}

manage_service

Data type: Boolean

When true Hindsight service will be restarted upon change

Default value: $hindsight::manage_service

service_name

Data type: String

Hindsight service name

Default value: $hindsight::service_name

run_dir

Data type: Stdlib::Absolutepath

sandbox_run directory

Default value: $hindsight::run_dir

content

Data type: Optional[String]

Template to load config from

Default value: undef

source

Data type: Optional[String]

Path from which config should be loaded

Default value: undef

Functions

hindsight_escape

Type: Ruby 4.x API

Escape string values

hindsight_escape(Any *$args)

The hindsight_escape function.

Returns: Any

*args

Data type: Any