Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Metricbeat] Update doc in tablespace metricset in the Oracle module to include required permissions #14497

Closed
wants to merge 1 commit into from
Closed

[Metricbeat] Update doc in tablespace metricset in the Oracle module to include required permissions #14497

wants to merge 1 commit into from

Conversation

robb3rt
Copy link
Contributor

@robb3rt robb3rt commented Nov 13, 2019

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 #14496 but for the tablespace metricset.

Update doc to include required permissions
6d45763 
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 #14496 but for the `tablespace` metricset.
@robb3rt robb3rt added docs review Team:Integrations Label for the Integrations team labels Nov 13, 2019
@robb3rt robb3rt requested a review from a team as a code owner November 13, 2019 10:32
ChrsMark
ChrsMark approved these changes Nov 14, 2019 •
edited
Loading
View reviewed changes
ChrsMark
ChrsMark reviewed Nov 14, 2019
View reviewed changes
Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this @robb3rt!

@sayden, may have a look too.

@sayden
Copy link
Contributor

sayden commented Nov 14, 2019

Hi @robb3rt ! Thank you for contributing with this! 🙂

I think it's also convenient to put this under a "Permissions"section, "tablespace" subsection in the file beats/x-pack/metricbeat/module/oracle/_meta/docs.asciidoc file.

The reason is that as an admin, I want a centralize place to see the permissions required to run this module, instead of having them spread between N files.

Then you'll need to run mage fmt update in the beats/x-pack/metricbeat folder and make update in beats/metricbeat (main folder). Have an eye that first command is mage with g and second command is make with k.

sayden
sayden reviewed Nov 14, 2019
View reviewed changes
x-pack/metricbeat/module/oracle/tablespace/_meta/docs.asciidoc
`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.

=== Required database access
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[float] is missing over this line

sayden
sayden suggested changes Nov 14, 2019
View reviewed changes
Copy link
Contributor

@sayden sayden left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't be possible to merge until the CI is happy with the docs part (make update in metricbeat folder as explained above)

@sayden sayden changed the title Update doc to include required permissions [Metricbeat] Update doc in Oracle module to include required permissions Nov 14, 2019
@sayden sayden added the Metricbeat Metricbeat label Nov 14, 2019
@sayden sayden changed the title [Metricbeat] Update doc in Oracle module to include required permissions [Metricbeat] Update doc in tablespace metricset in the Oracle module to include required permissions Nov 14, 2019
@ChrsMark
Copy link
Member

Ah, didn't notice the failing CI, thanks @sayden! 🙂

Also this should be tagged with 7.6 and needs_backport and backported to 7.x after merge, right?

@dedemorton dedemorton mentioned this pull request Feb 19, 2020
Merged
@dedemorton
Copy link
Contributor

Thanks for your contribution! I couldn't get this branch to pass tests, so I've created another PR with your commit: #16436

I will take care of backporting this (and the other PR I created) to the relevant branches.

@dedemorton dedemorton closed this Feb 19, 2020
@dedemorton dedemorton deleted the robb3rt-patch-2 branch February 19, 2020 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ChrsMark ChrsMark ChrsMark approved these changes

@sayden sayden sayden requested changes

Assignees

@sayden sayden

Labels
docs Metricbeat Metricbeat review Team:Integrations Label for the Integrations team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@robb3rt @sayden @ChrsMark @dedemorton @andresrc