mirror of
https://github.com/c-cube/nanoev.git
synced 2025-12-05 19:00:35 -05:00
57 lines
12 KiB
HTML
57 lines
12 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Callbacks (trace.Trace_event.Subscriber.Callbacks)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.0.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../../index.html">Index</a> » <a href="../../../index.html">trace</a> » <a href="../../index.html">Trace_event</a> » <a href="../index.html">Subscriber</a> » Callbacks</nav><header class="odoc-preamble"><h1>Module <code><span>Subscriber.Callbacks</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-st"><a href="#type-st" class="anchor"></a><code><span><span class="keyword">type</span> st</span><span> = <a href="../index.html#type-event_consumer">event_consumer</a></span></code></div><div class="spec-doc"><p>Type of the state passed to every callback.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_init"><a href="#val-on_init" class="anchor"></a><code><span><span class="keyword">val</span> on_init : <span><a href="#type-st">st</a> <span class="arrow">-></span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Called when the subscriber is initialized in a collector</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_shutdown"><a href="#val-on_shutdown" class="anchor"></a><code><span><span class="keyword">val</span> on_shutdown : <span><a href="#type-st">st</a> <span class="arrow">-></span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Called when the collector is shutdown</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_thread"><a href="#val-on_name_thread" class="anchor"></a><code><span><span class="keyword">val</span> on_name_thread : <span><a href="#type-st">st</a> <span class="arrow">-></span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span> <span><span class="label">tid</span>:int <span class="arrow">-></span></span> <span><span class="label">name</span>:string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Current thread is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_name_process"><a href="#val-on_name_process" class="anchor"></a><code><span><span class="keyword">val</span> on_name_process : <span><a href="#type-st">st</a> <span class="arrow">-></span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span> <span><span class="label">tid</span>:int <span class="arrow">-></span></span> <span><span class="label">name</span>:string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Current process is being named</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_span"><a href="#val-on_enter_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_span :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">__FILE__</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">__LINE__</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">name</span>:string <span class="arrow">-></span></span>
|
||
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Enter a regular (sync) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_span"><a href="#val-on_exit_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_span : <span><a href="#type-st">st</a> <span class="arrow">-></span></span> <span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span> <span><span class="label">tid</span>:int <span class="arrow">-></span></span> <span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Exit a span. This and <code>on_enter_span</code> must follow strict stack discipline</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_add_data"><a href="#val-on_add_data" class="anchor"></a><code><span><span class="keyword">val</span> on_add_data :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Add data to a regular span (which must be active)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_message"><a href="#val-on_message" class="anchor"></a><code><span><span class="keyword">val</span> on_message :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">span</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Emit a log message</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_counter"><a href="#val-on_counter" class="anchor"></a><code><span><span class="keyword">val</span> on_counter :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">name</span>:string <span class="arrow">-></span></span>
|
||
<span>float <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Emit the current value of a counter</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_enter_manual_span"><a href="#val-on_enter_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_enter_manual_span :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">__FUNCTION__</span>:<span>string option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">__FILE__</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">__LINE__</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">parent</span>:<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Enter a manual (possibly async) span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_exit_manual_span"><a href="#val-on_exit_manual_span" class="anchor"></a><code><span><span class="keyword">val</span> on_exit_manual_span :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><span class="label">name</span>:string <span class="arrow">-></span></span>
|
||
<span><span class="label">data</span>:<span><span>(string * <span class="xref-unresolved">Trace_subscriber__.Types.user_data</span>)</span> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">flavor</span>:<span><span class="xref-unresolved">Trace_subscriber__.Types.flavor</span> option</span> <span class="arrow">-></span></span>
|
||
<span><span class="label">trace_id</span>:<a href="../../../Trace_core/index.html#type-trace_id">Trace_core.trace_id</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../../Trace_core/index.html#type-span">Trace_core.span</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Exit a manual span</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-on_extension_event"><a href="#val-on_extension_event" class="anchor"></a><code><span><span class="keyword">val</span> on_extension_event :
|
||
<span><a href="#type-st">st</a> <span class="arrow">-></span></span>
|
||
<span><span class="label">time_ns</span>:int64 <span class="arrow">-></span></span>
|
||
<span><span class="label">tid</span>:int <span class="arrow">-></span></span>
|
||
<span><a href="../../../Trace_core/index.html#type-extension_event">Trace_core.extension_event</a> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Extension event</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.8</li></ul></div></div></div></body></html>
|