Skip to content

Commit

Permalink
Added doc node about usage across differen top routes.
Browse files Browse the repository at this point in the history
Related to #1277 report

(cherry picked from commit fefc33f)
  • Loading branch information
bogdan-iancu committed Feb 27, 2018
1 parent 224c60d commit ce4eae9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
9 changes: 9 additions & 0 deletions modules/benchmark/README
Expand Up @@ -93,6 +93,15 @@ Chapter 1. Admin Guide
that all durations are given as microseconds (don't confuse
with milliseconds!).

Important note: as this benchmarking is intended to measure the
time spent in executing different parts/blocks of the script
(and not for measuring the time induced by the SIP signaling),
the benchmark module is to be used within the SAME top route
(request route, failure route, branch route, onreply rout,
etc). It is not design to be used across different types of top
routes (like started in request route and ended in failure
route)!!

1.2. Dependencies

1.2.1. OpenSIPS Modules
Expand Down
8 changes: 8 additions & 0 deletions modules/benchmark/doc/benchmark_admin.xml
Expand Up @@ -16,6 +16,14 @@
via &osips;'s logging facility. Please note that all durations are given as
microseconds (don't confuse with milliseconds!).
</para>
<para> Important note: as this benchmarking is intended to measure the time
spent in executing different parts/blocks of the script (and not for
measuring the time induced by the SIP signaling), the benchmark module
is to be used within the SAME top route (request route, failure route,
branch route, onreply rout, etc). It is not design to be used across
different types of top routes (like started in request route and ended in
failure route)!!
</para>
</section>
<section>
<title>Dependencies</title>
Expand Down

0 comments on commit ce4eae9

Please sign in to comment.