This commit is contained in:
c-cube 2022-03-18 16:17:18 +00:00
parent 910b3ad138
commit f0f446eb8b
30 changed files with 1369 additions and 0 deletions

2
dev/highlight.pack.js Normal file

File diff suppressed because one or more lines are too long

21
dev/index.html Normal file
View file

@ -0,0 +1,21 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
<body>
<main class="content">
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="opentelemetry/index.html">opentelemetry</a></li>
<li><a href="opentelemetry-client-ocurl/index.html">opentelemetry-client-ocurl</a></li>
<li><a href="opentelemetry-lwt/index.html">opentelemetry-lwt</a></li>
</ol>
</div>
</main>
</body>
</html>

783
dev/odoc.css Normal file
View file

@ -0,0 +1,783 @@
@charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
odoc 2.1.0 */
/* Fonts */
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700');
@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i');
:root,
.light:root {
--main-background: #FFFFFF;
--color: #333333;
--link-color: #2C94BD;
--anchor-hover: #555;
--anchor-color: #d5d5d5;
--xref-shadow: #cc6666;
--header-shadow: #ddd;
--by-name-version-color: #aaa;
--by-name-nav-link-color: #222;
--target-background: rgba(187, 239, 253, 0.3);
--target-shadow: rgba(187, 239, 253, 0.8);
--pre-border-color: #eee;
--code-background: #f6f8fa;
--li-code-background: #f6f8fa;
--li-code-color: #0d2b3e;
--toc-color: #1F2D3D;
--toc-before-color: #777;
--toc-background: #f6f8fa;
--toc-list-border: #ccc;
--spec-summary-border-color: #5c9cf5;
--spec-summary-background: var(--code-background);
--spec-summary-hover-background: #ebeff2;
--spec-details-after-background: rgba(0, 4, 15, 0.05);
--spec-details-after-shadow: rgba(204, 204, 204, 0.53);
}
.dark:root {
--main-background: #202020;
--code-background: #222;
--line-numbers-background: rgba(0, 0, 0, 0.125);
--navbar-background: #202020;
--color: #bebebe;
--dirname-color: #666;
--underline-color: #444;
--visited-color: #002800;
--visited-number-color: #252;
--unvisited-color: #380000;
--unvisited-number-color: #622;
--somevisited-color: #303000;
--highlight-color: #303e3f;
--line-number-color: rgba(230, 230, 230, 0.3);
--unvisited-margin-color: #622;
--border: #333;
--navbar-border: #333;
--code-color: #ccc;
--li-code-background: #373737;
--li-code-color: #999;
--toc-color: #777;
--toc-background: #252525;
--hljs-link: #999;
--hljs-keyword: #cda869;
--hljs-regexp: #f9ee98;
--hljs-title: #dcdcaa;
--hljs-type: #ac885b;
--hljs-meta: #82aaff;
--hljs-variable: #cf6a4c;
}
@media (prefers-color-scheme: dark) {
:root {
--main-background: #202020;
--code-background: #333;
--line-numbers-background: rgba(0, 0, 0, 0.125);
--navbar-background: #202020;
--meter-unvisited-color: #622;
--meter-visited-color: #252;
--meter-separator-color: black;
--color: #bebebe;
--dirname-color: #666;
--underline-color: #444;
--visited-color: #002800;
--visited-number-color: #252;
--unvisited-color: #380000;
--unvisited-number-color: #622;
--somevisited-color: #303000;
--highlight-color: #303e3f;
--line-number-color: rgba(230, 230, 230, 0.3);
--unvisited-margin-color: #622;
--border: #333;
--navbar-border: #333;
--code-color: #ccc;
--by-name-nav-link-color: var(--color);
--li-code-background: #373737;
--li-code-color: #999;
--toc-color: #777;
--toc-before-color: #777;
--toc-background: #252525;
--toc-list-border: #ccc;
--spec-summary-hover-background: #ebeff2;
--spec-details-after-background: rgba(0, 4, 15, 0.05);
--spec-details-after-shadow: rgba(204, 204, 204, 0.53);
--hljs-link: #999;
--hljs-keyword: #cda869;
--hljs-regexp: #f9ee98;
--hljs-title: #dcdcaa;
--hljs-type: #ac885b;
--hljs-meta: #82aaff;
--hljs-variable: #cf6a4c;
}
}
/* Reset a few things. */
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
padding: 0;
border: 0;
font: inherit;
vertical-align: baseline;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
*, *:before, *:after {
box-sizing: border-box;
}
html {
font-size: 15px;
}
body {
text-align: left;
background: #FFFFFF;
color: var(--color);
background-color: var(--main-background);
}
body {
max-width: 100ex;
margin-left: calc(10vw + 20ex);
margin-right: 4ex;
margin-top: 20px;
margin-bottom: 50px;
font-family: "Noticia Text", Georgia, serif;
line-height: 1.5;
}
header {
margin-bottom: 30px;
}
nav {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
}
/* Basic markup elements */
b, strong {
font-weight: bold;
}
i {
font-style: italic;
}
em, i em.odd{
font-style: italic;
}
em.odd, i em {
font-style: normal;
}
sup {
vertical-align: super;
}
sub {
vertical-align: sub;
}
sup, sub {
font-size: 12px;
line-height: 0;
margin-left: 0.2ex;
}
ul, ol {
list-style-position: outside
}
ul>li {
margin-left: 22px;
}
ol>li {
margin-left: 27.2px;
}
li>*:first-child {
margin-top: 0
}
/* Text alignements, this should be forbidden. */
.left {
text-align: left;
}
.right {
text-align: right;
}
.center {
text-align: center;
}
/* Links and anchors */
a {
text-decoration: none;
color: var(--link-color);
}
a:hover {
box-shadow: 0 1px 0 0 var(--link-color);
}
/* Linked highlight */
*:target {
background-color: var(--target-background) !important;
box-shadow: 0 0px 0 1px var(--target-shadow) !important;
border-radius: 1px;
}
*:hover > a.anchor {
visibility: visible;
}
a.anchor:before {
content: "#";
}
a.anchor:hover {
box-shadow: none;
text-decoration: none;
color: var(--anchor-hover);
}
a.anchor {
visibility: hidden;
position: absolute;
/* top: 0px; */
/* margin-left: -3ex; */
margin-left: -1.3em;
font-weight: normal;
font-style: normal;
padding-right: 0.4em;
padding-left: 0.4em;
/* To remain selectable */
color: var(--anchor-color);
}
.spec > a.anchor {
margin-left: -2.3em;
padding-right: 0.9em;
}
.xref-unresolved {
color: #2C94BD;
}
.xref-unresolved:hover {
box-shadow: 0 1px 0 0 var(--xref-shadow);
}
/* Section and document divisions.
Until at least 4.03 many of the modules of the stdlib start at .h7,
we restart the sequence there like h2 */
h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
font-weight: 400;
padding-top: 0.1em;
line-height: 1.2;
overflow-wrap: break-word;
}
h1 {
font-weight: 500;
font-size: 2.441em;
}
h1 {
font-weight: 500;
font-size: 1.953em;
box-shadow: 0 1px 0 0 var(--header-shadow);
}
h2 {
font-size: 1.563em;
}
h3 {
font-size: 1.25em;
}
small, .font_small {
font-size: 0.8em;
}
h1 code, h1 tt {
font-size: inherit;
font-weight: inherit;
}
h2 code, h2 tt {
font-size: inherit;
font-weight: inherit;
}
h3 code, h3 tt {
font-size: inherit;
font-weight: inherit;
}
h3 code, h3 tt {
font-size: inherit;
font-weight: inherit;
}
h4 {
font-size: 1.12em;
}
/* Comment delimiters, hidden but accessible to screen readers and
selected for copy/pasting */
/* Taken from bootstrap */
/* See also https://stackoverflow.com/a/27769435/4220738 */
.comment-delim {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
white-space: nowrap;
border: 0;
}
/* Preformatted and code */
tt, code, pre {
font-family: "Fira Mono", courier;
font-weight: 400;
}
pre {
padding: 0.1em;
border: 1px solid var(--pre-border-color);
border-radius: 5px;
overflow-x: auto;
}
p code,
li code {
background-color: var(--li-code-background);
color: var(--li-code-color);
border-radius: 3px;
padding: 0 0.3ex;
}
p a > code {
color: var(--link-color);
}
code {
white-space: pre-wrap;
}
/* Code blocks (e.g. Examples) */
pre code {
font-size: 0.893rem;
}
/* Code lexemes */
.keyword {
font-weight: 500;
}
.arrow { white-space: nowrap }
/* Module member specification */
.spec {
background-color: var(--spec-summary-background);
border-radius: 3px;
border-left: 4px solid var(--spec-summary-border-color);
border-right: 5px solid transparent;
padding: 0.35em 0.5em;
}
.def-doc {
margin-bottom: 10px;
}
/* Spacing between items */
div.odoc-spec,.odoc-include {
margin-bottom: 2em;
}
.spec.type .variant {
margin-left: 2ch;
}
.spec.type .variant p {
margin: 0;
font-style: italic;
}
.spec.type .record {
margin-left: 2ch;
}
.spec.type .record p {
margin: 0;
font-style: italic;
}
div.def {
margin-top: 0;
text-indent: -2ex;
padding-left: 2ex;
}
div.def+div.def-doc {
margin-left: 1ex;
margin-top: 2.5px
}
div.def-doc>*:first-child {
margin-top: 0;
}
/* Collapsible inlined include and module */
.odoc-include details {
position: relative;
}
.odoc-include.shadowed-include {
display: none;
}
.odoc-include details:after {
z-index: -100;
display: block;
content: " ";
position: absolute;
border-radius: 0 1ex 1ex 0;
right: -20px;
top: 1px;
bottom: 1px;
width: 15px;
background: var(--spec-details-after-background, rgba(0, 4, 15, 0.05));
box-shadow: 0 0px 0 1px var(--spec-details-after-shadow, rgba(204, 204, 204, 0.53));
}
.odoc-include summary {
position: relative;
margin-bottom: 1em;
cursor: pointer;
outline: none;
}
.odoc-include summary:hover {
background-color: var(--spec-summary-hover-background);
}
/* FIXME: Does not work in Firefox. */
.odoc-include summary::-webkit-details-marker {
color: #888;
transform: scaleX(-1);
position: absolute;
top: calc(50% - 5px);
height: 11px;
right: -29px;
}
/* Records and variants FIXME */
div.def table {
text-indent: 0em;
padding: 0;
margin-left: -2ex;
}
td.def {
padding-left: 2ex;
}
td.def-doc *:first-child {
margin-top: 0em;
}
/* Lists of @tags */
.at-tags { list-style-type: none; margin-left: -3ex; }
.at-tags li { padding-left: 3ex; text-indent: -3ex; }
.at-tags .at-tag { text-transform: capitalize }
/* Lists of modules */
.modules { list-style-type: none; margin-left: -3ex; }
.modules li { padding-left: 3ex; text-indent: -3ex; margin-top: 5px }
.modules .synopsis { padding-left: 1ch; }
/* Odig package index */
.packages { list-style-type: none; margin-left: -3ex; }
.packages li { padding-left: 3ex; text-indent: -3ex }
.packages li a.anchor { padding-right: 0.5ch; padding-left: 3ch; }
.packages .version { font-size: 10px; color: var(--by-name-version-color); }
.packages .synopsis { padding-left: 1ch }
.by-name nav a {
text-transform: uppercase;
font-size: 18px;
margin-right: 1ex;
color: var(--by-name-nav-link-color,);
display: inline-block;
}
.by-tag nav a {
margin-right: 1ex;
color: var(--by-name-nav-link-color);
display: inline-block;
}
.by-tag ol { list-style-type: none; }
.by-tag ol.tags li { margin-left: 1ch; display: inline-block }
.by-tag td:first-child { text-transform: uppercase; }
/* Odig package page */
.package nav {
display: inline;
font-size: 14px;
font-weight: normal;
}
.package .version {
font-size: 14px;
}
.package.info {
margin: 0;
}
.package.info td:first-child {
font-style: italic;
padding-right: 2ex;
}
.package.info ul {
list-style-type: none;
display: inline;
margin: 0;
}
.package.info li {
display: inline-block;
margin: 0;
margin-right: 1ex;
}
#info-authors li, #info-maintainers li {
display: block;
}
/* Sidebar and TOC */
.odoc-toc:before {
display: block;
content: "Contents";
text-transform: uppercase;
font-size: 1em;
margin: 1.414em 0 0.5em;
font-weight: 500;
color: var(--toc-before-color);
line-height: 1.2;
}
.odoc-toc {
position: fixed;
top: 0px;
bottom: 0px;
left: 0px;
max-width: 30ex;
min-width: 26ex;
width: 20%;
background: var(--toc-background);
overflow: auto;
color: var(--toc-color);
padding-left: 2ex;
padding-right: 2ex;
}
.odoc-toc ul li a {
font-family: "Fira Sans", sans-serif;
font-size: 0.95em;
color: var(--color);
font-weight: 400;
line-height: 1.6em;
display: block;
}
.odoc-toc ul li a:hover {
box-shadow: none;
text-decoration: underline;
}
/* First level titles */
.odoc-toc>ul>li>a {
font-weight: 500;
}
.odoc-toc li ul {
margin: 0px;
}
.odoc-toc ul {
list-style-type: none;
}
.odoc-toc ul li {
margin: 0;
}
.odoc-toc>ul>li {
margin-bottom: 0.3em;
}
.odoc-toc ul li li {
border-left: 1px solid var(--toc-list-border);
margin-left: 5px;
padding-left: 12px;
}
/* Mobile adjustements. */
@media only screen and (max-width: 95ex) {
.odoc-content {
margin: auto;
padding: 2em;
}
.odoc-toc {
position: static;
width: auto;
min-width: unset;
max-width: unset;
border: none;
padding: 0.2em 1em;
border-radius: 5px;
}
}
/* Print adjustements. */
@media print {
body {
color: black;
background: white;
}
body nav:first-child {
visibility: hidden;
}
}
/* Syntax highlighting (based on github-gist) */
.hljs {
display: block;
background: var(--code-background);
padding: 0.5em;
color: var(--color);
overflow-x: auto;
}
.hljs-comment,
.hljs-meta {
color: #969896;
}
.hljs-string,
.hljs-variable,
.hljs-template-variable,
.hljs-strong,
.hljs-emphasis,
.hljs-quote {
color: #df5000;
}
.hljs-keyword,
.hljs-selector-tag {
color: #a71d5d;
}
.hljs-type,
.hljs-class .hljs-title {
color: #458;
font-weight: 500;
}
.hljs-literal,
.hljs-symbol,
.hljs-bullet,
.hljs-attribute {
color: #0086b3;
}
.hljs-section,
.hljs-name {
color: #63a35c;
}
.hljs-tag {
color: #333333;
}
.hljs-attr,
.hljs-selector-id,
.hljs-selector-class,
.hljs-selector-attr,
.hljs-selector-pseudo {
color: #795da3;
}
.hljs-addition {
color: #55a532;
background-color: #eaffea;
}
.hljs-deletion {
color: #bd2c00;
background-color: #ffecec;
}
.hljs-link {
text-decoration: underline;
}
/*---------------------------------------------------------------------------
Copyright (c) 2016 The odoc contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
---------------------------------------------------------------------------*/

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_client_ocurl (opentelemetry-client-ocurl.Opentelemetry_client_ocurl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry-client-ocurl</a> &#x00BB; Opentelemetry_client_ocurl</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_client_ocurl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-get_url" class="anchored"><a href="#val-get_url" class="anchor"></a><code><span><span class="keyword">val</span> get_url : <span>unit <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-set_url" class="anchored"><a href="#val-set_url" class="anchor"></a><code><span><span class="keyword">val</span> set_url : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Url of the endpoint. Default is &quot;http://localhost:4318&quot;, or &quot;OTEL_EXPORTER_OTLP_ENDPOINT&quot; if set.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-set_mutex" class="anchored"><a href="#val-set_mutex" class="anchor"></a><code><span><span class="keyword">val</span> set_mutex : <span>lock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> <span>unlock:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-setup" class="anchored"><a href="#val-setup" class="anchor"></a><code><span><span class="keyword">val</span> setup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Setup endpoint. This modifies <a href="../../opentelemetry/Opentelemetry/Collector/index.html#type-backend"><code>Opentelemetry.Collector.backend</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_setup" class="anchored"><a href="#val-with_setup" class="anchor"></a><code><span><span class="keyword">val</span> with_setup : <span><span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (opentelemetry-client-ocurl.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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> opentelemetry-client-ocurl</nav><header class="odoc-preamble"><h1 id="opentelemetry-client-ocurl-index"><a href="#opentelemetry-client-ocurl-index" class="anchor"></a>opentelemetry-client-ocurl index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-opentelemetry-client-ocurl">Library opentelemetry-client-ocurl</a></li></ul></nav><div class="odoc-content"><h2 id="library-opentelemetry-client-ocurl"><a href="#library-opentelemetry-client-ocurl" class="anchor"></a>Library opentelemetry-client-ocurl</h2><p>The entry point of this library is the module: <a href="Opentelemetry_client_ocurl/index.html"><code>Opentelemetry_client_ocurl</code></a>.</p></div></body></html>

View file

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry-lwt.Opentelemetry_lwt.Metrics)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry-lwt</a> &#x00BB; <a href="../index.html">Opentelemetry_lwt</a> &#x00BB; Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Metrics</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/Metrics/index.html">Opentelemetry.Metrics</a> <span class="keyword">end</span></span></code></summary><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><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 value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
<span>?start_time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?now:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>float <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as a float</p></div></div><div class="odoc-spec"><div class="spec value" id="val-int" class="anchored"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int :
<span>?start_time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?now:<a href="../../../opentelemetry/Opentelemetry/Timestamp_ns/index.html#type-t">Opentelemetry.Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as an int</p></div></div><div class="odoc-spec"><div class="spec value" id="val-gauge" class="anchored"><a href="#val-gauge" class="anchor"></a><code><span><span class="keyword">val</span> gauge :
<span>name:string <span class="arrow">&#45;&gt;</span></span>
<span>?description:string <span class="arrow">&#45;&gt;</span></span>
<span>?unit_:string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Aggregation of a scalar metric, always with the current value</p></div></div><div class="odoc-spec"><div class="spec type" id="type-aggregation_temporality" class="anchored"><a href="#type-aggregation_temporality" class="anchor"></a><code><span><span class="keyword">type</span> aggregation_temporality</span><span> = </span></code><table><tr id="type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_unspecified</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_delta" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_delta" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_delta</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_cumulative</span></span></code></td></tr></table></div></div><div class="odoc-spec"><div class="spec value" id="val-sum" class="anchored"><a href="#val-sum" class="anchor"></a><code><span><span class="keyword">val</span> sum :
<span>name:string <span class="arrow">&#45;&gt;</span></span>
<span>?description:string <span class="arrow">&#45;&gt;</span></span>
<span>?unit_:string <span class="arrow">&#45;&gt;</span></span>
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">&#45;&gt;</span></span>
<span>?is_monotonic:bool <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-t">t</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit some metrics to the collector.</p></div></div></div></body></html>

