mirror of
https://github.com/taoensso/telemere.git
synced 2025-12-17 01:51:10 +00:00
35 lines
No EOL
5.4 KiB
HTML
35 lines
No EOL
5.4 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>taoensso.telemere.slack 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-RC2</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"><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 current"><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.slack.html#var-default-dispatch-opts"><div class="inner"><span>default-dispatch-opts</span></div></a></li><li class="depth-1"><a href="taoensso.telemere.slack.html#var-handler.3Aslack"><div class="inner"><span>handler:slack</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">taoensso.telemere.slack</h1><div class="doc"><pre class="plaintext">Slack handler using `clj-slack`,
|
|
Ref. <<a href="https://github.com/julienXX/clj-slack">https://github.com/julienXX/clj-slack</a>></pre></div><div class="public anchor" id="var-default-dispatch-opts"><h3>default-dispatch-opts</h3><h4 class="lang current">clj</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div></div><div class="public anchor" id="var-handler.3Aslack"><h3>handler:slack</h3><h4 class="lang current">clj</h4><div class="usage"><code>(handler:slack {:keys [conn-opts post-opts output-fn], :or {conn-opts {:api-url "https://slack.com/api", :token nil}, post-opts {:channel-id nil, :username nil}, output-fn (utils/format-signal-fn)}})</code></div><div class="doc"><pre class="plaintext">Experimental, subject to change.
|
|
|
|
Needs `clj-slack`, Ref. <<a href="https://github.com/julienXX/clj-slack">https://github.com/julienXX/clj-slack</a>>.
|
|
|
|
Returns a signal handler that:
|
|
- Takes a Telemere signal (map).
|
|
- Writes the signal as a string to specified Slack channel.
|
|
|
|
Can output signals as human or machine-readable (edn, JSON) strings.
|
|
|
|
Default handler dispatch options (override when calling `add-handler!`):
|
|
`:min-level` - `:info`
|
|
`:rate-limit` -
|
|
[[5 (enc/msecs :mins 1)] ; Max 5 posts in 1 min
|
|
[10 (enc/msecs :mins 15)] ; Max 10 posts in 15 mins
|
|
[15 (enc/msecs :hours 1)] ; Max 15 posts in 1 hour
|
|
[30 (enc/msecs :hours 6)] ; Max 30 posts in 6 hours
|
|
]
|
|
|
|
Options:
|
|
`:output-fn` - (fn [signal]) => string, see `format-signal-fn` or `pr-signal-fn`
|
|
`:conn-opts` - Map of connection opts given to `clj-slack.chat/post-message`
|
|
Examples:
|
|
{:token "MY-TOKEN"}
|
|
{:token "MY-TOKEN", :api-url "<a href="https://slack.com/api">https://slack.com/api</a>"}
|
|
|
|
`:post-opts` - Map of post opts given to `clj-slack.chat/post-message`
|
|
Examples:
|
|
{:channel-id "C12345678", :username "MY_BOT"}
|
|
|
|
Tips:
|
|
- See `clj-slack` docs for more info on its options.</pre></div></div></div></body></html> |