websIDE
  • webside
    • Overview
  • API
    • General
      • Dialect
      • Version
      • Colors
      • Logo
      • Stats
      • Themes
      • Icons
      • Save Image
    • Changes
      • Retrieve changes
      • Apply a change
    • Changesets
      • Convert chunks to JSON changes
      • Convert JSON changes to chunks
    • Code
      • Autocompletions
        • Retrieve autocompletions
      • Categories
        • Retrieve categories
        • Retrieve usual categories
      • Classes
        • Retrieve classes
        • Retrieve a class
        • Retrieve categories
        • Retrieve variables
        • Retrieve class variables
        • Retrieve instance variables
        • Retrieve selectors
        • Retrieve methods
        • Retrieve method
        • Retrieve method history
        • Retrieve subclasses
        • Retrieve superclasses
        • Retrieve used categories
      • Methods
        • Retrieve methods
      • Packages
        • Retrieve packages
        • Retrieve a package
        • Retrieve package classes
        • Retrieve package methods
      • Search
      • Selectors
        • Find selector in source code
      • Templates
        • Retrieve class template
        • Retrieve method template
    • Debuggers
      • Retrieve active debuggers
      • Create a debugger
      • Delete debugger
      • Retrieve debugger frames
      • Retrieve debugger frame
      • Retrieve frame bindings
      • Restart debugger
      • Resume debugger
      • Step into debugger
      • Step over debugger
      • Step through debugger
      • Terminate debugger
    • Evaluations
      • Retrieve evaluations
      • Evaluate an expression
      • Cancel evaluation
      • Retrieve evaluation
      • Pause evaluation
      • Resume evaluation
    • Extensions
      • Retrieve extensions
      • Changes extensions
      • Export extensions
      • Search extensions
    • Commands
      • Retrieve command definitions
      • Invoke commands
    • Objects
      • Retrieve pinned objects
      • Pin object
      • Retrieve pinned object
      • Retrieve pinned object slots
        • Custom views
      • Unpin an object
      • Unpin all objects
    • Processes
      • Retrieve active processes
    • Profilers
      • Retrieve active profilers
      • Create a new profiler
      • Delete a profiler
      • Retrieve a profiler
      • Retrieve profiler ranking results
      • Retrieve profiler tree results
    • Testing
      • Run tests
      • Retrieve test run status
      • Retrieve test run results
    • Workspaces
      • Retrieve active workspaces
      • Create a new workspace
      • Delete a workspace
      • Retrieve a workspace
      • Update a workspace
      • Retrieve workspace bindings
Powered by GitBook
On this page
  1. API

Profilers

PreviousRetrieve active processesNextRetrieve active profilers

Last updated 12 months ago

A profiler is just a process observing another with the purpose of gathering statistics about executed code. In this sense, the API proposes to treat a profiler as an asynchronous evaluation (see for more information). The proposed workflow is the following:

  1. Issue a profiler, either by a POST to /profilers, or by using profile=true on a POST to /evaluations (see ).

  2. Follow the progress of the profiler by polling /profilers/{id} with profiler's ID (much as an evaluation progress is followed)

  3. Once the profiler state is finished, results can be retrieved from /profilers/{id}/tree and /profilers/{id}/ranking.

Endpoints to manage profilers and access their results.

Method
Path
Description
Parameters
Payload

POST

Create a new profiler on a given expression

-

expression

GET

Retrieve active profilers

-

-

GET

Retrieve the profiler with a given ID

-

-

GET

Retrieve a tree-like results of a given profiler

-

-

GET

Retrieve ranked results of a given profiler

-

-

DELETE

Delete a given profiler

-

-

evaluations
/profilers
/profilers
/profilers/{id}
/profilers/{id}/tree
/profilers/{id}/ranking
/profilers/{id}
\evaluations