A newer version is available. For the latest information, see the current release documentation.
« HAproxy module Icinga module »
Elastic Docs ›Filebeat Reference [7.17] ›Modules

IBM MQ module

edit

IBM MQ module

edit

The ibmmq module collects and parses the queue manager error logs from IBM MQ in the standard format.

When you run the module, it performs a few tasks under the hood:

  • Sets the default paths to the log files (but don’t worry, you can override the defaults)
  • Makes sure each multiline log event gets sent as a single event
  • Uses an Elasticsearch ingest pipeline to parse and process the log lines, shaping the data into a structure suitable for visualizing in Kibana

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

Compatibility

edit

This module has been tested with IBM MQ v9.1.0.0, but it should be compatible with older versions.

Configure the module

edit

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

The following example shows how to set paths in the modules.d/ibmmq.yml file to override the default paths for IBM MQ errorlog:

- module: ibmmq
  errorlog:
    enabled: true
    var.paths: ["C:/ibmmq/logs/*.log"]

Variable settings

edit

Each fileset has separate variable settings for configuring the behavior of the module. If you don’t specify variable settings, the ibmmq 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, ibmmq.errorlog.var.paths instead of errorlog.var.paths.

errorlog fileset settings

edit
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.

Example dashboard

edit

This module comes with a sample dashboard. For example:

filebeat ibmmq

Fields

edit

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

« HAproxy module Icinga module »