2024-04-23 15:51:15 +00:00
|
|
|
<!DOCTYPE html PUBLIC ""
|
|
|
|
|
"">
|
2024-08-20 17:23:49 +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-beta19</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.slack.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>slack</span></div></a></li><li class="depth-3 branch"><a href="taoensso.telemere.sockets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>sockets</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-get-default-providers"><div class="inner"><span>get-default-providers</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.open-telemetry.html#var-handler.3Aopen-telemetry"><div class="inner"><span>handler:open-telemetry</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-08-19 14:09:46 +00:00
|
|
|
Ref. <<a href="https://github.com/open-telemetry/opentelemetry-java">https://github.com/open-telemetry/opentelemetry-java</a>>,
|
|
|
|
|
<<a href="https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/latest/index.html">https://javadoc.io/doc/io.opentelemetry/opentelemetry-api/latest/index.html</a>></pre></div><div class="public anchor" id="var-get-default-providers"><h3>get-default-providers</h3><h4 class="lang current">clj</h4><div class="usage"><code>(get-default-providers)</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change. Feedback welcome!
|
2024-04-23 15:51:15 +00:00
|
|
|
|
2024-08-19 14:09:46 +00:00
|
|
|
Returns map with keys:
|
|
|
|
|
:logger-provider - default `io.opentelemetry.api.logs.LoggerProvider`
|
|
|
|
|
:tracer-provider - default `io.opentelemetry.api.trace.TracerProvider`
|
|
|
|
|
:via - ∈ #{:sdk-extension-autoconfigure :global}
|
2024-04-29 07:21:13 +00:00
|
|
|
|
2024-08-19 14:09:46 +00:00
|
|
|
Uses `AutoConfiguredOpenTelemetrySdk` when possible, or
|
|
|
|
|
`GlobalOpenTelemetry` otherwise.
|
|
|
|
|
|
2024-08-20 17:23:49 +00:00
|
|
|
See the relevant `opentelemetry-java` docs for details.</pre></div></div><div class="public anchor" id="var-handler.3Aopen-telemetry"><h3>handler:open-telemetry</h3><h4 class="lang current">clj</h4><div class="usage"><code>(handler:open-telemetry)</code><code>(handler:open-telemetry {:keys [logger-provider tracer-provider max-span-msecs], :or {logger-provider :default, tracer-provider :default, max-span-msecs (enc/msecs :mins 120)}})</code></div><div class="doc"><pre class="plaintext">Highly experimental, possibly buggy, and subject to change!!
|
2024-08-19 14:09:46 +00:00
|
|
|
Feedback and bug reports very welcome! Please ping me (Peter) at:
|
|
|
|
|
<<a href="https://www.taoensso.com/telemere">https://www.taoensso.com/telemere</a>> or
|
|
|
|
|
<<a href="https://www.taoensso.com/telemere/slack">https://www.taoensso.com/telemere/slack</a>>
|
2024-04-29 07:21:13 +00:00
|
|
|
|
|
|
|
|
Needs `opentelemetry-java`,
|
|
|
|
|
Ref. <<a href="https://github.com/open-telemetry/opentelemetry-java">https://github.com/open-telemetry/opentelemetry-java</a>>.
|
2024-04-23 15:51:15 +00:00
|
|
|
|
2024-08-07 09:48:04 +00:00
|
|
|
Returns a signal handler that:
|
2024-05-06 14:10:30 +00:00
|
|
|
- Takes a Telemere signal (map).
|
2024-08-19 14:09:46 +00:00
|
|
|
- Emits signal data to configured `io.opentelemetry.api.logs.Logger`
|
|
|
|
|
- Emits tracing data to configured `io.opentelemetry.api.logs.Tracer`
|
2024-04-29 07:21:13 +00:00
|
|
|
|
|
|
|
|
Options:
|
2024-08-19 14:09:46 +00:00
|
|
|
`:logger-provider` - ∈ #{nil :default <io.opentelemetry.api.logs.LoggerProvider>} [1]
|
|
|
|
|
`:tracer-provider` - ∈ #{nil :default <io.opentelemetry.api.trace.TracerProvider>} [1]
|
|
|
|
|
`:max-span-msecs` - (Advanced) Longest tracing span to support in milliseconds
|
|
|
|
|
(default 120 mins). If recorded spans exceed this max, emitted
|
|
|
|
|
data will be inaccurate. Larger values use more memory.
|
|
|
|
|
|
|
|
|
|
[1] See `get-default-providers` for more info</pre></div></div></div></body></html>
|
