ocaml-opentelemetry/opentelemetry/Opentelemetry_proto/Metrics_service/index.html
2025-03-27 13:35:42 +00:00

46 lines
14 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>Metrics_service (opentelemetry.Opentelemetry_proto.Metrics_service)</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_proto</a> &#x00BB; Metrics_service</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Metrics_service</span></code></h1><p>Code for metrics_service.proto</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#types">Types</a></li><li><a href="#basic-values">Basic values</a></li><li><a href="#make-functions">Make functions</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><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-export_metrics_service_request"><a href="#type-export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_request</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_service_request.resource_metrics" class="def record field anchored"><a href="#type-export_metrics_service_request.resource_metrics" class="anchor"></a><code><span>resource_metrics : <span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_partial_success"><a href="#type-export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_partial_success</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_partial_success.rejected_data_points" class="def record field anchored"><a href="#type-export_metrics_partial_success.rejected_data_points" class="anchor"></a><code><span>rejected_data_points : int64;</span></code></li><li id="type-export_metrics_partial_success.error_message" class="def record field anchored"><a href="#type-export_metrics_partial_success.error_message" class="anchor"></a><code><span>error_message : string;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-export_metrics_service_response"><a href="#type-export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">type</span> export_metrics_service_response</span><span> = </span><span>{</span></code><ol><li id="type-export_metrics_service_response.partial_success" class="def record field anchored"><a href="#type-export_metrics_service_response.partial_success" class="anchor"></a><code><span>partial_success : <span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</span>;</span></code></li></ol><code><span>}</span></code></div></div><h3 id="basic-values"><a href="#basic-values" class="anchor"></a>Basic values</h3><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_service_request"><a href="#val-default_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_request :
<span><span class="optlabel">?resource_metrics</span>:<span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_request ()</code> is the default value for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_partial_success"><a href="#val-default_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_partial_success :
<span><span class="optlabel">?rejected_data_points</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?error_message</span>:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_partial_success ()</code> is the default value for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default_export_metrics_service_response"><a href="#val-default_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_response :
<span><span class="optlabel">?partial_success</span>:<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>default_export_metrics_service_response ()</code> is the default value for type <code>export_metrics_service_response</code></p></div></div><h3 id="make-functions"><a href="#make-functions" class="anchor"></a>Make functions</h3><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_service_request"><a href="#val-make_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_request :
<span><span class="label">resource_metrics</span>:<span><a href="../Metrics/index.html#type-resource_metrics">Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_request … ()</code> is a builder for type <code>export_metrics_service_request</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_partial_success"><a href="#val-make_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_partial_success :
<span><span class="label">rejected_data_points</span>:int64 <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">error_message</span>:string <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_partial_success … ()</code> is a builder for type <code>export_metrics_partial_success</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-make_export_metrics_service_response"><a href="#val-make_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> make_export_metrics_service_response :
<span><span class="optlabel">?partial_success</span>:<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> option</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>make_export_metrics_service_response … ()</code> is a builder for type <code>export_metrics_service_response</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_export_metrics_service_request"><a href="#val-pp_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_service_request :
<span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-export_metrics_service_request">export_metrics_service_request</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_export_metrics_service_request v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_export_metrics_partial_success"><a href="#val-pp_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_partial_success :
<span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_export_metrics_partial_success v</code> formats v</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_export_metrics_service_response"><a href="#val-pp_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_service_response :
<span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="#type-export_metrics_service_response">export_metrics_service_response</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_export_metrics_service_response 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_pb_export_metrics_service_request"><a href="#val-encode_pb_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_export_metrics_service_request :
<span><a href="#type-export_metrics_service_request">export_metrics_service_request</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_pb_export_metrics_service_request 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_pb_export_metrics_partial_success"><a href="#val-encode_pb_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_export_metrics_partial_success :
<span><a href="#type-export_metrics_partial_success">export_metrics_partial_success</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_pb_export_metrics_partial_success 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_pb_export_metrics_service_response"><a href="#val-encode_pb_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_export_metrics_service_response :
<span><a href="#type-export_metrics_service_response">export_metrics_service_response</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>encode_pb_export_metrics_service_response 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_pb_export_metrics_service_request"><a href="#val-decode_pb_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_export_metrics_service_request :
<span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_request">export_metrics_service_request</a></span></code></div><div class="spec-doc"><p><code>decode_pb_export_metrics_service_request decoder</code> decodes a <code>export_metrics_service_request</code> binary value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_pb_export_metrics_partial_success"><a href="#val-decode_pb_export_metrics_partial_success" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_export_metrics_partial_success :
<span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_partial_success">export_metrics_partial_success</a></span></code></div><div class="spec-doc"><p><code>decode_pb_export_metrics_partial_success decoder</code> decodes a <code>export_metrics_partial_success</code> binary value from <code>decoder</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_pb_export_metrics_service_response"><a href="#val-decode_pb_export_metrics_service_response" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_export_metrics_service_response :
<span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_metrics_service_response">export_metrics_service_response</a></span></code></div><div class="spec-doc"><p><code>decode_pb_export_metrics_service_response decoder</code> decodes a <code>export_metrics_service_response</code> binary value from <code>decoder</code></p></div></div></div></body></html>