Generate yardocs for opentelemetry-metrics-sdk 0.5.0

open-telemetry · Jan 9, 2025 · 64c51ad · 64c51ad
1 parent 222d8db
commit 64c51ad
Show file tree

Hide file tree

Showing 49 changed files with 18,221 additions and 0 deletions.
diff --git a/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry.html b/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry.html
@@ -0,0 +1,130 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: OpenTelemetry
+
+    &mdash; OpenTelemetry
+
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "OpenTelemetry";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="_index.html">Index (O)</a> &raquo;
+
+
+    <span class="title">OpenTelemetry</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: OpenTelemetry
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/opentelemetry/sdk/metrics.rb<span class="defines">,<br />
+  lib/opentelemetry/sdk/metrics/view.rb,<br /> lib/opentelemetry/sdk/metrics/meter.rb,<br /> lib/opentelemetry/sdk/metrics/state.rb,<br /> lib/opentelemetry/sdk/metrics/export.rb,<br /> lib/opentelemetry/sdk/metrics/version.rb,<br /> lib/opentelemetry/sdk/metrics/instrument.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation.rb,<br /> lib/opentelemetry/sdk/metrics/meter_provider.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/sum.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/drop.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/gauge.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_data.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/counter.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_store.rb,<br /> lib/opentelemetry/sdk/metrics/configuration_patch.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_stream.rb,<br /> lib/opentelemetry/sdk/metrics/export/metric_reader.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/histogram.rb,<br /> lib/opentelemetry/sdk/metrics/view/registered_view.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/last_value.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/up_down_counter.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_gauge.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/number_data_point.rb,<br /> lib/opentelemetry/sdk/metrics/export/periodic_metric_reader.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_counter.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/histogram_data_point.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/synchronous_instrument.rb,<br /> lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/explicit_bucket_histogram.rb,<br /> lib/opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_up_down_counter.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+
+<p>Copyright The OpenTelemetry Authors</p>
+
+<p>SPDX-License-Identifier: Apache-2.0</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="OpenTelemetry/SDK.html" title="OpenTelemetry::SDK (module)">SDK</a></span>
+
+
+
+
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jan  9 00:29:05 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.0.7).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry/SDK.html b/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry/SDK.html
@@ -0,0 +1,117 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: OpenTelemetry::SDK
+
+    &mdash; OpenTelemetry
+
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "OpenTelemetry::SDK";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../OpenTelemetry.html" title="OpenTelemetry (module)">OpenTelemetry</a></span></span>
+     &raquo; 
+    <span class="title">SDK</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: OpenTelemetry::SDK
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/opentelemetry/sdk/metrics.rb<span class="defines">,<br />
+  lib/opentelemetry/sdk/metrics/view.rb,<br /> lib/opentelemetry/sdk/metrics/meter.rb,<br /> lib/opentelemetry/sdk/metrics/state.rb,<br /> lib/opentelemetry/sdk/metrics/export.rb,<br /> lib/opentelemetry/sdk/metrics/version.rb,<br /> lib/opentelemetry/sdk/metrics/instrument.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation.rb,<br /> lib/opentelemetry/sdk/metrics/meter_provider.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/sum.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/drop.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/gauge.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_data.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/counter.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_store.rb,<br /> lib/opentelemetry/sdk/metrics/configuration_patch.rb,<br /> lib/opentelemetry/sdk/metrics/state/metric_stream.rb,<br /> lib/opentelemetry/sdk/metrics/export/metric_reader.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/histogram.rb,<br /> lib/opentelemetry/sdk/metrics/view/registered_view.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/last_value.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/up_down_counter.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_gauge.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/number_data_point.rb,<br /> lib/opentelemetry/sdk/metrics/export/periodic_metric_reader.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_counter.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/histogram_data_point.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/synchronous_instrument.rb,<br /> lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb,<br /> lib/opentelemetry/sdk/metrics/aggregation/explicit_bucket_histogram.rb,<br /> lib/opentelemetry/sdk/metrics/export/in_memory_metric_pull_exporter.rb,<br /> lib/opentelemetry/sdk/metrics/instrument/observable_up_down_counter.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="SDK/Instrument.html" title="OpenTelemetry::SDK::Instrument (module)">Instrument</a></span>, <span class='object_link'><a href="SDK/Metrics.html" title="OpenTelemetry::SDK::Metrics (module)">Metrics</a></span>
+
+
+
+
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jan  9 00:29:05 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.0.7).
+</div>
+
+    </div>
+  </body>
+</html>
diff --git a/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry/SDK/Instrument.html b/opentelemetry-metrics-sdk/v0.5.0/OpenTelemetry/SDK/Instrument.html
@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: OpenTelemetry::SDK::Instrument
+
+    &mdash; OpenTelemetry
+
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "OpenTelemetry::SDK::Instrument";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+
+    <a href="../../_index.html">Index (I)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../OpenTelemetry.html" title="OpenTelemetry (module)">OpenTelemetry</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../SDK.html" title="OpenTelemetry::SDK (module)">SDK</a></span></span>
+     &raquo; 
+    <span class="title">Instrument</span>
+
+</div>
+
+        <div id="search">
+
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: OpenTelemetry::SDK::Instrument
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/opentelemetry/sdk/metrics/instrument.rb</dd>
+  </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+
+<p>The Instrument module contains the OpenTelemetry instruments reference implementation.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Thu Jan  9 00:29:06 2025 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.37 (ruby-3.0.7).
+</div>
+
+    </div>
+  </body>
+</html>