For the complete documentation index, see llms.txt. This page is also available as Markdown.

Manage audit and forwarding using the CLI

You can use the weka audit commands to configure and manage the audit and forwarding feature. The commands are organized into the following groups:

  • weka audit cluster: Manage audit settings at the cluster level.

  • weka audit fs: Manage audit settings for specific filesystems.

Manage cluster-level auditing

Use the weka audit cluster commands to control the audit feature for the entire cluster.

Enable or disable cluster-wide auditing

The auditing functionality is disabled by default. Enable it at the cluster level before you can configure auditing for specific filesystems. This initial enablement sets up the necessary infrastructure and components required for the audit system to function.

  • To enable:

    weka audit cluster enable
  • To disable:

    weka audit cluster disable

View cluster audit status

View the current cluster-wide status of the audit feature.

weka audit cluster status

View cluster audit statistics

View detailed statistics about the audit logs for the entire cluster.

Set the global audit operations

Defines the global default policy for which categories of operations are audited across the cluster. This policy applies to all filesystems but can be overridden by settings on an individual filesystem. You can choose to audit all categories or specify a subset (for example, read, delete).

Parameter

Name
Description

operations*

A space-separated list of operation categories to audit. Providing a new list replaces any previously set global operations.

Values: all, none, open, create, read, modify, delete, rename, close, sessionmanagement.

Manage full path resolution

Use the following commands to control the asynchronous process that adds full file paths to audit events. Including full paths provides valuable context for each operation but may introduce a performance impact. Disabling this feature can increase event throughput if the path information is not required for your use case.

  • To enable resolution of full file paths in forwarded audit events:

  • To disable the resolution of full file paths in forwarded audit events.:

Manage filesystem-level auditing

Use the weka audit fs commands to control audit settings for individual filesystems.

View filesystem audit status

List the audit status for all filesystems or a specific filesystem.

Parameter

Name
Description

name

The name of a specific filesystem to view.

Enable or disable auditing for a filesystem

Enable or disable auditing on a specific filesystem.

  • To enable:

  • To disable:

Parameter

Name
Description

name*

The name of the filesystem on which to enable or disable auditing.

Related topics

Manage filesystems using the GUI

Manage filesystems using the CLI

Set audit operations for a specific filesystem

Override the global audit settings and define a specific set of operations to audit for an individual filesystem.

Parameters

Name
Description

name*

The name of the filesystem to configure.

operations*

A space-separated list of operation categories to audit. This list replaces any previously set operations for this filesystem.

Possible values: all, none, open, create, read, modify, delete, rename, close, sessionmanagement.

View telemetry export health

Use the following command to check whether each export delivers audit events from every container:

weka telemetry exports status [<export-id>] [--containers] [--check]

The output shows one row per export:

  • Reporting: the number of containers delivering events, out of those expected. For example, 24/24.

  • Problems: what is wrong on the other containers. For example, 2 stalled, 1 container down. A destination that cannot be reached shows as send errors, and an export that stopped delivering audit events shows as stalled. The telemetry gateway keeps retrying an unreachable destination, so the export recovers on its own once the destination is reachable again.

  • Health: one of the following values.

Health
Meaning

OK

Every expected container delivers events.

DEGRADED

Some containers deliver events and others report a problem.

DOWN

No container delivers events, and at least one reports an error.

PENDING

No container delivers events yet, and none reports an error. Also shown when the containers that don't deliver events yet report no problem, for example, right after the export is added.

DISABLED

The export is disabled.

TELEMETRY OFF

The export is enabled, but telemetry is off in the cluster.

Parameters

Name
Description

export-id

The ID of the export to show. Shows every export when omitted.

--containers

Shows one row per container instead of one row per export. Each row shows the container's server, its state, and its source. reported means the container reported its own state. server means the server runs several containers, so the state can come from any of them. derived means no report exists for the container, so the CLI set the state, for example, when the container is down or never reported.

--check

Exits with code 2 when any export shown is DOWN, DEGRADED, or TELEMETRY OFF. Use it in monitoring scripts.

-J

Prints one JSON object per export with the same fields, including the per-container list.

Counts are exact at any cluster size. Server names are sampled: the cluster names a limited number of servers per state. When some containers are counted but not named, the --containers output shows the limit and how many containers are not named.

Last updated