IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« ZooKeeper module Exported fields »
Elastic Docs ›Filebeat Reference [8.15] ›Modules

Zoom module

edit

Zoom module

edit

Prefer to use Elastic Agent for this use case?

Refer to the Elastic Integrations documentation.

Learn more

Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.

This is a module for Zoom webhook logs. The module creates an HTTP listener that accepts incoming webhooks from Zoom.

To configure Zoom to send webhooks to the filebeat module, please follow the Zoom Documentation.

Read the quick start to learn how to configure and run modules.

Configure the module

edit

You can further refine the behavior of the zoom module by specifying variable settings in the modules.d/zoom.yml file, or overriding settings at the command line.

You must enable at least one fileset in the module. Filesets are disabled by default.

Variable settings

edit

Each fileset has separate variable settings for configuring the behavior of the module. If you don’t specify variable settings, the zoom module uses the defaults.

For advanced use cases, you can also override input settings. See Override input settings.

When you specify a setting at the command line, remember to prefix the setting with the module name, for example, zoom.webhook.var.paths instead of webhook.var.paths.

webhook fileset settings

edit

When a webhook integration is created on Zoom, you can create a custom header to verify webhook events. See Custom Header for more information about this process. This is configured with the secret.header and secret.value settings as shown below.

On the other hand, Zoom also requires webhook validation for created or modified webhooks after October, 2022. This follows a challenge-response check (CRC) algorithm which is configured with the crc.enabled and crc.secret settings. Learn more about it at Validate your webhook endpoint.

Example config:

- module: zoom
  webhook:
    enabled: true
    var.input: http_endpoint
    var.listen_address: 0.0.0.0
    var.listen_port: 8080
    var.secret.header: x-my-custom-key
    var.secret.value: my-custom-value
    var.crc.enabled: true
    var.crc.secret: ZOOMSECRETTOKEN
var.paths
An array of glob-based paths that specify where to look for the log files. All patterns supported by Go Glob are also supported here. For example, you can use wildcards to fetch all files from a predefined level of subdirectories: /path/to/log/*/*.log. This fetches all .log files from the subfolders of /path/to/log. It does not fetch log files from the /path/to/log folder itself. If this setting is left empty, Filebeat will choose log paths based on your operating system.
var.listen_address
The IP address of the interface the module should listen on. Also supports 0.0.0.0 to listen on all interfaces.
var.listen_port
The port the module should be listening on.
var.ssl
Configuration options for SSL parameters like the SSL certificate and CA to use for the HTTP(s) listener See SSL for more information.

Fields

edit

For a description of each field in the module, see the exported fields section.

« ZooKeeper module Exported fields »