tarantool / tarantool/doc

[2pt] Describe LuaJIT profiler (aka "jit.p")

Open
#1,986 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

LuaJIT server
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: Tarantool
Root document: TBD
SME: @ igormunkin

Details

See link - https://www.tarantool.io/ru/doc/latest/book/admin/server_introspection/#jit-p

First of all, link to "The LuaJIT Profiler" is dead.

Secondly, it would be great to describe this feature in details started from flags and using some examples.

I expect to see something like in case with memprof.

ToDo

  • The description of the profiler is there in a separate resource: https://docs.imun.cloud/luajit/v2.1/ext_profiler.html
  • No need to duplicate this info in Tarantool documentation. The link to the article can be put in documentation, in a section related to different tooling useful for Tarantool users -- currently, there's no such a section, but later we can create it and put there the info about tools like Memory profiler, metrics, CPU profiler, etc.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by checking the current Tarantool documentation link for the LuaJIT Profiler and read the external profiler article at docs.imun.cloud/luajit/v2.1/ext_profiler.html. Confirm whether a tooling section exists; done means replacing the dead link or adding the external reference without duplicating the profiler documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.