[proofpoint_on_demand] add keep_alive and keep_alive_interval config options (elastic#14760)

proofpoint_on_demand: add "keep_alive" and "keep_alive_interval" configuration options

This will help in cases where low volume connections run into idle
timeouts.

It has been added at the data stream level rather than the package level
as it is meant to be used as a last resort option for a specific data
stream in cases when intermittent timeouts/disconnects keep occurring.

Author: ShourieG

packages/proofpoint_on_demand/changelog.yml

@@ -1,4 +1,9 @@
 # newer versions go on top
+- version: "1.7.0"
+  changes:
+    - description: Added support for `keep_alive` and `keep_alive_interval` configuration options at the data stream level.
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/14760
 - version: "1.6.0"
   changes:
     - description: Remove duplicated installation instructions from the documentation

packages/proofpoint_on_demand/data_stream/audit/_dev/test/system/test-default-config.yml

@@ -1,4 +1,7 @@
 input: websocket
+skip:
+  reason: "Issues with unit state change (HEALTHY->DEGRADED) after latest metrics additions."
+  link: https://github.com/elastic/integrations/issues/14854
 service: proofpoint_on_demand-websocket
 vars:
   url: ws://{{Hostname}}:{{Port}}

packages/proofpoint_on_demand/data_stream/audit/agent/stream/websocket.yml.hbs

@@ -23,6 +23,10 @@ retry.blanket_retries: {{blanket_retries}}
 {{#if infinite_retries}}
 retry.infinite_retries: {{infinite_retries}}
 {{/if}}
+{{#if keep_alive}}
+keep_alive.enable: {{keep_alive}}
+keep_alive.interval: {{keep_alive_interval}}
+{{/if}}
 tags:
 {{#if preserve_original_event}}
   - preserve_original_event

packages/proofpoint_on_demand/data_stream/audit/manifest.yml

@@ -6,6 +6,22 @@ streams:
     description: Collecting Proofpoint On Demand Audit logs via Websocket.
     template_path: websocket.yml.hbs
     vars:
+      - name: keep_alive
+        type: bool
+        title: Keep Alive
+        description: If enabled the agent will send a keep alive message to the websocket endpoint depending on the configured "Keep Alive Interval" value.
+        multi: false
+        required: false
+        show_user: false
+        default: false
+      - name: keep_alive_interval
+        type: text
+        title: Keep Alive Interval
+        description: The interval at which the agent will send a keep alive message to the websocket endpoint. This is a time duration value. Examples, 30s, 1m, 1h.
+        multi: false
+        required: false
+        show_user: false
+        default: 30s
       - name: preserve_original_event
         required: true
         show_user: true

packages/proofpoint_on_demand/data_stream/mail/_dev/test/system/test-default-config.yml

@@ -1,4 +1,7 @@
 input: websocket
+skip:
+  reason: "Issues with unit state change (HEALTHY->DEGRADED) after latest metrics additions."
+  link: https://github.com/elastic/integrations/issues/14854
 service: proofpoint_on_demand-websocket
 vars:
   url: ws://{{Hostname}}:{{Port}}

packages/proofpoint_on_demand/data_stream/mail/agent/stream/websocket.yml.hbs

@@ -23,6 +23,10 @@ retry.blanket_retries: {{blanket_retries}}
 {{#if infinite_retries}}
 retry.infinite_retries: {{infinite_retries}}
 {{/if}}
+{{#if keep_alive}}
+keep_alive.enable: {{keep_alive}}
+keep_alive.interval: {{keep_alive_interval}}
+{{/if}}
 tags:
 {{#if preserve_original_event}}
   - preserve_original_event

packages/proofpoint_on_demand/data_stream/mail/manifest.yml

@@ -6,6 +6,22 @@ streams:
     description: Collecting Proofpoint On Demand Mail logs via Websocket.
     template_path: websocket.yml.hbs
     vars:
+      - name: keep_alive
+        type: bool
+        title: Keep Alive
+        description: If enabled the agent will send a keep alive message to the websocket endpoint depending on the configured "Keep Alive Interval" value.
+        multi: false
+        required: false
+        show_user: false
+        default: false
+      - name: keep_alive_interval
+        type: text
+        title: Keep Alive Interval
+        description: The interval at which the agent will send a keep alive message to the websocket endpoint. This is a time duration value. Examples, 30s, 1m, 1h.
+        multi: false
+        required: false
+        show_user: false
+        default: 30s
       - name: preserve_original_event
         required: true
         show_user: true

packages/proofpoint_on_demand/data_stream/message/_dev/test/system/test-default-config.yml

@@ -1,4 +1,7 @@
 input: websocket
+skip:
+  reason: "Issues with unit state change (HEALTHY->DEGRADED) after latest metrics additions."
+  link: https://github.com/elastic/integrations/issues/14854
 service: proofpoint_on_demand-websocket
 vars:
   url: ws://{{Hostname}}:{{Port}}

packages/proofpoint_on_demand/data_stream/message/agent/stream/websocket.yml.hbs

@@ -23,6 +23,10 @@ retry.blanket_retries: {{blanket_retries}}
 {{#if infinite_retries}}
 retry.infinite_retries: {{infinite_retries}}
 {{/if}}
+{{#if keep_alive}}
+keep_alive.enable: {{keep_alive}}
+keep_alive.interval: {{keep_alive_interval}}
+{{/if}}
 tags:
 {{#if preserve_original_event}}
   - preserve_original_event

packages/proofpoint_on_demand/data_stream/message/manifest.yml

@@ -6,6 +6,22 @@ streams:
     description: Collecting Proofpoint On Demand Message logs via Websocket.
     template_path: websocket.yml.hbs
     vars:
+      - name: keep_alive
+        type: bool
+        title: Keep Alive
+        description: If enabled the agent will send a keep alive message to the websocket endpoint depending on the configured "Keep Alive Interval" value.
+        multi: false
+        required: false
+        show_user: false
+        default: false
+      - name: keep_alive_interval
+        type: text
+        title: Keep Alive Interval
+        description: The interval at which the agent will send a keep alive message to the websocket endpoint. This is a time duration value. Examples, 30s, 1m, 1h.
+        multi: false
+        required: false
+        show_user: false
+        default: 30s
       - name: preserve_original_event
         required: true
         show_user: true