Skip to content

Commit

Permalink
[nop] Update guidance re: community appender PRs
Browse files Browse the repository at this point in the history
  • Loading branch information
ptaoussanis committed Jun 30, 2023
1 parent 63712c5 commit 1beaf36
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,12 +207,15 @@ See also `car-appender/query-entries`.

### Community appenders

A number of community appenders are included out-the-box [here](https://github.com/ptaoussanis/timbre/tree/master/src/taoensso/timbre/appenders/community). These include appenders for Android, Logstash, Slack, Sentry, NodeJS, Syslog, PostgreSQL, etc.
A number of [community appenders][] are included with Timbre.

Thanks goes to the respective authors!
**Please see the relevant namespace docstring for details**.
Thanks to the relevant authors! Please see **appender namespace docstrings** for details.

GitHub PRs for new appenders and for appender maintenance very welcome!
GitHub PRs very welcome for:

- Maintenance of any existing [community appenders][] (thank you!!).
- Additional **dependency-free** appenders. (See [example template](https://github.com/ptaoussanis/timbre/blob/master/src/taoensso/timbre/appenders/example.clj)).
- Additional links to **externally-hosted** appenders in the table below.

## More community tools, appenders, etc.

Expand All @@ -239,7 +242,7 @@ Otherwise, you can reach me at [Taoensso.com][]. Happy hacking!
## License

Distributed under the [EPL v1.0][] \(same as Clojure).
Copyright © 2015-2022 [Peter Taoussanis][Taoensso.com].
Copyright © 2015-2023 [Peter Taoussanis][Taoensso.com].

<!--- Standard links -->
[Taoensso.com]: https://www.taoensso.com
Expand All @@ -265,3 +268,4 @@ Copyright &copy; 2015-2022 [Peter Taoussanis][Taoensso.com].
[ClojureWerkz]: http://clojurewerkz.org/
[config API]: http://ptaoussanis.github.io/timbre/taoensso.timbre.html#var-*config*
[default config]: http://ptaoussanis.github.io/timbre/taoensso.timbre.html#var-default-config
[community appenders]: https://github.com/ptaoussanis/timbre/tree/master/src/taoensso/timbre/appenders/community
18 changes: 7 additions & 11 deletions src/taoensso/timbre/appenders/example.clj
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,28 @@
"You can copy this namespace if you'd like a starting template for
writing your own Timbre appender.
PRs for new community appenders welcome!
PRs for new *dependency-free* community appenders welcome!
NB See the `timbre/*config*` docstring for up-to-date info
Timbre's appender API."

TODO Please document any dependency GitHub links here, e.g.:
Requires https://github.com/clojure/java.jdbc,
https://github.com/swaldman/c3p0"
{:author "TODO Your Name (@your-github-username)"}
(:require
[taoensso.encore :as enc]
[taoensso.timbre :as timbre]))

;; TODO If you add any special ns imports above, please remember to update
;; Timbre's `project.clj` to include the necessary dependencies under
;; the `:community` profile

;; TODO Please mark any implementation vars as ^:private

(defn example-appender ; Appender constructor
"Docstring to explain any special opts to influence appender construction,
etc. Returns the appender map. May close over relevant state, etc."

[{:as appender-opts :keys []}] ; Always take an opts map, even if unused
[{:as appender-opts :keys []}] ; TODO Always take an opts map, even if unused

(let [shutdown?_ (atom false)] ; See :shutdown-fn below

;; Return a new appender (just a map), see `timbre/example-config`
;; for info on all available keys:
;; Return a new appender (just a map),
;; see `timbre/*config*` docstring for info on all available keys:

{:enabled? true ; Enable new appenders by default
;; :async? true ; Use agent for appender dispatch? Useful for slow dispatch
Expand Down

0 comments on commit 1beaf36

Please sign in to comment.