View file

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry-lwt.Opentelemetry_lwt.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry-lwt</a> &#x00BB; <a href="../index.html">Opentelemetry_lwt</a> &#x00BB; Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt.Trace</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/Trace/index.html">Opentelemetry.Trace</a> <span class="keyword">end</span></span></code></summary><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-t">Opentelemetry.Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
<span>?trace_state:string <span class="arrow">&#45;&gt;</span></span>
<span>?service_name:string <span class="arrow">&#45;&gt;</span></span>
<span>?attrs:<span><a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-key_value">Opentelemetry.Span.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?kind:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-kind">Opentelemetry.Span.kind</a> <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>?parent:<a href="../../../opentelemetry/Opentelemetry/Span/index.html#type-id">Opentelemetry.Span.id</a> <span class="arrow">&#45;&gt;</span></span>
<span>?links:<span><span>(<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> * <a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a> * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>( <span><span>(<a href="../../../opentelemetry/Opentelemetry/Trace_id/index.html#type-t">Opentelemetry.Trace_id.t</a> * <a href="../../../opentelemetry/Opentelemetry/Span_id/index.html#type-t">Opentelemetry.Span_id.t</a>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Sync span guard</p></div></div></details></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p>Emit asynchronously</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry_lwt (opentelemetry-lwt.Opentelemetry_lwt)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry-lwt</a> &#x00BB; Opentelemetry_lwt</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_lwt</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module" id="module-Span_id" class="anchored"><a href="#module-Span_id" class="anchor"></a><code><span><span class="keyword">module</span> Span_id</span><span> = <a href="../../opentelemetry/Opentelemetry/Span_id/index.html">Opentelemetry.Span_id</a></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace_id" class="anchored"><a href="#module-Trace_id" class="anchor"></a><code><span><span class="keyword">module</span> Trace_id</span><span> = <a href="../../opentelemetry/Opentelemetry/Trace_id/index.html">Opentelemetry.Trace_id</a></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Span" class="anchored"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> Span</span><span> = <a href="../../opentelemetry/Opentelemetry/Span/index.html">Opentelemetry.Span</a></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace" class="anchored"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics" class="anchored"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (opentelemetry-lwt.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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> opentelemetry-lwt</nav><header class="odoc-preamble"><h1 id="opentelemetry-lwt-index"><a href="#opentelemetry-lwt-index" class="anchor"></a>opentelemetry-lwt index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-opentelemetry-lwt">Library opentelemetry-lwt</a></li></ul></nav><div class="odoc-content"><h2 id="library-opentelemetry-lwt"><a href="#library-opentelemetry-lwt" class="anchor"></a>Library opentelemetry-lwt</h2><p>The entry point of this library is the module: <a href="Opentelemetry_lwt/index.html"><code>Opentelemetry_lwt</code></a>.</p></div></body></html>

View file

View file

@ -0,0 +1,10 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Collector (opentelemetry.Opentelemetry.Collector)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Collector</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Collector</span></code></h1><p>Collector types</p><p>These types are used by backend implementations, to send events to collectors such as Jaeger.</p><p>Note: most users will not need to touch this module</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-sender" class="anchored"><a href="#type-sender" class="anchor"></a><code><span><span class="keyword">type</span> <span>'msg sender</span></span><span> = </span><span>{</span></code><table><tr id="type-sender.send" class="anchored"><td class="def record field"><a href="#type-sender.send" class="anchor"></a><code><span>send : 'a. <span><span class="type-var">'msg</span> <span class="arrow">&#45;&gt;</span></span> <span>over:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span> <span>ret:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span>;</span></code></td></tr></table><code><span>}</span></code></div><div class="spec-doc"><p>Sender interface for a message of type <code>msg</code>. Inspired from Logs' reporter (see <a href="https://erratique.ch/software/logs/doc/Logs/index.html#sync">its doc</a>)</p></div></div><div class="odoc-spec"><div class="spec module-type" id="module-type-BACKEND" class="anchored"><a href="#module-type-BACKEND" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-BACKEND/index.html">BACKEND</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector client interface.</p></div></div><div class="odoc-spec"><div class="spec type" id="type-backend" class="anchored"><a href="#type-backend" class="anchor"></a><code><span><span class="keyword">type</span> backend</span><span> = <span>(<span class="keyword">module</span> <a href="module-type-BACKEND/index.html">BACKEND</a>)</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-backend" class="anchored"><a href="#val-backend" class="anchor"></a><code><span><span class="keyword">val</span> backend : <span><span><a href="#type-backend">backend</a> option</span> <span class="xref-unresolved">Stdlib</span>.ref</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace :
<span><span><a href="../Proto/Trace/index.html#type-resource_spans">Proto.Trace.resource_spans</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>over:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span>
<span>ret:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics :
<span><span><a href="../Proto/Metrics/index.html#type-resource_metrics">Proto.Metrics.resource_metrics</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>over:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> unit )</span> <span class="arrow">&#45;&gt;</span></span>
<span>ret:<span>( <span>unit <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>BACKEND (opentelemetry.Opentelemetry.Collector.BACKEND)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Collector</a> &#x00BB; BACKEND</nav><header class="odoc-preamble"><h1>Module type <code><span>Collector.BACKEND</span></code></h1><p>Collector client interface.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value" id="val-send_trace" class="anchored"><a href="#val-send_trace" class="anchor"></a><code><span><span class="keyword">val</span> send_trace : <span><a href="../../Proto/Trace_service/index.html#type-export_trace_service_request">Proto.Trace_service.export_trace_service_request</a> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-send_metrics" class="anchored"><a href="#val-send_metrics" class="anchor"></a><code><span><span class="keyword">val</span> send_metrics : <span><a href="../../Proto/Metrics_service/index.html#type-export_metrics_service_request">Proto.Metrics_service.export_metrics_service_request</a> <a href="../index.html#type-sender">sender</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_16" class="anchored"><a href="#val-rand_bytes_16" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_16 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-rand_bytes_8" class="anchored"><a href="#val-rand_bytes_8" class="anchor"></a><code><span><span class="keyword">val</span> rand_bytes_8 : <span>unit <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div><div class="spec-doc"><p>Generate 16 bytes of random data</p></div></div><div class="odoc-spec"><div class="spec value" id="val-cleanup" class="anchored"><a href="#val-cleanup" class="anchor"></a><code><span><span class="keyword">val</span> cleanup : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>

View file

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics (opentelemetry.Opentelemetry.Metrics)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Metrics</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Metrics</span></code></h1><p>Metrics.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#metric-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><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 value" id="val-float" class="anchored"><a href="#val-float" class="anchor"></a><code><span><span class="keyword">val</span> float :
<span>?start_time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?now:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>float <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as a float</p></div></div><div class="odoc-spec"><div class="spec value" id="val-int" class="anchored"><a href="#val-int" class="anchor"></a><code><span><span class="keyword">val</span> int :
<span>?start_time_unix_nano:int64 <span class="arrow">&#45;&gt;</span></span>
<span>?now:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span></span></code></div><div class="spec-doc"><p>Number data point, as an int</p></div></div><div class="odoc-spec"><div class="spec value" id="val-gauge" class="anchored"><a href="#val-gauge" class="anchor"></a><code><span><span class="keyword">val</span> gauge :
<span>name:string <span class="arrow">&#45;&gt;</span></span>
<span>?description:string <span class="arrow">&#45;&gt;</span></span>
<span>?unit_:string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Aggregation of a scalar metric, always with the current value</p></div></div><div class="odoc-spec"><div class="spec type" id="type-aggregation_temporality" class="anchored"><a href="#type-aggregation_temporality" class="anchor"></a><code><span><span class="keyword">type</span> aggregation_temporality</span><span> = </span></code><table><tr id="type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_unspecified</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_delta" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_delta" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_delta</span></span></code></td></tr><tr id="type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchored"><td class="def variant constructor"><a href="#type-aggregation_temporality.Aggregation_temporality_cumulative" class="anchor"></a><code><span>| </span><span><span class="constructor">Aggregation_temporality_cumulative</span></span></code></td></tr></table></div></div><div class="odoc-spec"><div class="spec value" id="val-sum" class="anchored"><a href="#val-sum" class="anchor"></a><code><span><span class="keyword">val</span> sum :
<span>name:string <span class="arrow">&#45;&gt;</span></span>
<span>?description:string <span class="arrow">&#45;&gt;</span></span>
<span>?unit_:string <span class="arrow">&#45;&gt;</span></span>
<span>?aggregation_temporality:<span class="xref-unresolved">Opentelemetry__Metrics_types.aggregation_temporality</span> <span class="arrow">&#45;&gt;</span></span>
<span>?is_monotonic:bool <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Opentelemetry__Metrics_types.number_data_point</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Sum of all reported measurements over a time interval</p></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <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 some metrics to the collector (sync).</p></div></div></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Metrics_service (opentelemetry.Opentelemetry.Proto.Metrics_service)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Proto</a> &#x00BB; Metrics_service</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Metrics_service</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"><div class="odoc-include"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type" id="type-export_metrics_service_request" class="anchored"><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><table><tr id="type-export_metrics_service_request.resource_metrics" class="anchored"><td class="def record field"><a href="#type-export_metrics_service_request.resource_metrics" class="anchor"></a><code><span>resource_metrics : <span><span class="xref-unresolved">Opentelemetry__Metrics_types.resource_metrics</span> list</span>;</span></code></td></tr></table><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" id="val-default_export_metrics_service_request" class="anchored"><a href="#val-default_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> default_export_metrics_service_request :
<span>?resource_metrics:<span><span class="xref-unresolved">Opentelemetry__Metrics_types.resource_metrics</span> 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><div class="odoc-include"><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value" id="val-pp_export_metrics_service_request" class="anchored"><a href="#val-pp_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_metrics_service_request :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__Metrics_service_types.export_metrics_service_request</span> <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><div class="odoc-include"><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value" id="val-encode_export_metrics_service_request" class="anchored"><a href="#val-encode_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> encode_export_metrics_service_request :
<span><span class="xref-unresolved">Opentelemetry__Metrics_service_types.export_metrics_service_request</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_export_metrics_service_request 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" id="val-decode_export_metrics_service_request" class="anchored"><a href="#val-decode_export_metrics_service_request" class="anchor"></a><code><span><span class="keyword">val</span> decode_export_metrics_service_request :
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Metrics_service_types.export_metrics_service_request</span></span></code></div><div class="spec-doc"><p><code>decode_export_metrics_service_request decoder</code> decodes a <code>export_metrics_service_request</code> value from <code>decoder</code></p></div></div></div></div></body></html>

View file

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Resource (opentelemetry.Opentelemetry.Proto.Resource)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Proto</a> &#x00BB; Resource</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Resource</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"><div class="odoc-include"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type" id="type-resource" class="anchored"><a href="#type-resource" class="anchor"></a><code><span><span class="keyword">type</span> resource</span><span> = </span><span>{</span></code><table><tr id="type-resource.attributes" class="anchored"><td class="def record field"><a href="#type-resource.attributes" class="anchor"></a><code><span>attributes : <span><span class="xref-unresolved">Opentelemetry__Common_types.key_value</span> list</span>;</span></code></td></tr><tr id="type-resource.dropped_attributes_count" class="anchored"><td class="def record field"><a href="#type-resource.dropped_attributes_count" class="anchor"></a><code><span>dropped_attributes_count : int32;</span></code></td></tr></table><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" id="val-default_resource" class="anchored"><a href="#val-default_resource" class="anchor"></a><code><span><span class="keyword">val</span> default_resource :
<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>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>default_resource ()</code> is the default value for type <code>resource</code></p></div></div></div><div class="odoc-include"><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value" id="val-pp_resource" class="anchored"><a href="#val-pp_resource" class="anchor"></a><code><span><span class="keyword">val</span> pp_resource :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__Resource_types.resource</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_resource v</code> formats v</p></div></div></div><div class="odoc-include"><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value" id="val-encode_resource" class="anchored"><a href="#val-encode_resource" class="anchor"></a><code><span><span class="keyword">val</span> encode_resource :
<span><span class="xref-unresolved">Opentelemetry__Resource_types.resource</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 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" id="val-decode_resource" class="anchored"><a href="#val-decode_resource" class="anchor"></a><code><span><span class="keyword">val</span> decode_resource : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Opentelemetry__Resource_types.resource</span></span></code></div><div class="spec-doc"><p><code>decode_resource decoder</code> decodes a <code>resource</code> value from <code>decoder</code></p></div></div></div></div></body></html>

View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Status (opentelemetry.Opentelemetry.Proto.Status)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Proto</a> &#x00BB; Status</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Status</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"><div class="odoc-include"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type" id="type-status" class="anchored"><a href="#type-status" class="anchor"></a><code><span><span class="keyword">type</span> status</span><span> = </span><span>{</span></code><table><tr id="type-status.code" class="anchored"><td class="def record field"><a href="#type-status.code" class="anchor"></a><code><span>code : int32;</span></code></td></tr><tr id="type-status.message" class="anchored"><td class="def record field"><a href="#type-status.message" class="anchor"></a><code><span>message : bytes;</span></code></td></tr><tr id="type-status.details" class="anchored"><td class="def record field"><a href="#type-status.details" class="anchor"></a><code><span>details : <span>bytes list</span>;</span></code></td></tr></table><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" id="val-default_status" class="anchored"><a href="#val-default_status" class="anchor"></a><code><span><span class="keyword">val</span> default_status :
<span>?code:int32 <span class="arrow">&#45;&gt;</span></span>
<span>?message:bytes <span class="arrow">&#45;&gt;</span></span>
<span>?details:<span>bytes list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-status">status</a></span></code></div><div class="spec-doc"><p><code>default_status ()</code> is the default value for type <code>status</code></p></div></div></div><div class="odoc-include"><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value" id="val-pp_status" class="anchored"><a href="#val-pp_status" class="anchor"></a><code><span><span class="keyword">val</span> pp_status :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__Status_types.status</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_status v</code> formats v</p></div></div></div><div class="odoc-include"><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value" id="val-encode_status" class="anchored"><a href="#val-encode_status" class="anchor"></a><code><span><span class="keyword">val</span> encode_status :
<span><span class="xref-unresolved">Opentelemetry__Status_types.status</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_status 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" id="val-decode_status" class="anchored"><a href="#val-decode_status" class="anchor"></a><code><span><span class="keyword">val</span> decode_status : <span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span> <span class="xref-unresolved">Opentelemetry__Status_types.status</span></span></code></div><div class="spec-doc"><p><code>decode_status decoder</code> decodes a <code>status</code> value from <code>decoder</code></p></div></div></div></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,13 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_service (opentelemetry.Opentelemetry.Proto.Trace_service)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../../index.html">Opentelemetry</a> &#x00BB; <a href="../index.html">Proto</a> &#x00BB; Trace_service</nav><header class="odoc-preamble"><h1>Module <code><span>Proto.Trace_service</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="#protobuf-encoding">Protobuf Encoding</a></li><li><a href="#protobuf-decoding">Protobuf Decoding</a></li><li><a href="#formatters">Formatters</a></li></ul></nav><div class="odoc-content"><div class="odoc-include"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type" id="type-export_trace_service_request" class="anchored"><a href="#type-export_trace_service_request" class="anchor"></a><code><span><span class="keyword">type</span> export_trace_service_request</span><span> = </span><span>{</span></code><table><tr id="type-export_trace_service_request.resource_spans" class="anchored"><td class="def record field"><a href="#type-export_trace_service_request.resource_spans" class="anchor"></a><code><span>resource_spans : <span><span class="xref-unresolved">Opentelemetry__Trace_types.resource_spans</span> list</span>;</span></code></td></tr></table><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" id="val-default_export_trace_service_request" class="anchored"><a href="#val-default_export_trace_service_request" class="anchor"></a><code><span><span class="keyword">val</span> default_export_trace_service_request :
<span>?resource_spans:<span><span class="xref-unresolved">Opentelemetry__Trace_types.resource_spans</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>unit <span class="arrow">&#45;&gt;</span></span>
<a href="#type-export_trace_service_request">export_trace_service_request</a></span></code></div><div class="spec-doc"><p><code>default_export_trace_service_request ()</code> is the default value for type <code>export_trace_service_request</code></p></div></div></div><div class="odoc-include"><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value" id="val-encode_export_trace_service_request" class="anchored"><a href="#val-encode_export_trace_service_request" class="anchor"></a><code><span><span class="keyword">val</span> encode_export_trace_service_request :
<span><span class="xref-unresolved">Opentelemetry__Trace_service_types.export_trace_service_request</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_export_trace_service_request 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" id="val-decode_export_trace_service_request" class="anchored"><a href="#val-decode_export_trace_service_request" class="anchor"></a><code><span><span class="keyword">val</span> decode_export_trace_service_request :
<span><span class="xref-unresolved">Pbrt</span>.Decoder.t <span class="arrow">&#45;&gt;</span></span>
<span class="xref-unresolved">Opentelemetry__Trace_service_types.export_trace_service_request</span></span></code></div><div class="spec-doc"><p><code>decode_export_trace_service_request decoder</code> decodes a <code>export_trace_service_request</code> value from <code>decoder</code></p></div></div></div><div class="odoc-include"><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value" id="val-pp_export_trace_service_request" class="anchored"><a href="#val-pp_export_trace_service_request" class="anchor"></a><code><span><span class="keyword">val</span> pp_export_trace_service_request :
<span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Opentelemetry__Trace_service_types.export_trace_service_request</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p><code>pp_export_trace_service_request v</code> formats v</p></div></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Proto (opentelemetry.Opentelemetry.Proto)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Proto</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Proto</span></code></h1><p>Protobuf types</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module" id="module-Common" class="anchored"><a href="#module-Common" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Common/index.html">Common</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Resource" class="anchored"><a href="#module-Resource" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Resource/index.html">Resource</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace" class="anchored"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics" class="anchored"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace_service" class="anchored"><a href="#module-Trace_service" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace_service/index.html">Trace_service</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics_service" class="anchored"><a href="#module-Metrics_service" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics_service/index.html">Metrics_service</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module" id="module-Status" class="anchored"><a href="#module-Status" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Status/index.html">Status</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>

View file

@ -0,0 +1,15 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span (opentelemetry.Opentelemetry.Span)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Span</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span</span></code></h1><p>Spans.</p><p>A Span is the workhorse of traces, it indicates an operation that took place over a given span of time (indicated by start_time and end_time) as part of a hierarchical trace. All spans in a given trace are bound by the use of the same <a href="../Trace_id/index.html#type-t"><code>Trace_id.t</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../Proto/Trace/index.html#type-span">Proto.Trace.span</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-id" class="anchored"><a href="#type-id" class="anchor"></a><code><span><span class="keyword">type</span> id</span><span> = <a href="../Span_id/index.html#type-t">Span_id.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-kind" class="anchored"><a href="#type-kind" class="anchor"></a><code><span><span class="keyword">type</span> <span class="keyword">nonrec</span> kind</span><span> = <a href="../Proto/Trace/index.html#type-span_span_kind">Proto.Trace.span_span_kind</a></span><span> = </span></code><table><tr id="type-kind.Span_kind_unspecified" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_unspecified" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_unspecified</span></span></code></td></tr><tr id="type-kind.Span_kind_internal" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_internal" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_internal</span></span></code></td></tr><tr id="type-kind.Span_kind_server" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_server" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_server</span></span></code></td></tr><tr id="type-kind.Span_kind_client" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_client" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_client</span></span></code></td></tr><tr id="type-kind.Span_kind_producer" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_producer" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_producer</span></span></code></td></tr><tr id="type-kind.Span_kind_consumer" class="anchored"><td class="def variant constructor"><a href="#type-kind.Span_kind_consumer" class="anchor"></a><code><span>| </span><span><span class="constructor">Span_kind_consumer</span></span></code></td></tr></table></div></div><div class="odoc-spec"><div class="spec value" id="val-id" class="anchored"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Span_id/index.html#type-t">Span_id.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type" id="type-key_value" class="anchored"><a href="#type-key_value" class="anchor"></a><code><span><span class="keyword">type</span> key_value</span><span> =
string * <span>[ <span>`Int of int</span> <span><span>| `String</span> of string</span> <span><span>| `Bool</span> of bool</span> <span>| `None</span> ]</span></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create :
<span>?kind:<a href="#type-kind">kind</a> <span class="arrow">&#45;&gt;</span></span>
<span>?id:<a href="#type-id">id</a> <span class="arrow">&#45;&gt;</span></span>
<span>?trace_state:string <span class="arrow">&#45;&gt;</span></span>
<span>?service_name:string <span class="arrow">&#45;&gt;</span></span>
<span>?attrs:<span><a href="#type-key_value">key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?parent:<a href="#type-id">id</a> <span class="arrow">&#45;&gt;</span></span>
<span>?links:<span><span>(<a href="../Trace_id/index.html#type-t">Trace_id.t</a> * <a href="../Span_id/index.html#type-t">Span_id.t</a> * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>start_time:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>end_time:<a href="../Timestamp_ns/index.html#type-t">Timestamp_ns.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<a href="#type-t">t</a> * <a href="#type-id">id</a></span></code></div><div class="spec-doc"><p><code>create ~trace_id name</code> creates a new span with its unique ID.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">trace_id</span> <p>the trace this belongs to</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">parent</span> <p>parent span, if any</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">links</span> <p>list of links to other spans, each with their trace state (see <a href="https://www.w3.org/TR/trace-context/#tracestate-header">w3.org</a>)</p></li></ul></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Span_id (opentelemetry.Opentelemetry.Span_id)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Span_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Span_id</span></code></h1><p>Unique ID of a span.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><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 value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Timestamp_ns (opentelemetry.Opentelemetry.Timestamp_ns)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Timestamp_ns</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Timestamp_ns</span></code></h1><p>Unix timestamp.</p><p>These timestamps measure time since the Unix epoch (jan 1, 1970) UTC in nanoseconds.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = int64</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-ns_in_a_day" class="anchored"><a href="#val-ns_in_a_day" class="anchor"></a><code><span><span class="keyword">val</span> ns_in_a_day : int64</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-now_unix_ns" class="anchored"><a href="#val-now_unix_ns" class="anchor"></a><code><span><span class="keyword">val</span> now_unix_ns : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Current unix timestamp in nanoseconds</p></div></div></div></body></html>

View file

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace (opentelemetry.Opentelemetry.Trace)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Trace</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace</span></code></h1><p>Traces.</p><p>See <a href="https://opentelemetry.io/docs/reference/specification/overview/#tracing-signal">the spec</a></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-span" class="anchored"><a href="#type-span" class="anchor"></a><code><span><span class="keyword">type</span> span</span><span> = <a href="../Span/index.html#type-t">Span.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-emit" class="anchored"><a href="#val-emit" class="anchor"></a><code><span><span class="keyword">val</span> emit : <span><span><a href="#type-span">span</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Sync emitter</p></div></div><div class="odoc-spec"><div class="spec value" id="val-with_" class="anchored"><a href="#val-with_" class="anchor"></a><code><span><span class="keyword">val</span> with_ :
<span>?trace_state:string <span class="arrow">&#45;&gt;</span></span>
<span>?service_name:string <span class="arrow">&#45;&gt;</span></span>
<span>?attrs:<span><a href="../Span/index.html#type-key_value">Span.key_value</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?kind:<a href="../Span/index.html#type-kind">Span.kind</a> <span class="arrow">&#45;&gt;</span></span>
<span>?trace_id:<a href="../Trace_id/index.html#type-t">Trace_id.t</a> <span class="arrow">&#45;&gt;</span></span>
<span>?parent:<a href="../Span/index.html#type-id">Span.id</a> <span class="arrow">&#45;&gt;</span></span>
<span>?links:<span><span>(<a href="../Trace_id/index.html#type-t">Trace_id.t</a> * <a href="../Span_id/index.html#type-t">Span_id.t</a> * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>( <span><span>(<a href="../Trace_id/index.html#type-t">Trace_id.t</a> * <a href="../Span_id/index.html#type-t">Span_id.t</a>)</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span> )</span> <span class="arrow">&#45;&gt;</span></span>
<span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Sync span guard</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Trace_id (opentelemetry.Opentelemetry.Trace_id)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; <a href="../index.html">Opentelemetry</a> &#x00BB; Trace_id</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry.Trace_id</span></code></h1><p>Trace ID.</p><p>This 16 bytes identifier is shared by all spans in one trace.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type" id="type-t" class="anchored"><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 value" id="val-create" class="anchored"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-to_bytes" class="anchored"><a href="#val-to_bytes" class="anchor"></a><code><span><span class="keyword">val</span> to_bytes : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bytes</span></code></div></div><div class="odoc-spec"><div class="spec value" id="val-of_bytes" class="anchored"><a href="#val-of_bytes" class="anchor"></a><code><span><span class="keyword">val</span> of_bytes : <span>bytes <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opentelemetry (opentelemetry.Opentelemetry)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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">opentelemetry</a> &#x00BB; Opentelemetry</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module" id="module-Proto" class="anchored"><a href="#module-Proto" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Proto/index.html">Proto</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Protobuf types</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Timestamp_ns" class="anchored"><a href="#module-Timestamp_ns" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Timestamp_ns/index.html">Timestamp_ns</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unix timestamp.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Collector" class="anchored"><a href="#module-Collector" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Collector/index.html">Collector</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Collector types</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace_id" class="anchored"><a href="#module-Trace_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace_id/index.html">Trace_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Trace ID.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Span_id" class="anchored"><a href="#module-Span_id" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span_id/index.html">Span_id</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Unique ID of a span.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Span" class="anchored"><a href="#module-Span" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Span/index.html">Span</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Spans.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Trace" class="anchored"><a href="#module-Trace" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Trace/index.html">Trace</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Traces.</p></div></div><div class="odoc-spec"><div class="spec module" id="module-Metrics" class="anchored"><a href="#module-Metrics" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Metrics/index.html">Metrics</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Metrics.</p></div></div></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (opentelemetry.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.1.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> opentelemetry</nav><header class="odoc-preamble"><h1 id="opentelemetry-index"><a href="#opentelemetry-index" class="anchor"></a>opentelemetry index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-opentelemetry">Library opentelemetry</a></li></ul></nav><div class="odoc-content"><h2 id="library-opentelemetry"><a href="#library-opentelemetry" class="anchor"></a>Library opentelemetry</h2><p>The entry point of this library is the module: <a href="Opentelemetry/index.html"><code>Opentelemetry</code></a>.</p></div></body></html>