mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-10 12:45:45 -04:00
48 lines
No EOL
18 KiB
HTML
48 lines
No EOL
18 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Common (opentelemetry.Opentelemetry.Proto.Common)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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> » <a href="../index.html">Proto</a> » Common</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Common</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#types">Types</a></li><li><a href="#default-values">Default values</a></li><li><a href="#formatters">Formatters</a></li><li><a href="#protobuf-encoding">Protobuf Encoding</a></li><li><a href="#protobuf-decoding">Protobuf Decoding</a></li></ul></nav><div class="odoc-content"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type anchored" id="type-any_value"><a href="#type-any_value" class="anchor"></a><code><span><span class="keyword">type</span> any_value</span><span> = </span></code><ol><li id="type-any_value.String_value" class="def variant constructor anchored"><a href="#type-any_value.String_value" class="anchor"></a><code><span>| </span><span><span class="constructor">String_value</span> <span class="keyword">of</span> string</span></code></li><li id="type-any_value.Bool_value" class="def variant constructor anchored"><a href="#type-any_value.Bool_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Bool_value</span> <span class="keyword">of</span> bool</span></code></li><li id="type-any_value.Int_value" class="def variant constructor anchored"><a href="#type-any_value.Int_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Int_value</span> <span class="keyword">of</span> int64</span></code></li><li id="type-any_value.Double_value" class="def variant constructor anchored"><a href="#type-any_value.Double_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Double_value</span> <span class="keyword">of</span> float</span></code></li><li id="type-any_value.Array_value" class="def variant constructor anchored"><a href="#type-any_value.Array_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Array_value</span> <span class="keyword">of</span> <a href="#type-array_value">array_value</a></span></code></li><li id="type-any_value.Kvlist_value" class="def variant constructor anchored"><a href="#type-any_value.Kvlist_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Kvlist_value</span> <span class="keyword">of</span> <a href="#type-key_value_list">key_value_list</a></span></code></li><li id="type-any_value.Bytes_value" class="def variant constructor anchored"><a href="#type-any_value.Bytes_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Bytes_value</span> <span class="keyword">of</span> bytes</span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-array_value"><a href="#type-array_value" class="anchor"></a><code><span><span class="keyword">and</span> array_value</span><span> = </span><span>{</span></code><ol><li id="type-array_value.values" class="def record field anchored"><a href="#type-array_value.values" class="anchor"></a><code><span>values : <span><a href="#type-any_value">any_value</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-key_value_list"><a href="#type-key_value_list" class="anchor"></a><code><span><span class="keyword">and</span> key_value_list</span><span> = </span><span>{</span></code><ol><li id="type-key_value_list.values" class="def record field anchored"><a href="#type-key_value_list.values" class="anchor"></a><code><span>values : <span><a href="#type-key_value">key_value</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-key_value"><a href="#type-key_value" class="anchor"></a><code><span><span class="keyword">and</span> key_value</span><span> = </span><span>{</span></code><ol><li id="type-key_value.key" class="def record field anchored"><a href="#type-key_value.key" class="anchor"></a><code><span>key : string;</span></code></li><li id="type-key_value.value" class="def record field anchored"><a href="#type-key_value.value" class="anchor"></a><code><span>value : <span><a href="#type-any_value">any_value</a> option</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-instrumentation_scope"><a href="#type-instrumentation_scope" class="anchor"></a><code><span><span class="keyword">type</span> instrumentation_scope</span><span> = </span><span>{</span></code><ol><li id="type-instrumentation_scope.name" class="def record field anchored"><a href="#type-instrumentation_scope.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-instrumentation_scope.version" class="def record field anchored"><a href="#type-instrumentation_scope.version" class="anchor"></a><code><span>version : string;</span></code></li><li id="type-instrumentation_scope.attributes" class="def record field anchored"><a href="#type-instrumentation_scope.attributes" class="anchor"></a><code><span>attributes : <span><a href="#type-key_value">key_value</a> list</span>;</span></code></li><li id="type-instrumentation_scope.dropped_attributes_count" class="def record field anchored"><a href="#type-instrumentation_scope.dropped_attributes_count" class="anchor"></a><code><span>dropped_attributes_count : int32;</span></code></li></ol><code><span>}</span></code></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_any_value"><a href="#val-default_any_value" class="anchor"></a><code><span><span class="keyword">val</span> default_any_value : <span>unit <span class="arrow">-></span></span> <a href="#type-any_value">any_value</a></span></code></div><div class="spec-doc"><p><code>default_any_value ()</code> is the default value for type <code>any_value</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_array_value"><a href="#val-default_array_value" class="anchor"></a><code><span><span class="keyword">val</span> default_array_value : <span>?values:<span><a href="#type-any_value">any_value</a> list</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-array_value">array_value</a></span></code></div><div class="spec-doc"><p><code>default_array_value ()</code> is the default value for type <code>array_value</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_key_value_list"><a href="#val-default_key_value_list" class="anchor"></a><code><span><span class="keyword">val</span> default_key_value_list : <span>?values:<span><a href="#type-key_value">key_value</a> list</span> <span class="arrow">-></span></span> <span>unit <span class="arrow">-></span></span> <a href="#type-key_value_list">key_value_list</a></span></code></div><div class="spec-doc"><p><code>default_key_value_list ()</code> is the default value for type <code>key_value_list</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_key_value"><a href="#val-default_key_value" class="anchor"></a><code><span><span class="keyword">val</span> default_key_value :
|
||
<span>?key:string <span class="arrow">-></span></span>
|
||
<span>?value:<span><a href="#type-any_value">any_value</a> option</span> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-key_value">key_value</a></span></code></div><div class="spec-doc"><p><code>default_key_value ()</code> is the default value for type <code>key_value</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_instrumentation_scope"><a href="#val-default_instrumentation_scope" class="anchor"></a><code><span><span class="keyword">val</span> default_instrumentation_scope :
|
||
<span>?name:string <span class="arrow">-></span></span>
|
||
<span>?version:string <span class="arrow">-></span></span>
|
||
<span>?attributes:<span><a href="#type-key_value">key_value</a> list</span> <span class="arrow">-></span></span>
|
||
<span>?dropped_attributes_count:int32 <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-instrumentation_scope">instrumentation_scope</a></span></code></div><div class="spec-doc"><p><code>default_instrumentation_scope ()</code> is the default value for type <code>instrumentation_scope</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_any_value"><a href="#val-pp_any_value" class="anchor"></a><code><span><span class="keyword">val</span> pp_any_value :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.any_value</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_any_value v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_array_value"><a href="#val-pp_array_value" class="anchor"></a><code><span><span class="keyword">val</span> pp_array_value :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.array_value</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_array_value v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_key_value_list"><a href="#val-pp_key_value_list" class="anchor"></a><code><span><span class="keyword">val</span> pp_key_value_list :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value_list</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_key_value_list v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_key_value"><a href="#val-pp_key_value" class="anchor"></a><code><span><span class="keyword">val</span> pp_key_value :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_key_value v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_instrumentation_scope"><a href="#val-pp_instrumentation_scope" class="anchor"></a><code><span><span class="keyword">val</span> pp_instrumentation_scope :
|
||
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.instrumentation_scope</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>pp_instrumentation_scope v</code> formats v</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_any_value"><a href="#val-encode_any_value" class="anchor"></a><code><span><span class="keyword">val</span> encode_any_value :
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.any_value</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_any_value 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_array_value"><a href="#val-encode_array_value" class="anchor"></a><code><span><span class="keyword">val</span> encode_array_value :
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.array_value</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_array_value 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_key_value_list"><a href="#val-encode_key_value_list" class="anchor"></a><code><span><span class="keyword">val</span> encode_key_value_list :
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value_list</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_key_value_list 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_key_value"><a href="#val-encode_key_value" class="anchor"></a><code><span><span class="keyword">val</span> encode_key_value :
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.key_value</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_key_value 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_instrumentation_scope"><a href="#val-encode_instrumentation_scope" class="anchor"></a><code><span><span class="keyword">val</span> encode_instrumentation_scope :
|
||
<span><span class="xref-unresolved">Opentelemetry__.Common_types.instrumentation_scope</span> <span class="arrow">-></span></span>
|
||
<span><span class="xref-unresolved">Pbrt</span>.Encoder.t <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p><code>encode_instrumentation_scope 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_any_value"><a href="#val-decode_any_value" class="anchor"></a><code><span><span class="keyword">val</span> decode_any_value : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span> <span class="xref-unresolved">Opentelemetry__.Common_types.any_value</span></span></code></div><div class="spec-doc"><p><code>decode_any_value decoder</code> decodes a <code>any_value</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_array_value"><a href="#val-decode_array_value" class="anchor"></a><code><span><span class="keyword">val</span> decode_array_value :
|
||
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span>
|
||
<span class="xref-unresolved">Opentelemetry__.Common_types.array_value</span></span></code></div><div class="spec-doc"><p><code>decode_array_value decoder</code> decodes a <code>array_value</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_key_value_list"><a href="#val-decode_key_value_list" class="anchor"></a><code><span><span class="keyword">val</span> decode_key_value_list :
|
||
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span>
|
||
<span class="xref-unresolved">Opentelemetry__.Common_types.key_value_list</span></span></code></div><div class="spec-doc"><p><code>decode_key_value_list decoder</code> decodes a <code>key_value_list</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_key_value"><a href="#val-decode_key_value" class="anchor"></a><code><span><span class="keyword">val</span> decode_key_value : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span> <span class="xref-unresolved">Opentelemetry__.Common_types.key_value</span></span></code></div><div class="spec-doc"><p><code>decode_key_value decoder</code> decodes a <code>key_value</code> value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_instrumentation_scope"><a href="#val-decode_instrumentation_scope" class="anchor"></a><code><span><span class="keyword">val</span> decode_instrumentation_scope :
|
||
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">-></span></span>
|
||
<span class="xref-unresolved">Opentelemetry__.Common_types.instrumentation_scope</span></span></code></div><div class="spec-doc"><p><code>decode_instrumentation_scope decoder</code> decodes a <code>instrumentation_scope</code> value from <code>decoder</code></p></div></div></div></body></html> |