aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/TelemetryUtil.py
blob: 1dbb2d45a31d026aad4e212747b2a230e51cf747 (plain) .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f
# Copyright (c) 2025 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Telemetry utility."""

from resources.libraries.python.model.ExportResult import append_telemetry
from resources.libraries.python.Constants import Constants
from resources.libraries.python.ssh import exec_cmd_no_error
from resources.libraries.python.topology import Topology, NodeType
from resources.libraries.python.SysctlUtil import SysctlUtil

__all__ = ["TelemetryUtil"]


class TelemetryUtil:
    """Class contains methods for telemetry utility."""

    @staticmethod
    def _run_telemetry(
            node, profile, sid=None, spath=None, rate="", export=False):
        """Get telemetry read on node.

        :param node: Node in the topology.
        :param profile: Telemetry configuration profile.
        :param sid: Socket ID used to describe recipient side of socket.
        :param spath: Socket path.
        :param rate: Telemetry load, unique within the test (optional).
        :param export: If false, do not attempt JSON export (default false).
        :type node: dict
        :type profile: str
        :type sid: str
        :type spath: str
        :type rate: str
        :type export: bool
        """
        config = ""
        config += f"{Constants.REMOTE_FW_DIR}/"
        config += f"{Constants.RESOURCES_TPL_TELEMETRY}/"
        config += f"{profile}"

        cd_cmd = ""
        cd_cmd += f"sh -c \"cd {Constants.REMOTE_FW_DIR}/"
        cd_cmd += f"{Constants.RESOURCES_TOOLS}"

        # Allow userspace to directly access perf counters on aarch64
        if Topology.get_node_arch(node) == u"aarch64":
            SysctlUtil.set_sysctl_value(node, u"kernel/perf_user_access", 1)

        if spath:
            bin_cmd = f"python3 -m telemetry --config {config} --hook {spath}\""
        else:
            bin_cmd = f"python3 -m telemetry --config {config}\""
        exec_cmd_no_error(node, f"{cd_cmd} && {bin_cmd}", sudo=True)

        if not export:
            return

        hostname = exec_cmd_no_error(node, "hostname")[0].strip()
        stdout, _ = exec_cmd_no_error(
            node, "cat /tmp/metric.prom", sudo=True, log_stdout_err=False
        )
        prefix = "{"
        prefix += f"hostname=\"{hostname}\","
        if sid:
            prefix += f"hook=\"{sid}\","
        prefix += f"rate=\"{rate}\","
        for line in stdout.splitlines():
            if line and not line.startswith("#"):
                append_telemetry(
                    prefix.join(line.rsplit("{", 1)).replace("\"", "'")
                )

    def run_telemetry_on_all_duts(self, nodes, profile, rate="", export=False):
        """Get telemetry read on all DUTs.

        :param nodes: Nodes in the topology.
        :param profile: Telemetry configuration profile.
        :param rate: Telemetry load, unique within the test (optional).
        :param export: If false, do not attempt JSON export (default false).
        :type nodes: dict
        :type profile: str
        :type rate: str
        :type export: bool
        """
        for node in nodes.values():
            if node["type"] == NodeType.DUT:
                try:
                    for sid, spath in node["sockets"]["CLI"].items():
                        self._run_telemetry(
                            node, profile=profile, sid=sid, spath=spath,
                            rate=rate, export=export
                        )
                except IndexError:
                    pass