simon/ocaml-opentelemetry
1
0
Fork 0
mirror of https://github.com/ocaml-tracing/ocaml-opentelemetry.git synced 2026-03-09 12:23:32 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
ocaml-opentelemetry/opentelemetry/Opentelemetry/Logs/index.html
c-cube 9fe721740a deploy: b2e62d527e
2025-03-27 13:35:42 +00:00

46 lines
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Logs (opentelemetry.Opentelemetry.Logs)</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> &#x00BB; <a href="../../index.html">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; 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><span> = <a href="../../Opentelemetry_proto/Logs/index.html#type-log_record">Opentelemetry_proto.Logs.log_record</a></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> = <a href="../../Opentelemetry_proto/Logs/index.html#type-severity_number">Opentelemetry_proto.Logs.severity_number</a></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><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../Opentelemetry_proto/Logs/index.html#type-severity_number">Opentelemetry_proto.Logs.severity_number</a> <span class="arrow">&#45;&gt;</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> = <a href="../../Opentelemetry_proto/Logs/index.html#type-log_record_flags">Opentelemetry_proto.Logs.log_record_flags</a></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><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../Opentelemetry_proto/Logs/index.html#type-log_record_flags">Opentelemetry_proto.Logs.log_record_flags</a> <span class="arrow">&#45;&gt;</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><span class="optlabel">?time</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?observed_time_unix_nano</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?severity</span>:<a href="../../Opentelemetry_proto/Logs/index.html#type-severity_number">Opentelemetry_proto.Logs.severity_number</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?log_level</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?flags</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?trace_id</span>:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?span_id</span>:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-value">value</a> <span class="arrow">&#45;&gt;</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><span class="optlabel">?time</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?observed_time_unix_nano</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?severity</span>:<a href="../../Opentelemetry_proto/Logs/index.html#type-severity_number">Opentelemetry_proto.Logs.severity_number</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?log_level</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?flags</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?trace_id</span>:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?span_id</span>:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</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><span class="optlabel">?time</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?observed_time_unix_nano</span>:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?severity</span>:<a href="../../Opentelemetry_proto/Logs/index.html#type-severity_number">Opentelemetry_proto.Logs.severity_number</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?log_level</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?flags</span>:int32 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?trace_id</span>:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?span_id</span>:<a href="../Span_id/index.html#type-t">Span_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a>, unit, <a href="#type-t">t</a>)</span> <a href="../../../ocaml/Stdlib/index.html#type-format4">format4</a></span> <span class="arrow">&#45;&gt;</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><span class="optlabel">?service_name</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?attrs</span>:
<span><span>(string
* <span>[&lt; <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">&#45;&gt;</span></span>
<span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</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>
Reference in a new issue View git blame Copy permalink