Skip to content

docs(readme): add a note for the minimal resolution limitations #29

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
ms2008 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(readme): add a note for the minimal resolution limitations #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c2c296
docs(readme): add a note for the minimal resolution limitations
ms2008 May 13, 2024
e4bba6f
Update README.md
ADD-SP May 13, 2024
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
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ A scalable timer library for OpenResty.

This library is currently considered experimental.

## Warning

The timer-ng can only manage timer tasks with `delay` settings greater than or equal to `resolution` currently, otherwise, those timers will fallback to OpenResty's native timer to be executed, which is out of the concurrency control of the timer-ng. And the current minimum value for `resolution` is `100ms`.


## Synopsis

```
Expand Down Expand Up @@ -69,7 +74,7 @@ http {
## Description

This system is based on the timer wheel algorithm.
which uses the small number of timers
which uses the small number of timers
created by OpenResty API `ngx.timer.at` to manage a large number of timed tasks.

In other words, it can reduce the number of fake requests.
Expand Down Expand Up @@ -97,7 +102,7 @@ The following information will be recorded in debug mode.
* The timers that are running
* Timers that are queued

In debug mode,
In debug mode,
you can call [stats()](#stats) to get the raw data needed to generate the flamegraph.


Expand Down Expand Up @@ -290,7 +295,7 @@ Get the statistics of the system.

* `options`:
* `verbose`: If `true`, the statistics for each timer will be returned, defualt `false`.
* `flamegraph`: If `true` and `verbose == true`, the raw data of flamegraph will be returned,
* `flamegraph`: If `true` and `verbose == true`, the raw data of flamegraph will be returned,
you can run `flamegraph.pl <output> > a.svg` to generate flamegraph, default `false`.

For example:
Expand Down Expand Up @@ -321,22 +326,22 @@ local flamegraph = info.flamegraph
-- ref https://github.com/brendangregg/FlameGraph


for timer_name, timer in pairs(info.jobs)
for timer_name, timer in pairs(info.jobs)
local is_running = timer.is_running
local meta = timer.meta
local stats = timer.stats
local runs = timer.runs -- total number of runs

-- meta.name is an automatically generated string
-- meta.name is an automatically generated string
-- that stores the location where the creation timer was created.
-- Such as 'task.lua:56:start_background_task()'

-- meta.callstack is a string.


stats = {
-- elapsed_time is a table that stores the
-- maximum, minimum, average and variance
-- elapsed_time is a table that stores the
-- maximum, minimum, average and variance
-- of the time spent on each run of the timer (second).
elapsed_time = {
max = 100
Expand Down