Skip to content

Commit dc940c5

Browse files
opentelemetrybotopentelemetrybot
committed
Generate yardocs for opentelemetry-logs-api 0.2.0
1 parent 2b50fc2 commit dc940c5

23 files changed

+4612
-0
lines changed

‎opentelemetry-logs-api/v0.2.0/OpenTelemetry.html‎

Lines changed: 327 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,327 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Module: OpenTelemetry
8+
9+
&mdash; OpenTelemetry
10+
11+
</title>
12+
13+
<link rel="stylesheet" href="css/style.css" type="text/css" />
14+
15+
<link rel="stylesheet" href="css/common.css" type="text/css" />
16+
17+
<script type="text/javascript">
18+
pathId = "OpenTelemetry";
19+
relpath = '';
20+
</script>
21+
22+
23+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24+
25+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26+
27+
28+
</head>
29+
<body>
30+
<div class="nav_wrap">
31+
<iframe id="nav" src="class_list.html?1"></iframe>
32+
<div id="resizer"></div>
33+
</div>
34+
35+
<div id="main" tabindex="-1">
36+
<div id="header">
37+
<div id="menu">
38+
39+
<a href="_index.html">Index (O)</a> &raquo;
40+
41+
42+
<span class="title">OpenTelemetry</span>
43+
44+
</div>
45+
46+
<div id="search">
47+
48+
<a class="full_list_link" id="class_list_link"
49+
href="class_list.html">
50+
51+
<svg width="24" height="24">
52+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55+
</svg>
56+
</a>
57+
58+
</div>
59+
<div class="clear"></div>
60+
</div>
61+
62+
<div id="content"><h1>Module: OpenTelemetry
63+
64+
65+
66+
</h1>
67+
<div class="box_info">
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
<dl>
80+
<dt>Defined in:</dt>
81+
<dd>lib/opentelemetry/logs.rb<span class="defines">,<br />
82+
lib/opentelemetry/logs/logger.rb,<br /> lib/opentelemetry/logs/version.rb,<br /> lib/opentelemetry/logs/log_record.rb,<br /> lib/opentelemetry/logs/logger_provider.rb,<br /> lib/opentelemetry/logs/severity_number.rb,<br /> lib/opentelemetry/internal/proxy_logger.rb,<br /> lib/opentelemetry/internal/proxy_logger_provider.rb,<br /> lib/opentelemetry-logs-api.rb</span>
83+
</dd>
84+
</dl>
85+
86+
</div>
87+
88+
<h2>Overview</h2><div class="docstring">
89+
<div class="discussion">
90+
91+
<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>
92+
93+
<p>The OpenTelemetry module in the Logs API gem provides global accessors for logs-related objects.</p>
94+
95+
96+
</div>
97+
</div>
98+
<div class="tags">
99+
100+
101+
</div><h2>Defined Under Namespace</h2>
102+
<p class="children">
103+
104+
105+
<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/Logs.html" title="OpenTelemetry::Logs (module)">Logs</a></span>
106+
107+
108+
109+
110+
</p>
111+
112+
113+
114+
115+
116+
117+
118+
119+
<h2>
120+
Instance Method Summary
121+
<small><a href="#" class="summary_toggle">collapse</a></small>
122+
</h2>
123+
124+
<ul class="summary">
125+
126+
<li class="public ">
127+
<span class="summary_signature">
128+
129+
<a href="#logger_provider-instance_method" title="#logger_provider (instance method)">#<strong>logger_provider</strong> &#x21d2; Object, Logs::LoggerProvider </a>
130+
131+
132+
133+
</span>
134+
135+
136+
137+
138+
139+
140+
141+
142+
143+
<span class="summary_desc"><div class='inline'>
144+
<p>Registered logger provider or a default no-op implementation of the logger provider.</p>
145+
</div></span>
146+
147+
</li>
148+
149+
150+
<li class="public ">
151+
<span class="summary_signature">
152+
153+
<a href="#logger_provider=-instance_method" title="#logger_provider= (instance method)">#<strong>logger_provider=</strong>(provider) &#x21d2; Object </a>
154+
155+
156+
157+
</span>
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
<span class="summary_desc"><div class='inline'>
168+
<p>Register the global logger provider.</p>
169+
</div></span>
170+
171+
</li>
172+
173+
174+
</ul>
175+
176+
177+
178+
179+
<div id="instance_method_details" class="method_details_list">
180+
<h2>Instance Method Details</h2>
181+
182+
183+
<div class="method_details first">
184+
<h3 class="signature first" id="logger_provider-instance_method">
185+
186+
#<strong>logger_provider</strong> &#x21d2; <tt>Object</tt>, <tt><span class='object_link'><a href="OpenTelemetry/Logs/LoggerProvider.html" title="OpenTelemetry::Logs::LoggerProvider (class)">Logs::LoggerProvider</a></span></tt>
187+
188+
189+
190+
191+
192+
</h3><div class="docstring">
193+
<div class="discussion">
194+
195+
<p>Returns registered logger provider or a default no-op implementation of the logger provider.</p>
196+
197+
198+
</div>
199+
</div>
200+
<div class="tags">
201+
202+
<p class="tag_title">Returns:</p>
203+
<ul class="return">
204+
205+
<li>
206+
207+
208+
<span class='type'>(<tt>Object</tt>, <tt><span class='object_link'><a href="OpenTelemetry/Logs/LoggerProvider.html" title="OpenTelemetry::Logs::LoggerProvider (class)">Logs::LoggerProvider</a></span></tt>)</span>
209+
210+
211+
212+
&mdash;
213+
<div class='inline'>
214+
<p>registered logger provider or a default no-op implementation of the logger provider.</p>
215+
</div>
216+
217+
</li>
218+
219+
</ul>
220+
221+
</div><table class="source_code">
222+
<tr>
223+
<td>
224+
<pre class="lines">
225+
226+
227+
38
228+
39
229+
40</pre>
230+
</td>
231+
<td>
232+
<pre class="code"><span class="info file"># File 'lib/opentelemetry-logs-api.rb', line 38</span>
233+
234+
<span class='kw'>def</span> <span class='id identifier rubyid_logger_provider'>logger_provider</span>
235+
<span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='lbrace'>{</span> <span class='ivar'>@logger_provider</span> <span class='rbrace'>}</span>
236+
<span class='kw'>end</span></pre>
237+
</td>
238+
</tr>
239+
</table>
240+
</div>
241+
242+
<div class="method_details ">
243+
<h3 class="signature " id="logger_provider=-instance_method">
244+
245+
#<strong>logger_provider=</strong>(provider) &#x21d2; <tt>Object</tt>
246+
247+
248+
249+
250+
251+
</h3><div class="docstring">
252+
<div class="discussion">
253+
254+
<p>Register the global logger provider.</p>
255+
256+
257+
</div>
258+
</div>
259+
<div class="tags">
260+
<p class="tag_title">Parameters:</p>
261+
<ul class="param">
262+
263+
<li>
264+
265+
<span class='name'>provider</span>
266+
267+
268+
<span class='type'>(<tt>LoggerProvider</tt>)</span>
269+
270+
271+
272+
&mdash;
273+
<div class='inline'>
274+
<p>A logger provider to register as the global instance.</p>
275+
</div>
276+
277+
</li>
278+
279+
</ul>
280+
281+
282+
</div><table class="source_code">
283+
<tr>
284+
<td>
285+
<pre class="lines">
286+
287+
288+
26
289+
27
290+
28
291+
29
292+
30
293+
31
294+
32
295+
33
296+
34</pre>
297+
</td>
298+
<td>
299+
<pre class="code"><span class="info file"># File 'lib/opentelemetry-logs-api.rb', line 26</span>
300+
301+
<span class='kw'>def</span> <span class='id identifier rubyid_logger_provider='>logger_provider=</span><span class='lparen'>(</span><span class='id identifier rubyid_provider'>provider</span><span class='rparen'>)</span>
302+
<span class='ivar'>@mutex</span><span class='period'>.</span><span class='id identifier rubyid_synchronize'>synchronize</span> <span class='kw'>do</span>
303+
<span class='kw'>if</span> <span class='ivar'>@logger_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/ProxyLoggerProvider.html" title="OpenTelemetry::Internal::ProxyLoggerProvider (class)">ProxyLoggerProvider</a></span></span>
304+
<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 logger 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>
305+
<span class='ivar'>@logger_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>
306+
<span class='kw'>end</span>
307+
<span class='ivar'>@logger_provider</span> <span class='op'>=</span> <span class='id identifier rubyid_provider'>provider</span>
308+
<span class='kw'>end</span>
309+
<span class='kw'>end</span></pre>
310+
</td>
311+
</tr>
312+
</table>
313+
</div>
314+
315+
</div>
316+
317+
</div>
318+
319+
<div id="footer">
320+
Generated on Tue Feb 25 21:56:02 2025 by
321+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
322+
0.9.37 (ruby-3.1.6).
323+
</div>
324+
325+
</div>
326+
</body>
327+
</html>

0 commit comments

Comments
 (0)