Add example that manually adds stats entries #1645
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an example with a
manual_report()
decorator/context manager that can be used to easily measure the time of functions/code blocks and manually report them as stats entries to the Locust statistics.I wrote up the
manual_report()
functionality as an example for a user in the Locust Slack, and I think it turned out pretty.We could also consider actually making
manual_report
part of Locust's API. For example underlocust.contrib.report.manual_report
. Though I'm not sure it's useful enough to warrant including it with locust itself?Usage example as a context manager:
Usage as a decorator:
Even if we don't want to add it udner
locust.contrib.report.manual_report
I think it can be a useful example.