Overview

Module xprof_gui_rest

• Description
• Function Index
• Function Details

Description

HTTP server independent part of the REST API implementation

Autocomplete

/api/funs

• 200: {"expansion": "commonPrefix", "matches": [{"expansion": "prefix", "label": "suggestionLabel"}, {...},...]}

Get expansion suggestions for the given possibly incomplete query. Used for autocomplete suggestions on the GUI. "commonPrefix" can be used to append to the query if no suggestion is selected. "prefix" can be appended to the query if the given suggestion is selected.

/api/get_callees

• "mod"
• "fun"
• "arity"

• 200: ["MFA"]

Get list of functions (MFAs) that are called by the specified function (MFA) based on static analysis (ie. not based on runtime information).

Monitoring functions

/api/mon_start

• "query" (""): the query string representing a XProf-flavoured match-spec

• 204 ""
• 400: {"message": "string"} (there was some error processing the query string)
• 409: {"message": "string"} (the requested MFA is already monitored)

Start monitoring based on the specified query string.

/api/mon_stop

• "mod"
• "fun"
• "arity"

• 204: ""

Stop monitoring the specified function (MFA).

/api/mon_get_all

• 200: [{"mfa": ["mod", "fun", "arity"], "query": "queryvalue", "graph_type": "percentiles"/"grid"]]

Return list of monitored functions. (The values of "mod", "fun" and "arity" can be used as params to calls to eg "/api/mon_stop" while "queryvalue" can be used to display the original query string).

/api/data

• "mod"
• "fun"
• "arity"
• "last_ts"

• 200: [{"time": timestamp, "histkey": number}] (where "histkey" is one of: min, mean, median, max, stddev, p25, p50, p75, p90, p99, p9999999, memsize, count)
• 404: "" (the requested MFA is not monitored)

Return metrics gathered for the given function since the given timestamp. Each item contains a timestamp and the corresponding histogram metrics values.

Global trace status

/api/trace_set

• "spec" ("all"/"pause")

• 204: ""
• 400: "" (if spec has invalid value)

Turn on or pause tracing of all processes.

/api/trace_status

• 200: {"status": "initialized"/"running"/"paused"/"overflow"}

Return current tracing state. (The initialized status is basically the same as paused, additionally meaning that no tracing was started yet since xprof was started)

Long call capturing

/api/capture

• "mod"
• "fun"
• "arity"
• "threshold"
• "limit"

• 202: {"capture_id": integer}
• 404: "" (the requested MFA is not monitored)

Start capturing arguments and return values of function calls that lasted longer than the specified time threshold in ms. Stop after limit number of captured calls.

/api/capture_stop

• "mod"
• "fun"
• "arity"

• 204: ""
• 404: "" (the requested MFA is not monitored or hasn't been captured yet)

Stop capturing long calls of the given function (MFA).

/api/capture_data

• "mod"
• "fun"
• "arity"
• "offset"

• 200: {"capture_id": integer, "threshold": integer, "limit": integer, "items": [Item], "has_more": boolean} where Item is {"id": number, "pid": string, "call_time": number, "args": string, "res": string}
• 404: "" (the requested MFA is not monitored)

Return captured arguments and return values.

The Offset argument is the item index last seen by the caller, only items newer than that will be returned. An offset of 0 will return all data.

The returned HasMore indicates whether capturing is still ongoing or it has been stopped either manually or by reaching the limit.

Syntax mode

/api/mode

• 200: {"mode": "erlang"/"elixir"}

Function Index

Function Details

handle_req/2

handle_req(Path :: binary(), Params :: [{binary(), binary()}]) ->
              StatusCode | {StatusCode, Body}

Overview

Generated by EDoc