Generate yardocs for opentelemetry-metrics-api 0.1.0

open-telemetry · Jul 31, 2024 · a44144f · a44144f
1 parent 400b714
commit a44144f
Show file tree

Hide file tree

Showing 31 changed files with 6,470 additions and 0 deletions.
diff --git a/opentelemetry-metrics-api/v0.1.0/OpenTelemetry.html b/opentelemetry-metrics-api/v0.1.0/OpenTelemetry.html
@@ -0,0 +1,327 @@
+<!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/metrics.rb<span class="defines">,<br />
+  lib/opentelemetry/metrics/meter.rb,<br /> lib/opentelemetry/metrics/version.rb,<br /> lib/opentelemetry/metrics/instrument.rb,<br /> lib/opentelemetry/metrics/measurement.rb,<br /> lib/opentelemetry/internal/proxy_meter.rb,<br /> lib/opentelemetry/metrics/meter_provider.rb,<br /> lib/opentelemetry/internal/proxy_instrument.rb,<br /> lib/opentelemetry/metrics/instrument/counter.rb,<br /> lib/opentelemetry/metrics/instrument/histogram.rb,<br /> lib/opentelemetry/internal/proxy_meter_provider.rb,<br /> lib/opentelemetry/metrics/instrument/up_down_counter.rb,<br /> lib/opentelemetry/metrics/instrument/observable_gauge.rb,<br /> lib/opentelemetry/metrics/instrument/observable_counter.rb,<br /> lib/opentelemetry/metrics/instrument/observable_up_down_counter.rb,<br /> lib/opentelemetry-metrics-api.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+
+<p>OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.</p>
+
+<p>The OpenTelemetry module provides global accessors for telemetry objects.</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/Internal.html" title="OpenTelemetry::Internal (module)">Internal</a></span>, <span class='object_link'><a href="OpenTelemetry/Metrics.html" title="OpenTelemetry::Metrics (module)">Metrics</a></span>
+
+
+
+
+</p>
+
+
+
+
+
+
+
+
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#meter_provider-instance_method" title="#meter_provider (instance method)">#<strong>meter_provider</strong>  &#x21d2; Object, Metrics::MeterProvider </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+<p>Registered meter provider or a default no-op implementation of the meter provider.</p>
+</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a href="#meter_provider=-instance_method" title="#meter_provider= (instance method)">#<strong>meter_provider=</strong>(provider)  &#x21d2; Object </a>
+
+
+
+  </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>
+<p>Register the global meter provider.</p>
+</div></span>
+
+</li>
+
+
+    </ul>
+
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+
+      <div class="method_details first">
+  <h3 class="signature first" id="meter_provider-instance_method">
+
+    #<strong>meter_provider</strong>  &#x21d2; <tt>Object</tt>, <tt><span class='object_link'><a href="OpenTelemetry/Metrics/MeterProvider.html" title="OpenTelemetry::Metrics::MeterProvider (class)">Metrics::MeterProvider</a></span></tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+
+<p>Returns registered meter provider or a default no-op implementation of the meter provider.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+
+    <li>
+
+
+        <span class='type'>(<tt>Object</tt>, <tt><span class='object_link'><a href="OpenTelemetry/Metrics/MeterProvider.html" title="OpenTelemetry::Metrics::MeterProvider (class)">Metrics::MeterProvider</a></span></tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>registered meter provider or a default no-op implementation of the meter provider.</p>
+</div>
+
+    </li>
+
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+38
+39
+40</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/opentelemetry-metrics-api.rb', line 38</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_meter_provider'>meter_provider</span>
+  <span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span> <span class='ivar'>@meter_provider</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="meter_provider=-instance_method">
+
+    #<strong>meter_provider=</strong>(provider)  &#x21d2; <tt>Object</tt> 
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+
+<p>Register the global meter provider.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+
+    <li>
+
+        <span class='name'>provider</span>
+
+
+        <span class='type'>(<tt>MeterProvider</tt>)</span>
+
+
+
+        &mdash;
+        <div class='inline'>
+<p>A meter provider to register as the global instance.</p>
+</div>
+
+    </li>
+
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+26
+27
+28
+29
+30
+31
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/opentelemetry-metrics-api.rb', line 26</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_meter_provider='>meter_provider=</span><span class='lparen'>(</span><span class='id identifier rubyid_provider'>provider</span><span class='rparen'>)</span>
+  <span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
+    <span class='kw'>if</span> <span class='ivar'>@meter_provider</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span> <span class='const'><span class='object_link'><a href="OpenTelemetry/Internal.html" title="OpenTelemetry::Internal (module)">Internal</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="OpenTelemetry/Internal/ProxyMeterProvider.html" title="OpenTelemetry::Internal::ProxyMeterProvider (class)">ProxyMeterProvider</a></span></span>
+      <span class='id identifier rubyid_logger'>logger</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Upgrading default proxy meter provider to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_provider'>provider</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+      <span class='ivar'>@meter_provider</span><span class='period'>.</span><span class='id identifier rubyid_delegate'>delegate</span> <span class='op'>=</span> <span class='id identifier rubyid_provider'>provider</span>
+    <span class='kw'>end</span>
+    <span class='ivar'>@meter_provider</span> <span class='op'>=</span> <span class='id identifier rubyid_provider'>provider</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Wed Jul 31 22:30:13 2024 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.36 (ruby-3.0.7).
+</div>
+
+    </div>
+  </body>
+</html>