Update act docs to include timeout (#50)

Hamsajj · mostafa · web-flow · commit 11cc8ecf3715 · 2024-03-21T23:57:13.000+01:00
* Update act docs to include timeout
* Update timestamps
* Fix anchor

---------

Co-authored-by: Mostafa Moradian &lt;mostafa@gatewayd.io&gt;
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -104,6 +104,7 @@ GEM
       rails (>= 4.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
+    google-protobuf (3.25.3-arm64-darwin)
     google-protobuf (3.25.3-x86_64-linux)
     http_parser.rb (0.8.0)
     httparty (0.21.0)
@@ -191,6 +192,8 @@ GEM
     net-smtp (0.4.0.1)
       net-protocol
     nio4r (2.7.0)
+    nokogiri (1.16.2-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.16.2-x86_64-linux)
       racc (~> 1.4)
     octokit (8.1.0)
@@ -252,6 +255,8 @@ GEM
     rexml (3.2.6)
     rouge (4.2.0)
     safe_yaml (1.0.5)
+    sass-embedded (1.71.1-arm64-darwin)
+      google-protobuf (~> 3.25)
     sass-embedded (1.71.1-x86_64-linux-gnu)
       google-protobuf (~> 3.25)
     sawyer (0.9.2)
@@ -273,6 +278,7 @@ GEM
     zeitwerk (2.6.13)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
diff --git a/developing-plugins/grpc-api-reference.md b/developing-plugins/grpc-api-reference.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: gRPC API Reference
 description: GatewayD exposes a gRPC API that can be used to interact with the GatewayD plugin system. This API can be used by the GatewayD plugins and is available in the GatewayD SDK.
diff --git a/developing-plugins/index.md b/developing-plugins/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Developing Plugins
 nav_order: 4
diff --git a/developing-plugins/plugin-developers-guide.md b/developing-plugins/plugin-developers-guide.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugin Developers Guide
 description: Plugin developers' guide of GatewayD
diff --git a/developing-plugins/sdk-reference.md b/developing-plugins/sdk-reference.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: SDK Reference
 description: The GatewayD plugin SDK provides a number of interfaces, structs and methods to help you build your plugin.
diff --git a/developing-plugins/template-projects.md b/developing-plugins/template-projects.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Template Projects
 description: Template projects can be used to quickly get started with developing plugins.
diff --git a/getting-started/index.md b/getting-started/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Getting Started
 nav_order: 1
diff --git a/getting-started/installation.md b/getting-started/installation.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:54:48
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Installation
 description: How to install GatewayD and its plugins on different platforms and how to build it from source.
diff --git a/getting-started/running-gatewayd.md b/getting-started/running-gatewayd.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Running GatewayD
 description: How to run GatewayD and test it with psql
diff --git a/getting-started/welcome.md b/getting-started/welcome.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Welcome
 description: Introduction to GatewayD and its key features
diff --git a/miscellaneous/glossary.md b/miscellaneous/glossary.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Glossary
 description: Glossary of GatewayD terms
diff --git a/miscellaneous/index.md b/miscellaneous/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Miscellaneous
 nav_order: 6
diff --git a/miscellaneous/telemetry-and-usage-report.md b/miscellaneous/telemetry-and-usage-report.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Telemetry and Usage Report
 description: Telemetry and usage report of GatewayD
diff --git a/plugins/gatewayd-plugin-cache.md b/plugins/gatewayd-plugin-cache.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: gatewayd-plugin-cache
 description: GatewayD plugin for caching query results in Redis.
diff --git a/plugins/gatewayd-plugin-js.md b/plugins/gatewayd-plugin-js.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: gatewayd-plugin-js
 description: GatewayD plugin for running JS functions as hooks.
diff --git a/plugins/index.md b/plugins/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugins
 nav_order: 5
diff --git a/using-gatewayd/API.md b/using-gatewayd/API.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: API
 description: GatewayD exposes a gRPC API with an HTTP gateway for querying and managing the `gatewayd` process and its plugins.
diff --git a/using-gatewayd/Act.md b/using-gatewayd/Act.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-21 22:50:22
 layout: default
 title: Act
 description: Act is a policy engine that supports signals, policies and actions. It is used to automate the execution of business rules.
@@ -59,6 +59,7 @@ The action can be run in sync or async mode, and it can return a result or an er
 3. `sync`: Whether the action should be run in sync or async mode.
 4. `terminal`: Whether the action is terminal or not.
 5. `run`: The function that is executed when the action is triggered. This is currently written in Go, with support for writing actions in other languages to come.
+6. `timeout`: Optional value to indicate the timeout for the action in seconds. If not given, the `actionTimeout` value of [general configuration](/using-gatewayd/plugins-configuration/general-configurations#configuration-parameters) will be used to determine the timeout. If both of these values have a zero value, the action will run without a timeout.
 
 For example, [the action](https://github.com/gatewayd-io/gatewayd/blob/6ccf9b70be368fb935dbc133bf547eae9f590630/act/builtins.go#L61-L66) that matches the `terminate` policy can be written as:
 
diff --git a/using-gatewayd/CLI.md b/using-gatewayd/CLI.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: CLI
 description: GatewayD is a CLI application that runs on Windows, Linux-based distributions and macOS.
diff --git a/using-gatewayd/clients.md b/using-gatewayd/clients.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Clients
 description: Client object is a client that can connect to the database servers over TCP, UDP and Unix Domain Socket.
diff --git a/using-gatewayd/configuration.md b/using-gatewayd/configuration.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Configuration
 description: GatewayD is fully configurable via various sources, including default values, YAML config files, environment variables, CLI flags and plugins.
diff --git a/using-gatewayd/connection-lifecycle.md b/using-gatewayd/connection-lifecycle.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Connection Lifecycle
 description: Connection Lifecycle of GatewayD
diff --git a/using-gatewayd/global-configuration/api.md b/using-gatewayd/global-configuration/api.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: API
 description: GatewayD gRPC API configuration
diff --git a/using-gatewayd/global-configuration/clients.md b/using-gatewayd/global-configuration/clients.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Clients
 description: GatewayD client configuration
diff --git a/using-gatewayd/global-configuration/index.md b/using-gatewayd/global-configuration/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Global Configuration
 nav_order: 2
diff --git a/using-gatewayd/global-configuration/loggers.md b/using-gatewayd/global-configuration/loggers.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Loggers
 description: GatewayD logger configuration
diff --git a/using-gatewayd/global-configuration/metrics.md b/using-gatewayd/global-configuration/metrics.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Metrics
 description: GatewayD metrics configuration
diff --git a/using-gatewayd/global-configuration/pools.md b/using-gatewayd/global-configuration/pools.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Pools
 description: GatewayD pool configuration
diff --git a/using-gatewayd/global-configuration/proxies.md b/using-gatewayd/global-configuration/proxies.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Proxies
 description: GatewayD proxy configuration
diff --git a/using-gatewayd/global-configuration/servers.md b/using-gatewayd/global-configuration/servers.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Servers
 description: GatewayD server configuration
diff --git a/using-gatewayd/index.md b/using-gatewayd/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Using GatewayD
 nav_order: 2
diff --git a/using-gatewayd/observability.md b/using-gatewayd/observability.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Observability
 description: Observability is a first-class citizen of GatewayD. It generates logs, metrics and traces to make it easier to see what is going on inside.
diff --git a/using-gatewayd/plugins-configuration/general-configurations.md b/using-gatewayd/plugins-configuration/general-configurations.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-21 22:49:26
 layout: default
 title: General configurations
 description: General configurations for plugins
@@ -23,6 +23,7 @@ grand_parent: Using GatewayD
 | startTimeout        | string  | 1m            | Valid duration strings | The start timeout controls how long to wait for a plugin to start before timing out.                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | policyTimeout       | string  | 30s           | Valid duration strings | The policy timeout controls how long to wait for a policy to evaluate before timing out.                                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | policies            | array   | []            | An array of objects    | The policies are a set of rules that are evaluated against the signals to determine whether the actions should be executed.                                                                                                                                                                                                                                                                                                                                                                                                |
+| actionTimeout       | string  | 30s           | Valid duration strings | The action timeout will set a default timeout for all the actions that are going to be executed. Action specific timeout has priority over this value. Set to `0` to remove default action timeout.                                                                                                                                                                                                                                                                                                                        |
 
 ## Example configuration
 
@@ -35,6 +36,7 @@ reloadOnCrash: True
 timeout: 30s
 startTimeout: 1m
 policyTimeout: 30s
+actionTimeout: 30s
 policies:
   name: terminate
   policy: "Signal.terminate == true && Policy.terminate == 'stop'"
diff --git a/using-gatewayd/plugins-configuration/index.md b/using-gatewayd/plugins-configuration/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugins Configuration
 nav_order: 3
diff --git a/using-gatewayd/plugins-configuration/plugins-configuration.md b/using-gatewayd/plugins-configuration/plugins-configuration.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugins configuration
 description: GatewayD plugins configuration
diff --git a/using-gatewayd/pools.md b/using-gatewayd/pools.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Pools
 description: GatewayD has a generic internal pool object that is used to manage plugins and connections.
diff --git a/using-gatewayd/protocols.md b/using-gatewayd/protocols.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Protocols
 description: GatewayD is application layer protocol-agnostic. This means that GatewayD *can* practically support any protocol in the application layer, or L7.
diff --git a/using-gatewayd/proxies.md b/using-gatewayd/proxies.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Proxies
 description: Proxy object is used to create a binding between incoming connections from the database clients to the database servers.
diff --git a/using-gatewayd/servers.md b/using-gatewayd/servers.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Servers
 description: Server is an object that listens on an address:port pair and accepts connections from database clients.
diff --git a/using-plugins/hook-registry.md b/using-plugins/hook-registry.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Hook registry
 description: The hook registry is a central place where all hooks are registered and executed. It is used by the plugin registry to register and execute plugin hooks.
diff --git a/using-plugins/hooks.md b/using-plugins/hooks.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Hooks
 description: Plugins can be used to modify the connection lifecycle. Each step in the connection lifecycle is represented by one or more plugin hook(s). Plugins can register themselves to be called when a specific hook is triggered.
diff --git a/using-plugins/index.md b/using-plugins/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:43
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Using Plugins
 nav_order: 3
diff --git a/using-plugins/plugin-registry.md b/using-plugins/plugin-registry.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:44
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugin registry
 description: The plugin registry is a central place where all plugins are loaded, configured and executed, and also the main entry point for all plugins.
diff --git a/using-plugins/plugin-types.md b/using-plugins/plugin-types.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:44
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugin types
 description: >
diff --git a/using-plugins/plugins.md b/using-plugins/plugins.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:44
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Plugins
 description: Plugins play a very important role in GatewayD for adding support for different databases. They are the building blocks of GatewayD, and they are responsible for the majority of the functionality of GatewayD.
diff --git a/using-plugins/proposals.md b/using-plugins/proposals.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:47:44
+last_modified_date: 2024-03-10 23:57:06
 layout: default
 title: Proposals
 description: GatewayD proposals are used to propose new ideas and features for GatewayD.
