From 824b91216f262e84579fbf5f1abd6e9a346c6a8c Mon Sep 17 00:00:00 2001 From: Tim Wojtulewicz Date: Wed, 30 Apr 2025 12:36:02 -0700 Subject: [PATCH] Add operation_timeout and command_timeout storage backend options --- scripts/base/frameworks/storage/main.zeek | 11 +++++++++++ src/storage/backend/redis/Redis.cc | 7 ++++++- .../out | 4 ++-- .../scripts.base.frameworks.storage.redis-sync/out | 4 ++-- .../scripts.base.frameworks.storage.sqlite-basic/out | 2 +- 5 files changed, 22 insertions(+), 6 deletions(-) diff --git a/scripts/base/frameworks/storage/main.zeek b/scripts/base/frameworks/storage/main.zeek index 75d72fe706..763616aec9 100644 --- a/scripts/base/frameworks/storage/main.zeek +++ b/scripts/base/frameworks/storage/main.zeek @@ -10,6 +10,17 @@ 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 diff --git a/src/storage/backend/redis/Redis.cc b/src/storage/backend/redis/Redis.cc index d048816efa..a86d40b9ae 100644 --- a/src/storage/backend/redis/Redis.cc +++ b/src/storage/backend/redis/Redis.cc @@ -262,7 +262,8 @@ OperationResult Redis::DoOpen(OpenResultCallback* cb, RecordValPtr options) { opt.options |= REDIS_OPT_PREFER_IPV4; opt.options |= REDIS_OPT_NOAUTOFREEREPLIES; - struct timeval timeout = {5, 0}; + auto connect_timeout_opt = options->GetField("connect_timeout")->Get(); + struct timeval timeout = util::double_to_timeval(connect_timeout_opt); opt.connect_timeout = &timeout; // The connection request below should be operation #1. @@ -300,6 +301,10 @@ OperationResult Redis::DoOpen(OpenResultCallback* cb, RecordValPtr options) { redisAsyncSetConnectCallback(async_ctx, redisOnConnect); redisAsyncSetDisconnectCallback(async_ctx, redisOnDisconnect); + auto op_timeout_opt = options->GetField("operation_timeout")->Get(); + struct timeval op_timeout = util::double_to_timeval(op_timeout_opt); + redisAsyncSetTimeout(async_ctx, op_timeout); + // redisAsyncSetConnectCallback sets the flag in the redisPollEvent for writing // so we can add this to our loop as well. zeek::iosource_mgr->RegisterFd(async_ctx->c.fd, this, zeek::iosource::IOSource::WRITE); diff --git a/testing/btest/Baseline/scripts.base.frameworks.storage.redis-disconnect/out b/testing/btest/Baseline/scripts.base.frameworks.storage.redis-disconnect/out index a62108de4f..00b4ab5b93 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.storage.redis-disconnect/out +++ b/testing/btest/Baseline/scripts.base.frameworks.storage.redis-disconnect/out @@ -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=, value=] -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=, key_prefix=testing]] -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=, key_prefix=testing]], Server closed the connection +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=, 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=, key_prefix=testing]], Server closed the connection diff --git a/testing/btest/Baseline/scripts.base.frameworks.storage.redis-sync/out b/testing/btest/Baseline/scripts.base.frameworks.storage.redis-sync/out index 5bd50b0b4e..397bcc4c91 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.storage.redis-sync/out +++ b/testing/btest/Baseline/scripts.base.frameworks.storage.redis-sync/out @@ -9,5 +9,5 @@ get result same as originally inserted, T put result, [code=Storage::SUCCESS, error_str=, value=] get result, [code=Storage::SUCCESS, error_str=, value=value2345] get result same as overwritten, T -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=, key_prefix=testing]] -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=, key_prefix=testing]], Client disconnected +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=, 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=, key_prefix=testing]], Client disconnected diff --git a/testing/btest/Baseline/scripts.base.frameworks.storage.sqlite-basic/out b/testing/btest/Baseline/scripts.base.frameworks.storage.sqlite-basic/out index 7121683d22..df3ab3b0de 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.storage.sqlite-basic/out +++ b/testing/btest/Baseline/scripts.base.frameworks.storage.sqlite-basic/out @@ -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, sqlite=[database_path=test.sqlite, table_name=testing, tuning_params={ +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={ [synchronous] = normal, [temp_store] = memory, [journal_mode] = WAL