telemere/taoensso.telemere.open-telemetry.html

23 lines
5.2 KiB
HTML
Raw Normal View History

2024-04-23 15:51:15 +00:00
<!DOCTYPE html PUBLIC ""
"">
2024-04-29 10:21:02 +00:00
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.open-telemetry documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Telemere</span> <span class="project-version">1.0.0-beta5</span></span></a></h1><div id="langs"><div class="lang current">clj</div><div class="lang"><a href="index.cljs.html">cljs</a></div></div></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>taoensso</span></div></div></li><li class="depth-2"><a href="taoensso.telemere.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>telemere</span></div></a></li><li class="depth-3 branch current"><a href="taoensso.telemere.open-telemetry.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>open-telemetry</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.postal.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>postal</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.streams.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>streams</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.timbre.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>timbre</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.tools-logging.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tools-logging</span></div></a></li><li class="depth-3"><a href="taoensso.telemere.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="taoensso.telemere.open-telemetry.html#var-default-logger-provider"><div class="inner"><span>default-logger-provider</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.open-telemetry.html#var-handler.3Aopen-telemetry-logger"><div class="inner"><span>handler:open-telemetry-logger</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.open-telemetry.html#var-IAttr.2B"><div class="inner"><span>IAttr+</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.open-telemetry</h1><div class="doc"><pre class="plaintext">OpenTelemetry handler using `opentelemetry-java`,
2024-04-29 07:21:13 +00:00
Ref. &lt;<a href="https://github.com/open-telemetry/opentelemetry-java">https://github.com/open-telemetry/opentelemetry-java</a>&gt;.</pre></div><div class="public anchor" id="var-default-logger-provider"><h3>default-logger-provider</h3><h4 class="lang current">clj</h4><div class="usage"><code>(default-logger-provider)</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change. Feedback welcome!
2024-04-23 15:51:15 +00:00
Returns `io.opentelemetry.api.logs.LoggerProvider` via:
`AutoConfiguredOpenTelemetrySdk` when possible, or
2024-04-29 07:21:13 +00:00
`GlobalOpenTelemetry` otherwise.
See the relevant `opentelemetry-java` docs for details.</pre></div></div><div class="public anchor" id="var-handler.3Aopen-telemetry-logger"><h3>handler:open-telemetry-logger</h3><h4 class="lang current">clj</h4><div class="usage"><code>(handler:open-telemetry-logger)</code><code>(handler:open-telemetry-logger {:keys [logger-provider attrs-signal-key], :or {logger-provider (default-logger-provider), attrs-signal-key :open-telemetry/attrs}})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change. Feedback welcome!
Needs `opentelemetry-java`,
Ref. &lt;<a href="https://github.com/open-telemetry/opentelemetry-java">https://github.com/open-telemetry/opentelemetry-java</a>&gt;.
2024-04-23 15:51:15 +00:00
Returns a (fn handler [signal]) that:
- Takes a Telemere signal.
- Emits signal content to the `io.opentelemetry.api.logs.Logger`
2024-04-29 07:21:13 +00:00
returned by given `io.opentelemetry.api.logs.LoggerProvider`.
Options:
`:logger-provider` - `io.opentelemetry.api.logs.LoggerProvider`
Defaults to the LoggerProvider returned by (default-logger-provider),
see that docstring for details.</pre></div></div><div class="public anchor" id="var-IAttr.2B"><h3>IAttr+</h3><h4 class="type">protocol</h4><h4 class="lang current">clj</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div></div></body></html>