policy/frameworks/storage/backend/redis/main.zeek

Storage::Backend::Redis

Redis storage backend support

Namespace:

Storage::Backend::Redis

Imports:

base/frameworks/storage/main.zeek

Summary

Redefinable Options

Storage::Backend::Redis::default_connect_timeout: interval &redef	Default value for connection attempt timeouts.
Storage::Backend::Redis::default_operation_timeout: interval &redef	Default value for operation timeouts.

Types

Storage::Backend::Redis::Options: record

Options record for the built-in Redis backend.

Redefinitions

Storage::BackendOptions: record

New Fields: Storage::BackendOptions redis: Storage::Backend::Redis::Options &optional

Detailed Interface

Redefinable Options

Storage::Backend::Redis::default_connect_timeout

Type:

interval

Attributes:

&redef

Default:

5.0 secs

Default value for connection attempt timeouts. This can be overridden per-connection with the connect_timeout backend option.

Storage::Backend::Redis::default_operation_timeout

Type:

interval

Attributes:

&redef

Default:

5.0 secs

Default value for operation timeouts. This can be overridden per-connection with the operation_timeout backend option.

Types

Storage::Backend::Redis::Options

Type:

record

Fields:

server_host: string &optional

server_port: port &default = 6379/tcp &optional

server_unix_socket: string &optional

key_prefix: string &default = "" &optional

connect_timeout: interval &default = Storage::Backend::Redis::default_connect_timeout &optional

Timeout for connection attempts to the backend. Connection attempts that exceed this time will return Storage::CONNECTION_FAILED.

operation_timeout: interval &default = Storage::Backend::Redis::default_operation_timeout &optional

Timeout for operation requests sent to the backend. Operations that exceed this time will return Storage::TIMEOUT.

username: string &optional

A username to use for authentication the server is protected by an ACL.

password: string &optional

A username to use for authentication the server is protected by an ACL or by a simple password.

Options record for the built-in Redis backend.