# Copyright 2014 Mirantis Inc.
# All Rights Reserved.
#
# 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.
import argparse
import json
import os
from typing import Any
from oslo_utils import encodeutils
from oslo_utils import uuidutils
import prettytable
from osprofiler.cmd import cliutils
from osprofiler.drivers import base
from osprofiler import exc
[docs]
class BaseCommand:
group_name: str | None = None
[docs]
class TraceCommands(BaseCommand):
group_name = "trace"
[docs]
@cliutils.arg("trace", help="File with trace or trace id")
@cliutils.arg(
"--connection-string",
dest="conn_str",
default=(cliutils.env("OSPROFILER_CONNECTION_STRING")),
help="Storage driver's connection string. Defaults to "
"env[OSPROFILER_CONNECTION_STRING] if set",
)
@cliutils.arg(
"--transport-url",
dest="transport_url",
help="Oslo.messaging transport URL (for messaging:// driver "
"only), e.g. rabbit://user:password@host:5672/",
)
@cliutils.arg(
"--idle-timeout",
dest="idle_timeout",
type=int,
default=1,
help="How long to wait for the trace to finish, in seconds "
"(for messaging:// driver only)",
)
@cliutils.arg(
"--json",
dest="use_json",
action="store_true",
help="show trace in JSON",
)
@cliutils.arg(
"--html",
dest="use_html",
action="store_true",
help="show trace in HTML",
)
@cliutils.arg(
"--local-libs",
dest="local_libs",
action="store_true",
help="use local static files of html in /libs/",
)
@cliutils.arg(
"--dot",
dest="use_dot",
action="store_true",
help="show trace in DOT language",
)
@cliutils.arg(
"--render-dot",
dest="render_dot_filename",
help="filename for rendering the dot graph in pdf format",
)
@cliutils.arg("--out", dest="file_name", help="save output in file")
def show(self, args: argparse.Namespace) -> None:
"""Display trace results in HTML, JSON or DOT format."""
if not args.conn_str:
raise exc.CommandError(
"You must provide connection string via"
" either --connection-string or "
"via env[OSPROFILER_CONNECTION_STRING]"
)
trace = None
if not uuidutils.is_uuid_like(args.trace):
trace = json.load(open(args.trace))
else:
try:
engine = base.get_driver(args.conn_str, **args.__dict__)
except Exception as e:
raise exc.CommandError(str(e))
trace = engine.get_report(args.trace)
if not trace or not trace.get("children"):
msg = (
f"Trace with UUID {args.trace} not found. Please check the "
f"HMAC key used in the command."
)
raise exc.CommandError(msg)
# Since datetime.datetime is not JSON serializable by default,
# this method will handle that.
def datetime_json_serialize(obj: Any) -> Any:
if hasattr(obj, "isoformat"):
return obj.isoformat()
else:
return obj
if args.use_json:
output = json.dumps(
trace,
default=datetime_json_serialize,
separators=(",", ": "),
indent=2,
)
elif args.use_html:
with open(
os.path.join(os.path.dirname(__file__), "template.html")
) as html_template:
output = html_template.read().replace(
"$DATA",
json.dumps(
trace,
indent=4,
separators=(",", ": "),
default=datetime_json_serialize,
),
)
if args.local_libs:
output = output.replace("$LOCAL", "true")
else:
output = output.replace("$LOCAL", "false")
elif args.use_dot:
dot_graph = self._create_dot_graph(trace)
output = dot_graph.source
if args.render_dot_filename:
dot_graph.render(args.render_dot_filename, cleanup=True)
else:
raise exc.CommandError(
"You should choose one of the following "
"output formats: json, html or dot."
)
if args.file_name:
with open(args.file_name, "w+") as output_file:
output_file.write(output)
else:
print(output)
def _create_dot_graph(self, trace: dict[str, Any]) -> Any:
try:
import graphviz # type: ignore[import-not-found]
except ImportError:
raise exc.CommandError(
"graphviz library is required to use this option."
)
dot = graphviz.Digraph(format="pdf")
next_id = [0]
def _create_node(info: dict[str, Any]) -> str:
time_taken = info["finished"] - info["started"]
service = info["service"] + ":" if "service" in info else ""
name = info["name"]
label = f"{service}{name} - {time_taken} ms"
if name == "wsgi":
req = info["meta.raw_payload.wsgi-start"]["info"]["request"]
label = "{}\\n{} {}..".format(
label, req["method"], req["path"][:30]
)
elif name == "rpc" or name == "driver":
raw = info[f"meta.raw_payload.{name}-start"]
fn_name = raw["info"]["function"]["name"]
label = "{}\\n{}".format(label, fn_name.split(".")[-1])
node_id = str(next_id[0])
next_id[0] += 1
dot.node(node_id, label)
return node_id
def _create_sub_graph(root: dict[str, Any]) -> str:
rid = _create_node(root["info"])
for child in root["children"]:
cid = _create_sub_graph(child)
dot.edge(rid, cid)
return rid
_create_sub_graph(trace)
return dot
[docs]
@cliutils.arg(
"--connection-string",
dest="conn_str",
default=cliutils.env("OSPROFILER_CONNECTION_STRING"),
help="Storage driver's connection string. Defaults to "
"env[OSPROFILER_CONNECTION_STRING] if set",
)
@cliutils.arg(
"--error-trace",
dest="error_trace",
type=bool,
default=False,
help="List all traces that contain error.",
)
def list(self, args: argparse.Namespace) -> None:
"""List all traces"""
if not args.conn_str:
raise exc.CommandError(
"You must provide connection string via"
" either --connection-string or "
"via env[OSPROFILER_CONNECTION_STRING]"
)
try:
engine = base.get_driver(args.conn_str, **args.__dict__)
except Exception as e:
raise exc.CommandError(str(e))
fields = ("base_id", "timestamp")
pretty_table = prettytable.PrettyTable(fields)
pretty_table.align = "l"
if not args.error_trace:
traces = engine.list_traces(set(fields))
else:
traces = engine.list_error_traces()
for trace in traces:
row = [trace[field] for field in fields]
pretty_table.add_row(row)
print(encodeutils.safe_encode(pretty_table.get_string()).decode())
