mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-09 12:23:32 -04:00
46 lines
No EOL
14 KiB
HTML
46 lines
No EOL
14 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs (opentelemetry.Opentelemetry.Logs)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">opentelemetry</a> » <a href="../index.html">Opentelemetry</a> » Logs</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Logs</span></code></h1><p>Logs.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#log-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-severity"><a href="#type-severity" class="anchor"></a><code><span><span class="keyword">type</span> severity</span><span> = </span></code><ol><li id="type-severity.Severity_number_unspecified" class="def variant constructor anchored"><a href="#type-severity.Severity_number_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_unspecified</span></span></code></li><li id="type-severity.Severity_number_trace" class="def variant constructor anchored"><a href="#type-severity.Severity_number_trace" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace</span></span></code></li><li id="type-severity.Severity_number_trace2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_trace2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace2</span></span></code></li><li id="type-severity.Severity_number_trace3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_trace3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace3</span></span></code></li><li id="type-severity.Severity_number_trace4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_trace4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace4</span></span></code></li><li id="type-severity.Severity_number_debug" class="def variant constructor anchored"><a href="#type-severity.Severity_number_debug" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug</span></span></code></li><li id="type-severity.Severity_number_debug2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_debug2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug2</span></span></code></li><li id="type-severity.Severity_number_debug3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_debug3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug3</span></span></code></li><li id="type-severity.Severity_number_debug4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_debug4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug4</span></span></code></li><li id="type-severity.Severity_number_info" class="def variant constructor anchored"><a href="#type-severity.Severity_number_info" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info</span></span></code></li><li id="type-severity.Severity_number_info2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_info2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info2</span></span></code></li><li id="type-severity.Severity_number_info3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_info3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info3</span></span></code></li><li id="type-severity.Severity_number_info4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_info4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info4</span></span></code></li><li id="type-severity.Severity_number_warn" class="def variant constructor anchored"><a href="#type-severity.Severity_number_warn" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn</span></span></code></li><li id="type-severity.Severity_number_warn2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_warn2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn2</span></span></code></li><li id="type-severity.Severity_number_warn3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_warn3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn3</span></span></code></li><li id="type-severity.Severity_number_warn4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_warn4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn4</span></span></code></li><li id="type-severity.Severity_number_error" class="def variant constructor anchored"><a href="#type-severity.Severity_number_error" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error</span></span></code></li><li id="type-severity.Severity_number_error2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_error2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error2</span></span></code></li><li id="type-severity.Severity_number_error3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_error3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error3</span></span></code></li><li id="type-severity.Severity_number_error4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_error4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error4</span></span></code></li><li id="type-severity.Severity_number_fatal" class="def variant constructor anchored"><a href="#type-severity.Severity_number_fatal" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal</span></span></code></li><li id="type-severity.Severity_number_fatal2" class="def variant constructor anchored"><a href="#type-severity.Severity_number_fatal2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal2</span></span></code></li><li id="type-severity.Severity_number_fatal3" class="def variant constructor anchored"><a href="#type-severity.Severity_number_fatal3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal3</span></span></code></li><li id="type-severity.Severity_number_fatal4" class="def variant constructor anchored"><a href="#type-severity.Severity_number_fatal4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal4</span></span></code></li></ol></div><div class="spec-doc"><p>Severity level of a log event</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_severity"><a href="#val-pp_severity" class="anchor"></a><code><span><span class="keyword">val</span> pp_severity :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-flags"><a href="#type-flags" class="anchor"></a><code><span><span class="keyword">type</span> flags</span><span> = </span></code><ol><li id="type-flags.Log_record_flags_do_not_use" class="def variant constructor anchored"><a href="#type-flags.Log_record_flags_do_not_use" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flags_do_not_use</span></span></code></li><li id="type-flags.Log_record_flags_trace_flags_mask" class="def variant constructor anchored"><a href="#type-flags.Log_record_flags_trace_flags_mask" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flags_trace_flags_mask</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_flags"><a href="#val-pp_flags" class="anchor"></a><code><span><span class="keyword">val</span> pp_flags :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record_flags</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make"><a href="#val-make" class="anchor"></a><code><span><span class="keyword">val</span> make :
|
||
<span>?time:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?observed_time_unix_nano:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">-></span></span>
|
||
<span>?log_level:string <span class="arrow">-></span></span>
|
||
<span>?flags:int32 <span class="arrow">-></span></span>
|
||
<span>?trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||
<span>?span_id:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">-></span></span>
|
||
<span><a href="../index.html#type-value">value</a> <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make a single log entry</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_str"><a href="#val-make_str" class="anchor"></a><code><span><span class="keyword">val</span> make_str :
|
||
<span>?time:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?observed_time_unix_nano:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">-></span></span>
|
||
<span>?log_level:string <span class="arrow">-></span></span>
|
||
<span>?flags:int32 <span class="arrow">-></span></span>
|
||
<span>?trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||
<span>?span_id:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">-></span></span>
|
||
<span>string <span class="arrow">-></span></span>
|
||
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Make a log entry whose body is a string</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_strf"><a href="#val-make_strf" class="anchor"></a><code><span><span class="keyword">val</span> make_strf :
|
||
<span>?time:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?observed_time_unix_nano:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">-></span></span>
|
||
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">-></span></span>
|
||
<span>?log_level:string <span class="arrow">-></span></span>
|
||
<span>?flags:int32 <span class="arrow">-></span></span>
|
||
<span>?trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">-></span></span>
|
||
<span>?span_id:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">-></span></span>
|
||
<span><span><span>(<span class="type-var">'a</span>, <span class="xref-unresolved">Stdlib</span>.Format.formatter, unit, <a href="#type-t">t</a>)</span> <span class="xref-unresolved">Stdlib</span>.format4</span> <span class="arrow">-></span></span>
|
||
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Make a log entry with format</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-emit"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit :
|
||
<span>?service_name:string <span class="arrow">-></span></span>
|
||
<span>?attrs:
|
||
<span><span>(string
|
||
* <span>[< <span>`Bool of bool</span>
|
||
<span><span>| `Float</span> of float</span>
|
||
<span><span>| `Int</span> of int</span>
|
||
<span>| `None</span>
|
||
<span><span>| `String</span> of string</span> ]</span>)</span>
|
||
list</span> <span class="arrow">-></span></span>
|
||
<span><span><a href="#type-t">t</a> list</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Emit logs.</p><p>This instructs the collector to send the logs to some backend at a later date. <b>NOTE</b> be careful not to call this inside a Gc alarm, as it can cause deadlocks.</p></div></div></div></body></html> |