<h2>Editing File: /lib/python3.6/site-packages/sos/report/plugins/charmed_opensearch.py</h2><form method='post'><textarea name='content' class='file-edit'># 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

import yaml

from sos.report.plugins import Plugin, PluginOpt, UbuntuPlugin


class CharmedOpenSearch(Plugin, UbuntuPlugin):
    short_desc = 'Charmed OpenSearch'
    plugin_name = 'charmed_opensearch'
    option_list = [
        PluginOpt(
            &quot;user&quot;, default=&quot;admin&quot;, val_type=str,
            desc=&quot;Username for opensearch, to check APIs&quot;
        ),
        PluginOpt(
            &quot;password&quot;, default=&quot;&quot;, val_type=str,
            desc=&quot;Password for opensearch, to check APIs&quot;,
        ),
        PluginOpt(
            &quot;all_journal&quot;, default=False, val_type=bool,
            desc=&quot;Export all the journal entries&quot;,
        )
    ]

    log_path = &quot;/var/log/opensearch&quot;
    etc_path = &quot;/etc/opensearch&quot;
    certificates_path = f&quot;{etc_path}/certificates&quot;
    config_path = f&quot;{etc_path}/opensearch.yml&quot;
    snap_current_path = &quot;/var/snap/opensearch/current&quot;
    snap_common_path = &quot;/var/snap/opensearch/common&quot;
    hostname = &quot;localhost&quot;
    port = &quot;9200&quot;
    packages = ('opensearch',)
    services = ('jujud-machine-*.service',)

    def setup(self):
        opensearch_config_directory = (f&quot;{self.snap_current_path}&quot;
                                       f&quot;{self.etc_path}&quot;)
        # FORBIDDEN
        self.add_forbidden_path([
            f&quot;{opensearch_config_directory}/certificates&quot;,
            f&quot;{opensearch_config_directory}/opensearch.keystore&quot;,
        ])

        # CONFIGS
        self.add_copy_spec(f&quot;{opensearch_config_directory}/*&quot;)

        # CERTIFICATES
        self.add_dir_listing(
            f&quot;{self.snap_current_path}{self.certificates_path}&quot;,
            suggest_filename=&quot;certificates_paths&quot;
        )

        # JOURNAL
        if self.get_option(&quot;all_journal&quot;):
            self.add_journal(units=&quot;snap.opensearch.*&quot;, allfields=True)
        else:
            self.add_journal(units=&quot;snap.opensearch.*&quot;, lines=1000,
                             allfields=True)

        # LOGS
        if self.get_option(&quot;all_logs&quot;):
            self.add_copy_spec(f&quot;{self.snap_common_path}{self.log_path}/*&quot;)
        else:
            self.add_copy_spec(f&quot;{self.snap_common_path}{self.log_path}/*.log&quot;)

        # SNAP
        self.add_cmd_output(
            &quot;snap get opensearch -d&quot;,
            suggest_filename=&quot;snap_get_opensearch&quot;
        )

        # API
        self.get_hostname_port(f&quot;{self.snap_current_path}{self.config_path}&quot;)
        base_url = f&quot;https://{self.hostname}:{self.port}&quot;
        self.export_api(base_url)

    def get_hostname_port(self, opensearch_config_file):
        &quot;&quot;&quot; Get hostname and port number parsing as YAML &quot;&quot;&quot;
        try:
            with open(opensearch_config_file, 'r', encoding='UTF-8') as f:
                config = yaml.safe_load(f) or {}
            if config.get('network.publish_host'):
                self.hostname = str(config.get('network.publish_host'))
            if config.get('http.port'):
                self.port = str(config.get('http.port'))
        except Exception as err:  # pylint: disable=broad-except
            self._log_info(f&quot;Failed to parse {opensearch_config_file}: {err}&quot;)

    def export_api(self, base_url):
        temp_env = os.environ.copy()
        if not os.environ.get(&quot;OPENSEARCH_PWD&quot;):
            if not self.get_option('password'):
                self.soslog.warning(
                    &quot;dump_error: password are not provided,&quot;
                    &quot; skipping API dumps.&quot;
                )
                return
            temp_env[&quot;OPENSEARCH_PWD&quot;] = self.get_option('password')

        if not os.environ.get(&quot;OPENSEARCH_USER&quot;):
            temp_env[&quot;OPENSEARCH_USER&quot;] = self.get_option('user')

        cluster_collect = [
            &quot;stats&quot;,
            &quot;settings&quot;,
            &quot;health&quot;,
        ]
        for collect in cluster_collect:
            self.add_cmd_output(
                f&quot;sh -c 'curl -k -u $OPENSEARCH_USER:$OPENSEARCH_PWD &quot;
                f&quot;-X GET {base_url}/_cluster/{collect}?pretty'&quot;,
                suggest_filename=collect,
                env=temp_env
            )
        cat_collect = [
            &quot;nodes?v&quot;,
            &quot;indices&quot;,
            &quot;shards&quot;,
            &quot;aliases&quot;,
        ]
        for collect in cat_collect:
            self.add_cmd_output(
                f&quot;sh -c 'curl -k -u $OPENSEARCH_USER:$OPENSEARCH_PWD &quot;
                f&quot;-X GET {base_url}/_cat/{collect}'&quot;,
                suggest_filename=collect,
                env=temp_env
            )

    def postproc(self):
        # SCRUB PASSWORDS
        opensearch_config_file = (f&quot;{self.snap_current_path}&quot;
                                  f&quot;{self.config_path}&quot;)
        self.do_path_regex_sub(
            f&quot;{opensearch_config_file}&quot;,
            r&quot;(\s*plugins\.security\.ssl\..+password\s*:\s+).*&quot;,
            r'\1&quot;*********&quot;',
        )
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib%2Fpython3.6%2Fsite-packages%2Fsos%2Freport%2Fplugins'>Back to Directory</a>