Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Move options to redis backend options instead of module-level options

Browse source
This commit is contained in:
Tim Wojtulewicz 2025-05-06 11:53:35 -07:00
parent 824b91216f
commit fd10dd015f
6 changed files with 24 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

11
scripts/base/frameworks/storage/main.zeek
View file

@ -10,17 +10,6 @@ export {
type BackendOptions: record {
## The serializer used for converting Zeek data.
serializer: Storage::Serializer &default=Storage::STORAGE_SERIALIZER_JSON;
## Timeout for connection attempts to the backend. Connection attempts
## that exceed this time should return
## :zeek:see:`Storage::CONNECTION_FAILED`. Not all backends will support
## setting timeouts.
connect_timeout: interval &default=5 sec;
## Timeout for operation requests sent to the backend. Operations that
## exceed this time should return :zeek:see:`Storage::TIMEOUT`. Not all
## backends will support setting timeouts.
operation_timeout: interval &default=5 sec;
};
## Record for passing arguments to :zeek:see:`Storage::Async::put` and

17
scripts/policy/frameworks/storage/backend/redis/main.zeek
View file

@ -5,6 +5,14 @@
module Storage::Backend::Redis;
export {
## Default value for connection attempt timeouts. This can be overridden
## per-connection with the ``connect_timeout`` backend option.
const default_connect_timeout: interval = 5 secs &redef;
## Default value for operation timeouts. This can be overridden per-connection
## with the ``operation_timeout`` backend option.
const default_operation_timeout: interval = 5 secs &redef;
## Options record for the built-in Redis backend.
type Options: record {
# Address or hostname of the server.
@ -22,6 +30,15 @@ export {
# same server. Defaults to an empty string, but preferably should be set
# to a unique value per Redis backend opened.
key_prefix: string &default="";
## Timeout for connection attempts to the backend. Connection attempts
## that exceed this time will return
## :zeek:see:`Storage::CONNECTION_FAILED`.
connect_timeout: interval &default=default_connect_timeout;
## Timeout for operation requests sent to the backend. Operations that
## exceed this time will return :zeek:see:`Storage::TIMEOUT`.
operation_timeout: interval &default=default_operation_timeout;
};
}

4
src/storage/backend/redis/Redis.cc
View file

@ -262,7 +262,7 @@ OperationResult Redis::DoOpen(OpenResultCallback* cb, RecordValPtr options) {
opt.options |= REDIS_OPT_PREFER_IPV4;
opt.options |= REDIS_OPT_NOAUTOFREEREPLIES;
auto connect_timeout_opt = options->GetField<IntervalVal>("connect_timeout")->Get();
auto connect_timeout_opt = backend_options->GetField<IntervalVal>("connect_timeout")->Get();
struct timeval timeout = util::double_to_timeval(connect_timeout_opt);
opt.connect_timeout = &timeout;
@ -301,7 +301,7 @@ OperationResult Redis::DoOpen(OpenResultCallback* cb, RecordValPtr options) {
redisAsyncSetConnectCallback(async_ctx, redisOnConnect);
redisAsyncSetDisconnectCallback(async_ctx, redisOnDisconnect);
auto op_timeout_opt = options->GetField<IntervalVal>("operation_timeout")->Get();
auto op_timeout_opt = backend_options->GetField<IntervalVal>("operation_timeout")->Get();
struct timeval op_timeout = util::double_to_timeval(op_timeout_opt);
redisAsyncSetTimeout(async_ctx, op_timeout);

4
testing/btest/Baseline/scripts.base.frameworks.storage.redis-disconnect/out
View file

@ -1,4 +1,4 @@
### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
open_result, [code=Storage::SUCCESS, error_str=<uninitialized>, value=<opaque of BackendHandleVal>]
Storage::backend_opened, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, connect_timeout=5.0 secs, operation_timeout=5.0 secs, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing]]
Storage::backend_lost, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, connect_timeout=5.0 secs, operation_timeout=5.0 secs, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing]], Server closed the connection
Storage::backend_opened, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing, connect_timeout=5.0 secs, operation_timeout=5.0 secs]]
Storage::backend_lost, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing, connect_timeout=5.0 secs, operation_timeout=5.0 secs]], Server closed the connection

4
testing/btest/Baseline/scripts.base.frameworks.storage.redis-sync/out
View file

@ -9,5 +9,5 @@ get result same as originally inserted, T
put result, [code=Storage::SUCCESS, error_str=<uninitialized>, value=<uninitialized>]
get result, [code=Storage::SUCCESS, error_str=<uninitialized>, value=value2345]
get result same as overwritten, T
Storage::backend_opened, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, connect_timeout=5.0 secs, operation_timeout=5.0 secs, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing]]
Storage::backend_lost, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, connect_timeout=5.0 secs, operation_timeout=5.0 secs, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing]], Client disconnected
Storage::backend_opened, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing, connect_timeout=5.0 secs, operation_timeout=5.0 secs]]
Storage::backend_lost, Storage::STORAGE_BACKEND_REDIS, [serializer=Storage::STORAGE_SERIALIZER_JSON, redis=[server_host=127.0.0.1, server_port=xxxx/tcp, server_unix_socket=<uninitialized>, key_prefix=testing, connect_timeout=5.0 secs, operation_timeout=5.0 secs]], Client disconnected

2
testing/btest/Baseline/scripts.base.frameworks.storage.sqlite-basic/out
View file

@ -1,5 +1,5 @@
### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
Storage::backend_opened, Storage::STORAGE_BACKEND_SQLITE, [serializer=Storage::STORAGE_SERIALIZER_JSON, connect_timeout=5.0 secs, operation_timeout=5.0 secs, sqlite=[database_path=test.sqlite, table_name=testing, tuning_params={
Storage::backend_opened, Storage::STORAGE_BACKEND_SQLITE, [serializer=Storage::STORAGE_SERIALIZER_JSON, sqlite=[database_path=test.sqlite, table_name=testing, tuning_params={
[synchronous] = normal,
[temp_store] = memory,
[journal_mode] = WAL