Skip to content

[v2] Add more granular metrics to benchmarking framework: plugin-load time, static imports time, client creation time. #10292

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

Open
aemous wants to merge 9 commits into
base: v2
Choose a base branch
from
+148 −24
Open

[v2] Add more granular metrics to benchmarking framework: plugin-load time, static imports time, client creation time. #10292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d30c8bf
Update scripts for benchmarking to comput plugin-imports
aemous May 5, 2026
6a7b2e2
Emit the load-plugins event.
aemous May 5, 2026
df1153d
some fixes
aemous May 5, 2026
e9d63c4
Add mock credentials to all benchmark stubs.
aemous May 5, 2026
513f611
Fix stubs template.
aemous May 5, 2026
f02244c
Update debug dir parameter so it supports relative paths.
aemous May 5, 2026
d385117
Finalize changes.
aemous May 6, 2026
c6684d5
Add client creation time.
aemous May 7, 2026
647b19c
Remove debug print statement.
aemous May 8, 2026
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
2 changes: 2 additions & 0 deletions awscli/botocore/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,7 @@ def create_client(
:return: A botocore client instance

"""
self.emit('before-create-client')
default_client_config = self.get_default_client_config()
# If a config is provided and a default config is set, then
# use the config resulting from merging the two.
Expand Down Expand Up @@ -960,6 +961,7 @@ def create_client(
monitor = self._get_internal_component('monitor')
if monitor is not None:
monitor.register(client.meta.events)
self.emit('after-create-client')
return client

def _resolve_region_name(self, region_name, config):
Expand Down
4 changes: 2 additions & 2 deletions awscli/clidriver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ def main():
return AWSCLIEntryPoint().main(sys.argv[1:])


def create_clidriver(args=None):
def create_clidriver(args=None, event_hooks=None):
debug = None
if args is not None:
parser = FirstPassGlobalArgParser()
args, _ = parser.parse_known_args(args)
debug = args.debug
session = botocore.session.Session()
session = botocore.session.Session(event_hooks=event_hooks)
_set_user_agent_for_session(session)
load_plugins(
session.full_config.get('plugins', {}),
Expand Down
2 changes: 2 additions & 0 deletions awscli/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ def load_plugins(plugin_mapping, event_hooks=None, include_builtins=True):
if event_hooks is None:
event_hooks = HierarchicalEmitter()
if include_builtins:
event_hooks.emit('before-load-plugins')
_load_plugins(BUILTIN_PLUGINS, event_hooks)
event_hooks.emit('after-load-plugins')
plugin_path = plugin_mapping.pop(CLI_LEGACY_PLUGIN_PATH, None)
if plugin_path is not None:
_add_plugin_path_to_sys_path(plugin_path)
Expand Down
98 changes: 84 additions & 14 deletions scripts/performance/benchmark_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

import psutil

from awscli.clidriver import AWSCLIEntryPoint, create_clidriver
from scripts.performance import BaseBenchmarkSuite
from scripts.performance.simple_stubbed_tests import (
JSONStubbedBenchmarkSuite,
Expand Down Expand Up @@ -169,6 +168,21 @@ def _finalize_processed_data_for_file(self, samples, worker_results):
worker_results['first_client_invocation_time']
- worker_results['start_time'],
),
'plugins.load.time': Metric(
'Total time spent loading all built-in plugins.',
'Seconds',
worker_results['load_plugins_time'],
),
'imports.static.time': Metric(
'Total time spent on static Python imports.',
'Seconds',
worker_results['static_imports_time'],
),
'client.creation.time': Metric(
'Total time spent creating a botocore client.',
'Seconds',
worker_results['create-client-time'],
),
}
# reset data state
self._samples.clear()
Expand Down Expand Up @@ -264,21 +278,72 @@ def _run_command_with_metric_hooks(self, cmd, out_file):
Runs a CLI command and logs CLI-specific metrics to a file.
"""
first_client_invocation_time = None
create_client_start_time = None
create_client_end_time = None
plugin_import_start_time = None
plugin_import_end_time = None
start_time = time.time()
driver = create_clidriver()
event_emitter = driver.session.get_component('event_emitter')

before_imports = start_time
# We import from awscli lazily to ensure import time is measured in
# total runtime.
from awscli.botocore.hooks import HierarchicalEmitter
from awscli.clidriver import AWSCLIEntryPoint, create_clidriver
after_imports = time.time()
Comment on lines +287 to +292
Copy link
Copy Markdown
Contributor

@hssyoo hssyoo May 20, 2026

Choose a reason for hiding this comment

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

What are we measuring here exactly?

Copy link
Copy Markdown
Contributor Author

@aemous aemous May 20, 2026

Choose a reason for hiding this comment

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

This is the time to import all modules used by the AWS CLI at runtime. It's similar to the granular benchmarking that you previously implemented where you measured "Python Library Imports."

It let's us measure the total amount of time spent during the AWS CLI runtime (i.e. after interpreter started) that is spent importing modules, before we start running any initialization code.

Looks fine but the static import measurement seems a bit dubious. I'd like to understand how we plan on using this measurement, what we expect it to catch, how we would react.

It is largely prompted by our previous observation that prompt_toolkit took up a significant fraction of runtime. It embeds the philosophy "if module imports previously took up too much runtime, we should monitor the metric over time so we don't lose track of it, to prevent future regressions."

During my dev builds, we're observing 119 ms of time taken during static imports. This starts off as a baseline, that we track changes in over time.

It also automatically implements the measure that we previously did ad-hoc. When we benchmarked it ad-hoc we found useful results (particularly hefty imports). So in my view, if it was useful once, then it should be useful to track in the long term.

"What we expect it to catch, how we would react"

For the most part, it should catch large regressions. If we notice this number change significantly, it would prompt us to investigate the regression, and consider refactoring code (e.g. lazy initialization). Overall, this should help us reduce the time between (A) unintentionally increasing command execution time due to a new hefty import and (B) allocating time to investigate and mitigate the regression.


def _log_invocation_time(params, request_signer, model, **kwargs):
nonlocal first_client_invocation_time
if first_client_invocation_time is None:
first_client_invocation_time = time.time()

event_emitter.register_last(
def _log_create_client_start(**kwargs):
nonlocal create_client_start_time
if create_client_start_time is None:
create_client_start_time = time.time()

def _log_create_client_end(**kwargs):
nonlocal create_client_end_time
if create_client_end_time is None:
create_client_end_time = time.time()

def _log_import_plugins_start(**kwargs):
nonlocal plugin_import_start_time
if plugin_import_start_time is None:
plugin_import_start_time = time.time()

def _log_import_plugins_end(**kwargs):
nonlocal plugin_import_end_time
if plugin_import_end_time is None:
plugin_import_end_time = time.time()

event_hooks = HierarchicalEmitter()
event_hooks.register_last(
'before-call',
_log_invocation_time,
'benchmarks.log-invocation-time',
)
event_hooks.register_last(
'before-create-client',
_log_create_client_start,
'benchmarks.log-before-create-client',
)
event_hooks.register_last(
'after-create-client',
_log_create_client_end,
'benchmarks.log-after-create-client',
)
event_hooks.register_last(
'before-load-plugins',
_log_import_plugins_start,
'benchmarks.log-before-load-plugins',
)
event_hooks.register_last(
'after-load-plugins',
_log_import_plugins_end,
'benchmarks.log-after-load-plugins',
)

driver = create_clidriver(event_hooks=event_hooks)
rc = AWSCLIEntryPoint(driver).main(cmd)
end_time = time.time()

Expand All @@ -291,6 +356,15 @@ def _log_invocation_time(params, request_signer, model, **kwargs):
'start_time': start_time,
'end_time': end_time,
'first_client_invocation_time': first_client_invocation_time,
'load_plugins_time': (
plugin_import_end_time - plugin_import_start_time
),
'static_imports_time': (
after_imports - before_imports
),
'create-client-time': (
create_client_end_time - create_client_start_time
)
}
)
)
Expand Down Expand Up @@ -333,20 +407,16 @@ def _run_isolated_benchmark(
os.dup2(err.fileno(), sys.stderr.fileno())
else:
with open(
os.path.abspath(
os.path.join(
args.debug_dir,
f'{benchmark["name"]}-{iteration}.txt',
)
os.path.join(
args.debug_dir,
f'{benchmark["name"]}-{iteration}.txt',
),
'w',
) as f:
with open(
os.path.abspath(
os.path.join(
args.debug_dir,
f'{benchmark["name"]}-{iteration}-err.txt',
)
os.path.join(
args.debug_dir,
f'{benchmark["name"]}-{iteration}-err.txt',
),
'w',
) as f_err:
Expand Down
Loading
Loading