﻿---
title: Oracle module
description: This is a module for ingesting Audit Trail logs from Oracle Databases. The module expects an *.aud audit file that is generated from Oracle Databases...
url: https://www.elastic.co/elastic/docs-builder/docs/2831/reference/beats/filebeat/filebeat-module-oracle
products:
  - Beats
  - Filebeat
applies_to:
  - Elastic Cloud Serverless: Generally available
  - Elastic Stack: Generally available
---

# Oracle module
<admonition title="Prefer to use Elastic Agent for this use case?">
  Refer to the [Elastic Integrations documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2831/reference/oracle).
  <dropdown title="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](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2831/reference/fleet).
  </dropdown>
</admonition>

This is a module for ingesting Audit Trail logs from Oracle Databases.
The module expects an *.aud audit file that is generated from Oracle Databases by default. If this has been disabled then please see the [Oracle Database Audit Trail Documentation](https://docs.oracle.com/en/database/oracle/oracle-database/19/dbseg/introduction-to-auditing.html#GUID-8D96829C-9151-4FA4-BED9-831D088F12FF).
<tip>
  Read the [quick start](https://www.elastic.co/elastic/docs-builder/docs/2831/reference/beats/filebeat/filebeat-installation-configuration) to learn how to configure and run modules.
</tip>


## Compatibility

This module has been tested with Oracle Database 19c, and should work for 18c as well though it has not been tested.

## Configure the module

You can further refine the behavior of the `oracle` module by specifying [variable settings](#oracle-settings) in the `modules.d/oracle.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

Each fileset has separate variable settings for configuring the behavior of the module. If you don’t specify variable settings, the `oracle` module uses the defaults.
For advanced use cases, you can also override input settings. See [Override input settings](https://www.elastic.co/elastic/docs-builder/docs/2831/reference/beats/filebeat/advanced-settings).
<tip>
  When you specify a setting at the command line, remember to prefix the setting with the module name, for example, `oracle.database_audit.var.paths` instead of `database_audit.var.paths`.
</tip>


### `database_audit` fileset settings

Example config:
```yaml
- module: oracle
  database_audit:
    var.input: file
    var.paths: /home/user/oracleauditlogs/*/*.aud
```

<definitions>
  <definition term="var.paths">
    An array of glob-based paths that specify where to look for the log files. All patterns supported by [Go Glob](https://golang.org/pkg/path/filepath/#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.
  </definition>
  <definition term="var.tags">
    A list of tags to include in events. Including `forwarded` indicates that the events did not originate on this host and causes `host.name` to not be added to events. Defaults to `[oracle-database-audit]`.
  </definition>
</definitions>


### Oracle Database fields

Oracle Database fields are mapped to the current ECS Fields:

| Oracle Fields | ECS Fields       |
|---------------|------------------|
| privilege     | host.user.roles  |
| client_user   | client.user.name |
| userhost      | client.ip/domain |
| database_user | server.user.name |


## Fields

For a description of each field in the module, see the [exported fields](https://www.elastic.co/elastic/docs-builder/docs/2831/reference/beats/filebeat/exported-fields-oracle) section.