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

[oracle] Add initial implementation of oracle plugin #3889

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[oracle] Add initial implementation of oracle plugin #3889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions sos/report/plugins/oracle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

import os
from sos.report.plugins import Plugin, RedHatPlugin, PluginOpt


class Oracle(Plugin, RedHatPlugin):
Copy link
Member

Choose a reason for hiding this comment

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

Is there a more specific component name to use here perhaps? I think there may be some ambiguity with this and Oracle Linux as a distribution, or the Oracle DB offering, etc...

Since the plugin is centered around oratab, would that make sense as a name? I'll admit I'm not familiar with what the component/service surrounding oratab is, so maybe that doesn't fit.

short_desc = 'Oracle on Linux'

plugin_name = "oracle"
profiles = ('services',)
packages = ('oracle',)

pw_warn_text = " (password visible in process listings)"
Copy link
Member

Choose a reason for hiding this comment

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

We don't seem to use this anywhere?


option_list = [
PluginOpt('oratab', default='/etc/oratab', val_type=str,
desc='location of the oratab file')
]

def setup(self):
ora_tab = self.get_option('oratab')

if os.path.isfile(ora_tab):
self._log_warn("Found file oratab")
Copy link
Member

Choose a reason for hiding this comment

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

Why should we warn on this?

try:
with open(ora_tab, 'r', encoding='UTF-8') as ofile:
# Since the oratab file can have multiple unique SID
# entries that point to the same oracle home directory,
# keep track of the unique paths so we don't gather
# duplicate files
path_list = []
for line in ofile.read().splitlines():
if not line.startswith('#') and \
not line.isspace() and \
len(line) != 0:
words = line.split(':')
# check if this path has already been collected
if not words[1] in path_list:
path_list.append(words[1])
oracle_path = words[1]
if not oracle_path.endswith('/'):
oracle_path = f"{oracle_path}/"
self.add_copy_spec([
f"{oracle_path}dbs/init*.ora",
f"{oracle_path}dbs/spfile*.ora"
])
Comment on lines +33 to +53
Copy link
Member

Choose a reason for hiding this comment

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

I think we can button this up a little bit, and not have to manually track unique entries:

path_list = set()

with open(ora_tab, 'r', encoding='UTF-8') as ofile:
    for line in ofile.read().splitlines():
        if line.startswith('#') or not line.strip():
            continue
        path_list.add(line.split(':')[1])

dbfiles = [
    'dbs/init*.ora',
    'dbs/spfile*.ora'
]

self.add_copy_spec([
    self.path_join(path, dbfile) for dbfile in dbfiles for path in path_list
])


except IOError as ex:
self._log_error(f'Could not open conf file {ora_tab}: {ex}')
return
else:
self._log_warn("Could not locate oratab file. "
"Oracle data will not be collected.")

# vim: set et ts=4 sw=4 :
Loading