├── .gitignore ├── .travis.yml ├── LICENSE ├── Makefile ├── README.org ├── rebar ├── rebar.config └── src ├── lager_syslog.app.src └── lager_syslog_backend.erl /.gitignore: -------------------------------------------------------------------------------- 1 | ebin 2 | .eunit 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: erlang 2 | notifications: 3 | webhooks: http://basho-engbot.herokuapp.com/travis?key=92c392ada1e45ef632b5df7cf7104e914a3fa999 4 | email: eng@basho.com 5 | otp_release: 6 | - R15B01 7 | - R15B 8 | - R14B04 9 | - R14B03 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: rel stagedevrel deps test 2 | 3 | all: deps compile 4 | 5 | compile: 6 | ./rebar compile 7 | 8 | deps: 9 | ./rebar get-deps 10 | 11 | clean: 12 | ./rebar clean 13 | 14 | distclean: clean 15 | ./rebar delete-deps 16 | 17 | test: 18 | ./rebar eunit 19 | 20 | ## 21 | ## Doc targets 22 | ## 23 | docs: 24 | ./rebar doc 25 | 26 | APPS = kernel stdlib sasl erts ssl tools os_mon runtime_tools crypto inets \ 27 | xmerl webtool snmp public_key mnesia eunit syntax_tools compiler 28 | COMBO_PLT = $(HOME)/.riak_combo_dialyzer_plt 29 | 30 | check_plt: compile 31 | dialyzer --check_plt --plt $(COMBO_PLT) --apps $(APPS) 32 | 33 | build_plt: compile 34 | dialyzer --build_plt --output_plt $(COMBO_PLT) --apps $(APPS) 35 | 36 | dialyzer: compile 37 | @echo 38 | @echo Use "'make check_plt'" to check PLT prior to using this target. 39 | @echo Use "'make build_plt'" to build PLT prior to using this target. 40 | @echo 41 | @sleep 1 42 | dialyzer -Wno_return --plt $(COMBO_PLT) ebin | \ 43 | fgrep -v -f ./dialyzer.ignore-warnings 44 | 45 | cleanplt: 46 | @echo 47 | @echo "Are you sure? It takes about 1/2 hour to re-build." 48 | @echo Deleting $(COMBO_PLT) in 5 seconds. 49 | @echo 50 | sleep 5 51 | rm $(COMBO_PLT) 52 | 53 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * Overview 2 | [[http://travis-ci.org/basho/lager_syslog][Travis-CI]] :: [[https://secure.travis-ci.org/basho/lager_syslog.png]] 3 | 4 | This is a syslog backend for [[https://github.com/basho/lager][Lager]]. It 5 | allows you to send messages out of lager and into the local syslog daemon. 6 | 7 | * Configuration 8 | Configure a Lager handler like the following: 9 | 10 | #+BEGIN_EXAMPLE 11 | {lager_syslog_backend, [Identity, Facility, Level]} 12 | #+END_EXAMPLE 13 | 14 | The Identity is the string to tag all messages with in syslog, usually the 15 | application's name. The facility is the facility to log to (see the syslog 16 | documentation for a list of these). The Level is the lager level at which the 17 | backend accepts messages (eg. using 'info' would send all messages at info 18 | level or above into syslog). While you can filter messages at the syslog 19 | level, it will improve performance if you filter in lager instead. 20 | 21 | An example for [[http://www.basho.com/products_riak_overview.php][riak]] 22 | would look something like this: 23 | 24 | #+BEGIN_EXAMPLE 25 | {handlers, [ 26 | {lager_syslog_backend, ["riak", local1, info]}, 27 | ] }, 28 | #+END_EXAMPLE 29 | 30 | Then in your syslog config remembering syslog likes tabs and not spaces: 31 | 32 | #+BEGIN_EXAMPLE 33 | local1.info /var/log/riak_info.log 34 | #+END_EXAMPLE 35 | 36 | If you want to log to multiple facilities at once, you can do something like 37 | the following: 38 | 39 | #+BEGIN_EXAMPLE 40 | {{lager_syslog_backend, "daemon facility"}, ["riak1", daemon, info]}, 41 | {{lager_syslog_backend, ftp}, ["riak2", ftp, notice]}, 42 | #+END_EXAMPLE 43 | 44 | You MUST give each instance of the file backend its own identifier. 45 | 46 | Refer to Lager's documentation for futher information on configuring handlers. 47 | 48 | * Troubleshooting 49 | There's not a lot to go wrong, but if you are not receiving messages, check 50 | your syslog config and read its manpage for more information. OS X, in 51 | particular, has a very strange default config where it drops messages below 52 | the 'info' level by default. 53 | 54 | -------------------------------------------------------------------------------- /rebar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/basho/lager_syslog/126dd0284fcac9b01613189a82facf8d803411a2/rebar -------------------------------------------------------------------------------- /rebar.config: -------------------------------------------------------------------------------- 1 | {erl_opts, [debug_info]}. 2 | 3 | {cover_enabled, true}. 4 | 5 | {deps, [ 6 | {lager, "((3|2)\\.|1\\.0|1\\.2).*", {git, "git://github.com/basho/lager", {branch, "master"}}}, 7 | {'syslog', "1.0.*", {git, "git://github.com/Vagabond/erlang-syslog", {branch, "master"}}} 8 | ] 9 | }. 10 | 11 | -------------------------------------------------------------------------------- /src/lager_syslog.app.src: -------------------------------------------------------------------------------- 1 | %% -*- tab-width: 4;erlang-indent-level: 4;indent-tabs-mode: nil -*- 2 | %% ex: ts=4 sw=4 et 3 | {application, lager_syslog, 4 | [ 5 | {description, "Syslog backend for Lager"}, 6 | {vsn, "3.0.1"}, 7 | {modules, []}, 8 | {applications, [ 9 | kernel, 10 | stdlib 11 | ]}, 12 | {registered, []} 13 | ]}. 14 | -------------------------------------------------------------------------------- /src/lager_syslog_backend.erl: -------------------------------------------------------------------------------- 1 | %% Copyright (c) 2011-2012 Basho Technologies, Inc. All Rights Reserved. 2 | %% 3 | %% This file is provided to you under the Apache License, 4 | %% Version 2.0 (the "License"); you may not use this file 5 | %% except in compliance with the License. You may obtain 6 | %% a copy of the License at 7 | %% 8 | %% http://www.apache.org/licenses/LICENSE-2.0 9 | %% 10 | %% Unless required by applicable law or agreed to in writing, 11 | %% software distributed under the License is distributed on an 12 | %% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 13 | %% KIND, either express or implied. See the License for the 14 | %% specific language governing permissions and limitations 15 | %% under the License. 16 | 17 | %% @doc Syslog backend for lager. 18 | 19 | -module(lager_syslog_backend). 20 | 21 | -behaviour(gen_event). 22 | 23 | -export([init/1, handle_call/2, handle_event/2, handle_info/2, terminate/2, 24 | code_change/3]). 25 | 26 | -export([config_to_id/1]). 27 | 28 | -record(state, {level, handle, id, formatter,format_config}). 29 | 30 | -include_lib("lager/include/lager.hrl"). 31 | 32 | -define(DEFAULT_FORMAT,["[", severity, "] ", 33 | {pid, ""}, 34 | {module, [ 35 | {pid, ["@"], ""}, 36 | module, 37 | {function, [":", function], ""}, 38 | {line, [":",line], ""}], ""}, 39 | " ", message]). 40 | 41 | 42 | %% @private 43 | init([Ident, Facility, Level]) -> 44 | init([Ident, Facility, Level, {lager_default_formatter, ?DEFAULT_FORMAT}]); 45 | init([Ident, Facility, Level, {Formatter, FormatterConfig}]) when is_atom(Formatter) -> 46 | case application:start(syslog) of 47 | ok -> 48 | init2([Ident, Facility, Level, {Formatter, FormatterConfig}]); 49 | {error, {already_started, _}} -> 50 | init2([Ident, Facility, Level, {Formatter, FormatterConfig}]); 51 | Error -> 52 | Error 53 | end. 54 | 55 | %% @private 56 | init2([Ident, Facility, Level, {Formatter, FormatterConfig}]) -> 57 | case syslog:open(Ident, [pid], Facility) of 58 | {ok, Log} -> 59 | try parse_level(Level) of 60 | Lvl -> 61 | {ok, #state{level=Lvl, 62 | id=config_to_id([Ident, Facility, Level]), 63 | handle=Log, 64 | formatter=Formatter, 65 | format_config=FormatterConfig}} 66 | catch 67 | _:_ -> 68 | {error, bad_log_level} 69 | end; 70 | Error -> 71 | Error 72 | end. 73 | 74 | 75 | %% @private 76 | handle_call(get_loglevel, #state{level=Level} = State) -> 77 | {ok, Level, State}; 78 | handle_call({set_loglevel, Level}, State) -> 79 | try parse_level(Level) of 80 | Lvl -> 81 | {ok, ok, State#state{level=Lvl}} 82 | catch 83 | _:_ -> 84 | {ok, {error, bad_log_level}, State} 85 | end; 86 | handle_call(_Request, State) -> 87 | {ok, ok, State}. 88 | 89 | %% @private 90 | handle_event({log, Level, {_Date, _Time}, [_LevelStr, Location, Message]}, 91 | #state{level=LogLevel} = State) when Level =< LogLevel -> 92 | syslog:log(State#state.handle, convert_level(Level), [Location, Message]), 93 | {ok, State}; 94 | handle_event({log, Message}, #state{level=Level,formatter=Formatter,format_config=FormatConfig} = State) -> 95 | case lager_util:is_loggable(Message, Level, State#state.id) of 96 | true -> 97 | syslog:log(State#state.handle, convert_level(lager_msg:severity_as_int(Message)), [Formatter:format(Message, FormatConfig)]), 98 | {ok, State}; 99 | false -> 100 | {ok, State} 101 | end; 102 | handle_event(_Event, State) -> 103 | {ok, State}. 104 | 105 | %% @private 106 | handle_info(_Info, State) -> 107 | {ok, State}. 108 | 109 | %% @private 110 | terminate(_Reason, _State) -> 111 | ok. 112 | 113 | %% @private 114 | code_change(_OldVsn, State, _Extra) -> 115 | {ok, State}. 116 | 117 | %% convert the configuration into a hopefully unique gen_event ID 118 | config_to_id([Ident, Facility, _Level]) -> 119 | {?MODULE, {Ident, Facility}}; 120 | config_to_id([Ident, Facility, _Level, _Formatter]) -> 121 | {?MODULE, {Ident, Facility}}. 122 | 123 | convert_level(?DEBUG) -> debug; 124 | convert_level(?INFO) -> info; 125 | convert_level(?NOTICE) -> notice; 126 | convert_level(?WARNING) -> warning; 127 | convert_level(?ERROR) -> err; 128 | convert_level(?CRITICAL) -> crit; 129 | convert_level(?ALERT) -> alert; 130 | convert_level(?EMERGENCY) -> emerg. 131 | 132 | parse_level(Level) -> 133 | try lager_util:config_to_mask(Level) of 134 | Res -> 135 | Res 136 | catch 137 | error:undef -> 138 | %% must be lager < 2.0 139 | lager_util:level_to_num(Level) 140 | end. 141 | 142 | --------------------------------------------------------------------------------