DBCollect/Usage: Difference between revisions

From Dirty Cache Wiki
Jump to navigation Jump to search
No edit summary
Line 57: Line 57:
== version ==
== version ==


<code>--version</code> or <code>-V</code>
<code>-V | --version</code>


Shows detailed version, build and copyright details
Shows detailed version, build and copyright details
Line 63: Line 63:
== debug ==
== debug ==


<code>--debug</code> or <code>-D</code> enables debugging. This will result in more logging (sometimes dumping unhandled Python exceptions and traces.
<code>-D | --debug</code>
 
enables debugging. This will result in more logging (sometimes dumping unhandled Python exceptions and traces.


Even without this option, debug info is written to the {{dbcollect}} logfile for troubleshooting purposes.
Even without this option, debug info is written to the {{dbcollect}} logfile for troubleshooting purposes.
Line 69: Line 71:
== quiet ==
== quiet ==


<code>--quiet</code> or <code>-q</code> hides most normal terminal output (except errors). Useful for scripted runs (such as with [[DBCollect/Ansible]])
<code>-q | --quiet</code>
 
Hides most normal terminal output (except errors). Useful for scripted runs (such as with [[DBCollect/Ansible]])


== overwrite ==
== overwrite ==


<code>--overwrite | -o</code>
<code>-o | --overwrite</code>


Overwrites the previous dbcollect ZIP file if it exsts.
Overwrites the previous dbcollect ZIP file if it exsts.
== update ==
<code>--update</code>
Downloads new version of {{dbcollect}} from github and replaces the old version.
Requires https access to github.com
== sudoers ==
<code>--sudoers</code>
Writes sudoers settings to <code>/etc/sudoers.d/dbcollect</code>. This allows {{dbcollect}} to run some commands as root, that otherwise would fail.
This retrieves some extra, optional information. Not required, but on HP-UX highly recommended, as otherwise disk devices cannot be properly detected.
== sudoers ==
<code>--filename FILENAME</code>
Write to the given FILENAME instead of /tmp/dbcollect-<hostname>.zip.

Revision as of 13:53, 28 May 2024

Usage

Verify correct install

# Show version
dbcollect -V

# Show usage
dbcollect -h

# Update to last version (if the system has https access to github)
dbcollect --update

Run with default settings

# Default run
dbcollect

# If you get Error DBC-020 (zipfile already exists), you can overwrite the old zipfile:
dbcollect -o
# or
dbcollect --overwrite


Resolve AWR reporting issues

dbcollect checks for prior AWR usage to make sure it will not trigger Oracle license violations ( More info)

If you get Error [DBC-E021] No AWR or Statspack detected:

# If you are sure you have Diagnostics Pack license:
dbcollect --force-awr

# If you want to ignore databases without AWR usage:
dbcollect --ignore-awr

# If the problem databases are not important, try excluding them:
dbcollect --exclude inst1,inst2

Explanation of all options

help

--help or -h

Shows usage (list of all arguments)

version

-V | --version

Shows detailed version, build and copyright details

debug

-D | --debug

enables debugging. This will result in more logging (sometimes dumping unhandled Python exceptions and traces.

Even without this option, debug info is written to the dbcollect logfile for troubleshooting purposes.

quiet

-q | --quiet

Hides most normal terminal output (except errors). Useful for scripted runs (such as with DBCollect/Ansible)

overwrite

-o | --overwrite

Overwrites the previous dbcollect ZIP file if it exsts.

update

--update

Downloads new version of dbcollect from github and replaces the old version.

Requires https access to github.com

sudoers

--sudoers

Writes sudoers settings to /etc/sudoers.d/dbcollect. This allows dbcollect to run some commands as root, that otherwise would fail.

This retrieves some extra, optional information. Not required, but on HP-UX highly recommended, as otherwise disk devices cannot be properly detected.

sudoers

--filename FILENAME

Write to the given FILENAME instead of /tmp/dbcollect-<hostname>.zip.