ocaml-opentelemetry/dev/opentelemetry-lwt/Opentelemetry_lwt/Logs/index.html
2023-08-28 14:46:53 +00:00

105 lines
No EOL
42 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-lwt.Opentelemetry_lwt.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-lwt</a> &#x00BB; <a href="../index.html">Opentelemetry_lwt</a> &#x00BB; Logs</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Logs</span></code></h1></header><div class="odoc-content"><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Proto/Logs/index.html">Opentelemetry.Proto.Logs</a> <span class="keyword">end</span></span></code></summary><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type anchored" id="type-severity_number"><a href="#type-severity_number" class="anchor"></a><code><span><span class="keyword">type</span> severity_number</span><span> = </span></code><ol><li id="type-severity_number.Severity_number_unspecified" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_unspecified</span></span></code></li><li id="type-severity_number.Severity_number_trace" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_trace" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace</span></span></code></li><li id="type-severity_number.Severity_number_trace2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_trace2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace2</span></span></code></li><li id="type-severity_number.Severity_number_trace3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_trace3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace3</span></span></code></li><li id="type-severity_number.Severity_number_trace4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_trace4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_trace4</span></span></code></li><li id="type-severity_number.Severity_number_debug" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_debug" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug</span></span></code></li><li id="type-severity_number.Severity_number_debug2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_debug2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug2</span></span></code></li><li id="type-severity_number.Severity_number_debug3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_debug3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug3</span></span></code></li><li id="type-severity_number.Severity_number_debug4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_debug4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_debug4</span></span></code></li><li id="type-severity_number.Severity_number_info" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_info" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info</span></span></code></li><li id="type-severity_number.Severity_number_info2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_info2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info2</span></span></code></li><li id="type-severity_number.Severity_number_info3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_info3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info3</span></span></code></li><li id="type-severity_number.Severity_number_info4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_info4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_info4</span></span></code></li><li id="type-severity_number.Severity_number_warn" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_warn" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn</span></span></code></li><li id="type-severity_number.Severity_number_warn2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_warn2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn2</span></span></code></li><li id="type-severity_number.Severity_number_warn3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_warn3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn3</span></span></code></li><li id="type-severity_number.Severity_number_warn4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_warn4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_warn4</span></span></code></li><li id="type-severity_number.Severity_number_error" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_error" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error</span></span></code></li><li id="type-severity_number.Severity_number_error2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_error2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error2</span></span></code></li><li id="type-severity_number.Severity_number_error3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_error3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error3</span></span></code></li><li id="type-severity_number.Severity_number_error4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_error4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_error4</span></span></code></li><li id="type-severity_number.Severity_number_fatal" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_fatal" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal</span></span></code></li><li id="type-severity_number.Severity_number_fatal2" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_fatal2" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal2</span></span></code></li><li id="type-severity_number.Severity_number_fatal3" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_fatal3" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal3</span></span></code></li><li id="type-severity_number.Severity_number_fatal4" class="def variant constructor anchored"><a href="#type-severity_number.Severity_number_fatal4" class="anchor"></a><code><span>| </span><span><span class="constructor">Severity_number_fatal4</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-log_record"><a href="#type-log_record" class="anchor"></a><code><span><span class="keyword">type</span> log_record</span><span> = </span><span>{</span></code><ol><li id="type-log_record.time_unix_nano" class="def record field anchored"><a href="#type-log_record.time_unix_nano" class="anchor"></a><code><span>time_unix_nano : int64;</span></code></li><li id="type-log_record.observed_time_unix_nano" class="def record field anchored"><a href="#type-log_record.observed_time_unix_nano" class="anchor"></a><code><span>observed_time_unix_nano : int64;</span></code></li><li id="type-log_record.severity_number" class="def record field anchored"><a href="#type-log_record.severity_number" class="anchor"></a><code><span>severity_number : <a href="#type-severity_number">severity_number</a>;</span></code></li><li id="type-log_record.severity_text" class="def record field anchored"><a href="#type-log_record.severity_text" class="anchor"></a><code><span>severity_text : string;</span></code></li><li id="type-log_record.body" class="def record field anchored"><a href="#type-log_record.body" class="anchor"></a><code><span>body : <span><span class="xref-unresolved">Opentelemetry__.Common_types.any_value</span> option</span>;</span></code></li><li id="type-log_record.attributes" class="def record field anchored"><a href="#type-log_record.attributes" class="anchor"></a><code><span>attributes : <span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value</span> list</span>;</span></code></li><li id="type-log_record.dropped_attributes_count" class="def record field anchored"><a href="#type-log_record.dropped_attributes_count" class="anchor"></a><code><span>dropped_attributes_count : int32;</span></code></li><li id="type-log_record.flags" class="def record field anchored"><a href="#type-log_record.flags" class="anchor"></a><code><span>flags : int32;</span></code></li><li id="type-log_record.trace_id" class="def record field anchored"><a href="#type-log_record.trace_id" class="anchor"></a><code><span>trace_id : bytes;</span></code></li><li id="type-log_record.span_id" class="def record field anchored"><a href="#type-log_record.span_id" class="anchor"></a><code><span>span_id : bytes;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-scope_logs"><a href="#type-scope_logs" class="anchor"></a><code><span><span class="keyword">type</span> scope_logs</span><span> = </span><span>{</span></code><ol><li id="type-scope_logs.scope" class="def record field anchored"><a href="#type-scope_logs.scope" class="anchor"></a><code><span>scope : <span><span class="xref-unresolved">Opentelemetry__.Common_types.instrumentation_scope</span> option</span>;</span></code></li><li id="type-scope_logs.log_records" class="def record field anchored"><a href="#type-scope_logs.log_records" class="anchor"></a><code><span>log_records : <span><a href="#type-log_record">log_record</a> list</span>;</span></code></li><li id="type-scope_logs.schema_url" class="def record field anchored"><a href="#type-scope_logs.schema_url" class="anchor"></a><code><span>schema_url : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-resource_logs"><a href="#type-resource_logs" class="anchor"></a><code><span><span class="keyword">type</span> resource_logs</span><span> = </span><span>{</span></code><ol><li id="type-resource_logs.resource" class="def record field anchored"><a href="#type-resource_logs.resource" class="anchor"></a><code><span>resource : <span><span class="xref-unresolved">Opentelemetry__.Resource_types.resource</span> option</span>;</span></code></li><li id="type-resource_logs.scope_logs" class="def record field anchored"><a href="#type-resource_logs.scope_logs" class="anchor"></a><code><span>scope_logs : <span><a href="#type-scope_logs">scope_logs</a> list</span>;</span></code></li><li id="type-resource_logs.schema_url" class="def record field anchored"><a href="#type-resource_logs.schema_url" class="anchor"></a><code><span>schema_url : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-logs_data"><a href="#type-logs_data" class="anchor"></a><code><span><span class="keyword">type</span> logs_data</span><span> = </span><span>{</span></code><ol><li id="type-logs_data.resource_logs" class="def record field anchored"><a href="#type-logs_data.resource_logs" class="anchor"></a><code><span>resource_logs : <span><a href="#type-resource_logs">resource_logs</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-log_record_flags"><a href="#type-log_record_flags" class="anchor"></a><code><span><span class="keyword">type</span> log_record_flags</span><span> = </span></code><ol><li id="type-log_record_flags.Log_record_flag_unspecified" class="def variant constructor anchored"><a href="#type-log_record_flags.Log_record_flag_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flag_unspecified</span></span></code></li><li id="type-log_record_flags.Log_record_flag_trace_flags_mask" class="def variant constructor anchored"><a href="#type-log_record_flags.Log_record_flag_trace_flags_mask" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flag_trace_flags_mask</span></span></code></li></ol></div></div><h3 id="default-values"><a href="#default-values" class="anchor"></a>Default values</h3><div class="odoc-spec"><div class="spec value anchored" id="val-default_severity_number"><a href="#val-default_severity_number" class="anchor"></a><code><span><span class="keyword">val</span> default_severity_number : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-severity_number">severity_number</a></span></code></div><div class="spec-doc"><p><code>default_severity_number ()</code> is the default value for type <code>severity_number</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_log_record"><a href="#val-default_log_record" class="anchor"></a><code><span><span class="keyword">val</span> default_log_record :
<span>?time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?observed_time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?severity_number:<a href="#type-severity_number">severity_number</a> <span class="arrow">&#45;&gt;</span></span>
<span>?severity_text:string <span class="arrow">&#45;&gt;</span></span>
<span>?body:<span><span class="xref-unresolved">Opentelemetry__.Common_types.any_value</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>?attributes:<span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?dropped_attributes_count:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?flags:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?trace_id:bytes <span class="arrow">&#45;&gt;</span></span>
<span>?span_id:bytes <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-log_record">log_record</a></span></code></div><div class="spec-doc"><p><code>default_log_record ()</code> is the default value for type <code>log_record</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_scope_logs"><a href="#val-default_scope_logs" class="anchor"></a><code><span><span class="keyword">val</span> default_scope_logs :
<span>?scope:<span><span class="xref-unresolved">Opentelemetry__.Common_types.instrumentation_scope</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>?log_records:<span><a href="#type-log_record">log_record</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?schema_url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-scope_logs">scope_logs</a></span></code></div><div class="spec-doc"><p><code>default_scope_logs ()</code> is the default value for type <code>scope_logs</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_resource_logs"><a href="#val-default_resource_logs" class="anchor"></a><code><span><span class="keyword">val</span> default_resource_logs :
<span>?resource:<span><span class="xref-unresolved">Opentelemetry__.Resource_types.resource</span> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>?scope_logs:<span><a href="#type-scope_logs">scope_logs</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?schema_url:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-resource_logs">resource_logs</a></span></code></div><div class="spec-doc"><p><code>default_resource_logs ()</code> is the default value for type <code>resource_logs</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_logs_data"><a href="#val-default_logs_data" class="anchor"></a><code><span><span class="keyword">val</span> default_logs_data : <span>?resource_logs:<span><a href="#type-resource_logs">resource_logs</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-logs_data">logs_data</a></span></code></div><div class="spec-doc"><p><code>default_logs_data ()</code> is the default value for type <code>logs_data</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_log_record_flags"><a href="#val-default_log_record_flags" class="anchor"></a><code><span><span class="keyword">val</span> default_log_record_flags : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-log_record_flags">log_record_flags</a></span></code></div><div class="spec-doc"><p><code>default_log_record_flags ()</code> is the default value for type <code>log_record_flags</code></p></div></div><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value anchored" id="val-encode_severity_number"><a href="#val-encode_severity_number" class="anchor"></a><code><span><span class="keyword">val</span> encode_severity_number :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_severity_number v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_log_record"><a href="#val-encode_log_record" class="anchor"></a><code><span><span class="keyword">val</span> encode_log_record :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_log_record v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_scope_logs"><a href="#val-encode_scope_logs" class="anchor"></a><code><span><span class="keyword">val</span> encode_scope_logs :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.scope_logs</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_scope_logs v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_resource_logs"><a href="#val-encode_resource_logs" class="anchor"></a><code><span><span class="keyword">val</span> encode_resource_logs :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.resource_logs</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_resource_logs v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_logs_data"><a href="#val-encode_logs_data" class="anchor"></a><code><span><span class="keyword">val</span> encode_logs_data :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.logs_data</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_logs_data v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode_log_record_flags"><a href="#val-encode_log_record_flags" class="anchor"></a><code><span><span class="keyword">val</span> encode_log_record_flags :
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record_flags</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_log_record_flags v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><h3 id="protobuf-decoding"><a href="#protobuf-decoding" class="anchor"></a>Protobuf Decoding</h3><div class="odoc-spec"><div class="spec value anchored" id="val-decode_severity_number"><a href="#val-decode_severity_number" class="anchor"></a><code><span><span class="keyword">val</span> decode_severity_number :
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span></span></code></div><div class="spec-doc"><p><code>decode_severity_number decoder</code> decodes a <code>severity_number</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_log_record"><a href="#val-decode_log_record" class="anchor"></a><code><span><span class="keyword">val</span> decode_log_record : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Opentelemetry__.Logs_types.log_record</span></span></code></div><div class="spec-doc"><p><code>decode_log_record decoder</code> decodes a <code>log_record</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_scope_logs"><a href="#val-decode_scope_logs" class="anchor"></a><code><span><span class="keyword">val</span> decode_scope_logs : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Opentelemetry__.Logs_types.scope_logs</span></span></code></div><div class="spec-doc"><p><code>decode_scope_logs decoder</code> decodes a <code>scope_logs</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_resource_logs"><a href="#val-decode_resource_logs" class="anchor"></a><code><span><span class="keyword">val</span> decode_resource_logs :
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__.Logs_types.resource_logs</span></span></code></div><div class="spec-doc"><p><code>decode_resource_logs decoder</code> decodes a <code>resource_logs</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_logs_data"><a href="#val-decode_logs_data" class="anchor"></a><code><span><span class="keyword">val</span> decode_logs_data : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Opentelemetry__.Logs_types.logs_data</span></span></code></div><div class="spec-doc"><p><code>decode_logs_data decoder</code> decodes a <code>logs_data</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_log_record_flags"><a href="#val-decode_log_record_flags" class="anchor"></a><code><span><span class="keyword">val</span> decode_log_record_flags :
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__.Logs_types.log_record_flags</span></span></code></div><div class="spec-doc"><p><code>decode_log_record_flags decoder</code> decodes a <code>log_record_flags</code> value from <code>decoder</code></p></div></div><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value anchored" id="val-pp_severity_number"><a href="#val-pp_severity_number" class="anchor"></a><code><span><span class="keyword">val</span> pp_severity_number :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_severity_number v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_log_record"><a href="#val-pp_log_record" class="anchor"></a><code><span><span class="keyword">val</span> pp_log_record :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_log_record v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_scope_logs"><a href="#val-pp_scope_logs" class="anchor"></a><code><span><span class="keyword">val</span> pp_scope_logs :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.scope_logs</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_scope_logs v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_resource_logs"><a href="#val-pp_resource_logs" class="anchor"></a><code><span><span class="keyword">val</span> pp_resource_logs :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.resource_logs</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_resource_logs v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_logs_data"><a href="#val-pp_logs_data" class="anchor"></a><code><span><span class="keyword">val</span> pp_logs_data :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.logs_data</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_logs_data v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_log_record_flags"><a href="#val-pp_log_record_flags" class="anchor"></a><code><span><span class="keyword">val</span> pp_log_record_flags :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record_flags</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_log_record_flags v</code> formats v</p></div></div></details></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">module</span> <span class="keyword">type</span> <span class="keyword">of</span> <span class="keyword">struct</span> <span class="keyword">include</span> <a href="../../../opentelemetry/Opentelemetry/Logs/index.html">Opentelemetry.Logs</a> <span class="keyword">end</span></span></code></summary><p>Logs.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#log-signal">the spec</a></p><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">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <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> = </span></code><ol><li id="type-flags.Log_record_flag_unspecified" class="def variant constructor anchored"><a href="#type-flags.Log_record_flag_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flag_unspecified</span></span></code></li><li id="type-flags.Log_record_flag_trace_flags_mask" class="def variant constructor anchored"><a href="#type-flags.Log_record_flag_trace_flags_mask" class="anchor"></a><code><span>| </span><span><span class="constructor">Log_record_flag_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">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__.Logs_types.log_record_flags</span> <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>?time:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?observed_time_unix_nano:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">&#45;&gt;</span></span>
<span>?log_level:string <span class="arrow">&#45;&gt;</span></span>
<span>?flags:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?span_id:<a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../opentelemetry/Opentelemetry/index.html#type-value">Opentelemetry.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>?time:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?observed_time_unix_nano:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">&#45;&gt;</span></span>
<span>?log_level:string <span class="arrow">&#45;&gt;</span></span>
<span>?flags:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?span_id:<a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.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>?time:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?observed_time_unix_nano:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?severity:<span class="xref-unresolved">Opentelemetry__.Logs_types.severity_number</span> <span class="arrow">&#45;&gt;</span></span>
<span>?log_level:string <span class="arrow">&#45;&gt;</span></span>
<span>?flags:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?trace_id:<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?span_id:<a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a> <span class="arrow">&#45;&gt;</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">&#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>?service_name:string <span class="arrow">&#45;&gt;</span></span>
<span>?attrs:
<span><span>(string * <span>[&lt; <span>`Bool of bool</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></details></div></div></body></html>