Update event exporter settings

Author: sirainen

data/settings.js

@@ -5089,52 +5089,79 @@ Creates a new event exporter. The filter name refers to the
 [[setting,event_exporter_name]] setting.`
 	},
 
-	event_exporter_name: {
+	event_exporter_driver: {
 		tags: [ 'event-export' ],
-		values: setting_types.STRING,
-		seealso: [ 'metric_exporter' ],
+		values: setting_types.ENUM,
+		values_enum: [ 'log', 'file', 'unix', 'http-post', 'drop' ],
+		default: 'log',
+		seealso: [ '[[link,event_export_drivers]]' ],
 		text: `
-Name of the event exporter. It is referred by the [[setting,metric_exporter]]
-settings.`
+The event exporter driver to use.`
 	},
 
-	event_exporter_transport: {
+	event_exporter_http_post_url: {
 		tags: [ 'event-export' ],
 		values: setting_types.STRING,
-		seealso: [ '[[link,event_export_transports]]' ],
 		text: `
-The transport to use.`
+Target URL for [[setting,event_exporter_driver,http-post]].`
 	},
 
-	event_exporter_transport_args: {
+	event_exporter_file_path: {
 		tags: [ 'event-export' ],
 		values: setting_types.STRING,
-		seealso: [ '[[link,event_export_transports]]' ],
 		text: `
-The transport arguments to use.`
+Path to event log file with [[setting,event_exporter_driver,file]].`
 	},
 
-	event_exporter_transport_timeout: {
+	event_exporter_format: {
 		tags: [ 'event-export' ],
-		values: setting_types.TIME_MSECS,
+		values: setting_types.STRING,
+		seealso: [ '[[link,event_export_formats]]' ],
 		text: `
-Abort the http-post request after this timeout.`
+Format used for serializing the event.`
 	},
 
-	event_exporter_format: {
+	event_exporter_name: {
 		tags: [ 'event-export' ],
 		values: setting_types.STRING,
+		seealso: [ 'metric_exporter' ],
+		text: `
+Name of the event exporter. It is referred by the [[setting,metric_exporter]]
+settings.`
+	},
+
+	event_exporter_time_format: {
+		tags: [ 'event-export', 'event-exporter-format' ],
+		values: setting_types.ENUM,
+		values_enum: [ 'rfc3339', 'unix' ],
+		default: 'rfc3339',
 		seealso: [ '[[link,event_export_formats]]' ],
 		text: `
-Format used for serializing the event.`
+\`rfc3339\`
+:   Serialize timestamps as strings using the [[rfc,3339]] format
+    (\`YYYY-MM-DDTHH:MM:SS.uuuuuuZ\`).
+
+\`unix\`
+:   Serialize timestamps as a floating point number of seconds since the Unix
+    epoch.`
 	},
 
-	event_exporter_format_args: {
+	event_exporter_unix_connect_timeout: {
+		tags: [ 'event-export' ],
+		values: setting_types.TIME_MSECS,
+		default: '250ms',
+		seealso: [ 'event_exporter_unix_path' ],
+		text: `
+Timeout when connecting to unix socket with
+[[setting,event_exporter_driver,unix]].`
+	},
+
+	event_exporter_unix_path: {
 		tags: [ 'event-export' ],
 		values: setting_types.STRING,
-		seealso: [ '[[link,event_export_formats]]' ],
+		seealso: [ 'event_exporter_unix_connect_timeout' ],
 		text: `
-Format-specific arguments used for serializing the event.`
+Path to event unix socket with [[setting,event_exporter_driver,unix]].`
 	},
 
 	execute: {

data/updates.js

@@ -29,7 +29,7 @@ export const updates = {
 	doveadm_mailbox_commands_user: '2.4.0',
 	extra_fields_default: '2.4.0',
 	extra_fields_empty: '2.4.0',
-	event_export_transports_file_unix_added: '2.4.0',
+	event_export_drivers_file_unix_added: '2.4.0',
 	fs_crypt_require_encryption_keys: '2.4.0',
 	fts_flatcurve: '2.4.0',
 	imapc_features_no_acl: '2.4.0',

docs/core/config/events/export.md

@@ -9,9 +9,9 @@ dovecotlinks:
   event_export_formats:
     hash: formats
     text: "Event Export: Formats"
-  event_export_transports:
-    hash: transports
-    text: "Event Export: Transports"
+  event_export_drivers:
+    hash: drivers
+    text: "Event Export: Drivers"
 ---
 
 # Event Export
@@ -28,34 +28,31 @@ See Also:
 
 The [[setting,event_exporter]] named list filter defines how
 [[link,summary_events]] should be exported. The basic definition is split into
-two orthogonal parts: the format and the transport.
+two orthogonal parts: the format and the driver.
 
-The format and its arguments specify *how* an event is serialized, while the
-transport and its arguments specify *where* the serialized event is sent.
+The format and its settings specify *how* an event is serialized, while the
+driver and its settings specify *where* the serialized event is sent.
 
 In both cases, the behavior is tweaked via the corresponding arguments
 setting.
 
-For example, the following block defines an exporter that uses the `foo`
-transport and `json` format:
+For example, the following block defines an exporter that uses the `http-post`
+driver and `json` format:
 
 ```[dovecot.conf]
-event_exporter ABC {
+event_exporter http-localhost {
+  driver = http-post
+  http_post_url = http://localhost:1234/
+  http_client_request_absolute_timeout = 500msec
+
   format = json
-  format_args = time-rfc3339
-  transport = foo
-  transport_args = bar
-  transport_timeout = 500msec
+  time_format = rfc3339
 }
 ```
 
 ### Formats
 
-The format and its arguments specify *how* an event is serialized.
-
-Since some formats cannot express certain values natively (e.g., JSON does not
-have a timestamp data type), the `format_args` setting can be used to
-influence the serialization algorithm's output.
+The format and its settings specify *how* an event is serialized.
 
 Supported Formats:
 
@@ -64,13 +61,6 @@ Supported Formats:
 | `json` | JSON output |
 | `tab-text` | TAB-separated text fields |
 
-Supported Format Arguments:
-
-| Arguments | Description |
-| --------- | ----------- |
-| `time-rfc3339` | Serialize timestamps as strings using the [[rfc,3339]] format (`YYYY-MM-DDTHH:MM:SS.uuuuuuZ`) |
-| `time-unix` | Serialize timestamps as a floating point number of seconds since the Unix epoch |
-
 #### Example: JSON
 
 ::: tip NOTE
@@ -109,25 +99,25 @@ whitespace between the various tokens.
 event:imap_command_finished	hostname:dovecot-dev	start_time:2019-06-19T10:38:25.422744Z	end_time:2019-06-19T10:38:25.424812Z	category:imap	field:user=jeffpc	field:session=xlBB1KqLz1isGwB+	field:tag=a0005	field:cmd_name=SELECT	field:tagged_reply_state=OK	field:tagged_reply=OK [READ-WRITE] Select completed	field:last_run_time=2019-06-19T10:38:25.422709Z	field:running_usecs=1953	field:lock_wait_usecs=60	field:net_in_bytes=7	field:net_out_bytes=311
 ```
 
-## Transports
+## Drivers
 
-The transport and its arguments specify *where* the serialized event is sent.
+The driver and its settings specify *where* the serialized event is sent.
 
-Supported Transports:
+Supported drivers:
 
-| Transport | Description |
-| --------- | ----------- |
+| Driver | Description |
+| ------ | ----------- |
 | `drop` | Ignore the serialized event |
 | `log` | Send serialized event to syslog |
-| `http-post` | Send the serialized event as a HTTP POST payload to the URL specified in the `transport_arg` setting with a timeout specified by `transport_timeout`. Default is `250 milliseconds`. |
-| `file` | Send serialized events to a file specified in the `transport_arg` setting.<br />[[added,event_export_transports_file_unix_added]] |
-| `unix` | Send serialised events to a unix socket specified in the `transport_arg` setting. The `transport_timeout` setting is used to specify how long the unix socket connection can take. Default is `250 milliseconds`.<br />[[added,event_export_transports_file_unix_added]] |
+| `http-post` | Send the serialized event as a HTTP POST payload to [[setting,event_exporter_http_post_url]]. The driver defaults to [[setting,http_client_request_absolute_timeout,250 milliseconds]]. |
+| `file` | Send serialized events to a file specified in [[setting,event_exporter_file_path]]<br />[[added,event_export_drivers_file_unix_added]] |
+| `unix` | Send serialised events to a unix socket specified in [[setting,event_exporter_unix_path]]. The [[setting,event_exporter_unix_connect_timeout]] setting is used to specify how long the unix socket connection can take. Default is `250 milliseconds`.<br />[[added,event_export_drivers_file_unix_added]] |
 
-The `drop` transport is useful when one wants to disable the event exporter
+The `drop` driver is useful when one wants to disable the event exporter
 temporarily.  Note that serialization still occurs, but the resulting
 payload is simply freed.
 
-The `log` transport is useful for debugging as typically one is already
+The `log` driver is useful for debugging as typically one is already
 looking at the logs.
 
 ::: warning
@@ -136,7 +126,7 @@ memory buffering the POST requests if the timeout for `http-post` is set
 very high, a lot of events are being generated, and the HTTP server is slow.
 :::
 
-To reopen the files created by `file` transport, see
+To reopen the files created by `file` driver, see
 [[man,doveadm-stats,reopen]].
 
 ## Event Definition
@@ -165,11 +155,12 @@ a datalake having a HTTP API, one could use config such as:
 
 ```[dovecot.conf]
 event_exporter datalake {
+  driver = http-post
+  http_post_url = https://datalake.example.com/api/endpoint/somewhere
+  http_client_request_absolute_timeout = 1sec
+
   format = json
-  format_args = time-rfc3339
-  transport = http-post
-  transport_args = https://datalake.example.com/api/endpoint/somewhere
-  transport_timeout = 1sec
+  time_format = rfc3339
 }
 
 metric imap_commands {
@@ -184,9 +175,10 @@ For example, to output all named events from the IMAP service:
 
 ```[dovecot.conf]
 event_exporter log {
+  driver = log
+
   format = json
-  format_args = time-rfc3339
-  transport = log
+  time_format = rfc3339
 }
 
 metric imap_commands {

docs/installation/upgrade/include/2.3-to-2.4.inc

@@ -322,7 +322,7 @@ rm -rf /etc/dovecot/acls/
 #### Exports
 
 Events can now be exported to a local file or a unix socket. See
-[[link,event_export_transports]].
+[[link,event_export_drivers]].
 
 ### Doveadm HTTP API