Skip to content

Commit

Permalink
[Metricbeat] Update tablespace metricset in the Oracle module docs to…
Browse files Browse the repository at this point in the history
… include required permissions (elastic#16436) (elastic#16501)

* Update doc to include required permissions

There is a lack of details in this document regarding required permissions to the underlying database in order for the module to collect this information.

This may still need additional review. This is similar to change made here elastic#14496 but for the `tablespace` metricset.

* Add float tag

Co-authored-by: Robbert Hink <robbert.hink@elastic.co>

Co-authored-by: Robbert Hink <robbert.hink@elastic.co>
  • Loading branch information
dedemorton and Robbert Hink authored Feb 24, 2020
1 parent f3ee656 commit a483515
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion x-pack/metricbeat/module/oracle/tablespace/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
`tablespace` Metricset includes information about data files and temp files, grouped by Tablespace with free space available, used space, status of the data files, status of the Tablespace, etc. The total set of fields available on the Metricset and their description are the following:
`tablespace` Metricset includes information about data files and temp files, grouped by Tablespace with free space available, used space, status of the data files, status of the Tablespace, etc.

[float]
=== Required database access

To ensure that the module has access to the appropriate metrics, the module requires that you configure a user with access to the following tables:

* SYS.DBA_TEMP_FILES
* DBA_TEMP_FREE_SPACE
* dba_data_files
* dba_free_space

[float]
=== Description of fields

* *data_file.id*: Tablespace data file unique identifier number. Each data file of a Tablespace has a unique name (and each Tablespace may have more than one data file) but this is not the Tablespace ID.
* *data_file.name*: Filename of the data file (with the full path)
Expand Down

0 comments on commit a483515

Please sign in to comment.