2024-12-21 10:11:47 +00:00
|
|
|
"Event" signal creator, emphasizing id + (optional level).
|
2024-03-11 08:49:56 +00:00
|
|
|
|
|
|
|
|
Default kind: `:event`
|
|
|
|
|
Default level: `:info`
|
2025-03-03 08:36:40 +00:00
|
|
|
Returns:
|
|
|
|
|
- For `event!` variant: nil, unconditionally.
|
|
|
|
|
- For `event!?` variant: true iff signal was created (allowed by filtering).
|
2024-03-11 08:49:56 +00:00
|
|
|
|
2024-04-15 07:57:40 +00:00
|
|
|
When filtering conditions are met [4], creates a Telemere signal [3] and
|
2024-04-12 12:57:24 +00:00
|
|
|
dispatches it to registered handlers for processing (e.g. writing to
|
|
|
|
|
console/file/queue/db, etc.).
|
2024-03-11 08:49:56 +00:00
|
|
|
|
|
|
|
|
Examples:
|
|
|
|
|
|
|
|
|
|
(event! ::my-id) ; %> {:kind :event, :level :info, :id ::my-id ...}
|
|
|
|
|
(event! ::my-id :warn) ; %> {... :level :warn ...}
|
|
|
|
|
(event! ::my-id
|
|
|
|
|
{:let [x "x"] ; Available to `:data` and `:msg`
|
|
|
|
|
:data {:x x}
|
|
|
|
|
:msg ["My msg:" x]}) ; %> {... :data {x "x"}, :msg_ "My msg: x" ...}
|
|
|
|
|
|
|
|
|
|
Tips:
|
|
|
|
|
|
2024-03-29 11:30:02 +00:00
|
|
|
- Test using `with-signal`: (with-signal (event! ...)).
|
2024-04-15 07:57:40 +00:00
|
|
|
- Supports the same options [2] as other signals [1].
|
2024-03-11 08:49:56 +00:00
|
|
|
|
2024-04-15 07:57:40 +00:00
|
|
|
- `log!` and `event!` are both good default/general-purpose signal creators.
|
|
|
|
|
- `log!` emphasizes messages, while `event!` emphasizes ids.
|
2024-03-11 08:49:56 +00:00
|
|
|
|
|
|
|
|
- Has a different 2-arity arg order to all other signals!
|
|
|
|
|
Mnemonic: the arg that's typically larger is *always* in the rightmost
|
|
|
|
|
position, and for `event!` that's the `level-or-opts` arg.
|
|
|
|
|
|
2024-05-14 11:48:35 +00:00
|
|
|
----------------------------------------------------------------------
|
2024-04-15 07:57:40 +00:00
|
|
|
[1] See `help:signal-creators` - (`signal!`, `log!`, `event!`, ...)
|
|
|
|
|
[2] See `help:signal-options` - {:keys [kind level id data ...]}
|
|
|
|
|
[3] See `help:signal-content` - {:keys [kind level id data ...]}
|
2024-05-14 11:48:35 +00:00
|
|
|
[4] See `help:signal-filters` - (by ns/kind/id/level, sampling, etc.)
|