Generate yardocs for opentelemetry-common 0.21.0

open-telemetry · May 8, 2024 · d11c0a2 · d11c0a2
1 parent aad2d59
commit d11c0a2
Show file tree

Hide file tree

Showing 24 changed files with 5,156 additions and 1 deletion.
diff --git a/404.html b/404.html
@@ -37,7 +37,7 @@
     ];
     var versions = {};
     versions.version_opentelemetry_api = "1.2.5";
-    versions.version_opentelemetry_common = "0.20.1";
+    versions.version_opentelemetry_common = "0.21.0";
     versions.version_opentelemetry_exporter_jaeger = "0.23.0";
     versions.version_opentelemetry_exporter_otlp = "0.26.3";
     versions.version_opentelemetry_instrumentation_active_model_serializers = "0.19.0";

diff --git a/opentelemetry-common/v0.21.0/OpenTelemetry.html b/opentelemetry-common/v0.21.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/common/http.rb<span class="defines">,<br />
+  lib/opentelemetry/common/version.rb,<br /> lib/opentelemetry/common/utilities.rb,<br /> lib/opentelemetry/common/propagation.rb,<br /> lib/opentelemetry/common/http/client_context.rb,<br /> lib/opentelemetry/common/propagation/rack_env_getter.rb,<br /> lib/opentelemetry/common/propagation/symbol_key_getter.rb,<br /> lib/opentelemetry/common.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. See the documentation for the <code>opentelemetry-api</code> gem for details.</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/Common.html" title="OpenTelemetry::Common (module)">Common</a></span>
+
+
+
+
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Wed May  8 19:55:29 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>
diff --git a/opentelemetry-common/v0.21.0/OpenTelemetry/Common.html b/opentelemetry-common/v0.21.0/OpenTelemetry/Common.html
@@ -0,0 +1,144 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: OpenTelemetry::Common
+
+    &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::Common";
+  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 (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../OpenTelemetry.html" title="OpenTelemetry (module)">OpenTelemetry</a></span></span>
+     &raquo; 
+    <span class="title">Common</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::Common
+
+
+
+</h1>
+<div class="box_info">
+
+
+
+
+
+
+
+
+
+
+
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/opentelemetry/common.rb<span class="defines">,<br />
+  lib/opentelemetry/common/http.rb,<br /> lib/opentelemetry/common/version.rb,<br /> lib/opentelemetry/common/utilities.rb,<br /> lib/opentelemetry/common/propagation.rb,<br /> lib/opentelemetry/common/http/client_context.rb,<br /> lib/opentelemetry/common/propagation/rack_env_getter.rb,<br /> lib/opentelemetry/common/propagation/symbol_key_getter.rb</span>
+</dd>
+  </dl>
+
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+
+<p>Common contains common helpers for semantic conventions, context propagation, etc.</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="Common/HTTP.html" title="OpenTelemetry::Common::HTTP (module)">HTTP</a></span>, <span class='object_link'><a href="Common/Propagation.html" title="OpenTelemetry::Common::Propagation (module)">Propagation</a></span>, <span class='object_link'><a href="Common/Utilities.html" title="OpenTelemetry::Common::Utilities (module)">Utilities</a></span>
+
+
+
+
+</p>
+
+
+    <h2>
+      Constant Summary
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+
+        <dt id="VERSION-constant" class="">VERSION =
+
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.21.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+
+    </dl>
+
+
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Wed May  8 19:55:29 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>