├── .github └── workflows │ └── erlang.yml ├── .gitignore ├── LICENSE ├── README.md ├── config └── shell.config ├── rebar.config ├── rebar.lock ├── src ├── logger_colorful.app.src └── logger_colorful_formatter.erl └── test └── logger_colorful_formatter_SUITE.erl /.github/workflows/erlang.yml: -------------------------------------------------------------------------------- 1 | name: Erlang CI 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | 11 | build: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | container: 16 | image: erlang:22.0.7 17 | 18 | steps: 19 | - uses: actions/checkout@v2 20 | - name: Compile 21 | run: rebar3 compile 22 | - name: Run tests 23 | run: rebar3 do eunit, ct 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .rebar3 2 | _* 3 | .eunit 4 | *.o 5 | *.beam 6 | *.plt 7 | *.swp 8 | *.swo 9 | .erlang.cookie 10 | ebin 11 | log 12 | erl_crash.dump 13 | .rebar 14 | logs 15 | _build 16 | .idea 17 | *.iml 18 | rebar3.crashdump 19 | *~ 20 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2020, Łukasz Niemier . 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # logger_colorful 2 | 3 | A logger formatter wrapper that ANSI-colours messages. Taste best, when used 4 | together with `logger_std_h`. 5 | 6 | ## Installation 7 | 8 | ```erlang 9 | {deps, [logger_colorful]}. 10 | ``` 11 | 12 | ## Usage 13 | 14 | Configure it either in your `sys.config`: 15 | 16 | ```erlang 17 | [{kernel, [{logger, 18 | [{handler, default, logger_std_h, 19 | [{formatter, {logger_colorful_formatter, #{}}}] 20 | }] 21 | }] 22 | }]. 23 | ``` 24 | 25 | Or from within application: 26 | 27 | ``` 28 | logger:set_handler_config(default, formatter, {logger_colorful_formatter, #{}}). 29 | ``` 30 | 31 | ## License 32 | 33 | See [LICENSE](LICENSE). 34 | -------------------------------------------------------------------------------- /config/shell.config: -------------------------------------------------------------------------------- 1 | [{kernel, [{logger, [{handler, default, logger_std_h, #{formatter => {logger_colorful_formatter, #{single_line => false}}}}]}]}]. 2 | -------------------------------------------------------------------------------- /rebar.config: -------------------------------------------------------------------------------- 1 | {erl_opts, [debug_info]}. 2 | {deps, []}. 3 | 4 | {plugins, [rebar3_lint, 5 | rebar3_hex, 6 | covertool]}. 7 | 8 | {shell, [{config, "config/shell.config"}]}. 9 | -------------------------------------------------------------------------------- /rebar.lock: -------------------------------------------------------------------------------- 1 | []. 2 | -------------------------------------------------------------------------------- /src/logger_colorful.app.src: -------------------------------------------------------------------------------- 1 | {application, logger_colorful, 2 | [{description, "Colorful logger formatter wrapper"}, 3 | {vsn, git}, 4 | {registered, []}, 5 | {applications, 6 | [kernel, 7 | stdlib 8 | ]}, 9 | {env,[]}, 10 | {modules, []}, 11 | 12 | {licenses, ["Apache 2.0"]}, 13 | {links, [{"GitHub", "https://github.com/hauleth/logger_colorful"}]} 14 | ]}. 15 | -------------------------------------------------------------------------------- /src/logger_colorful_formatter.erl: -------------------------------------------------------------------------------- 1 | %% @doc 2 | %% Implementation of coloring handler for the Erlang's logger. 3 | %% 4 | %% == Options == 5 | %% 6 | %% 13 | %% 14 | %% Available colors: 15 | %% 16 | %% 26 | %% 27 | %% Available modifiers: 28 | %% 29 | %% 34 | %% 35 | %% @end 36 | -module(logger_colorful_formatter). 37 | 38 | -define(RESET, "\e[m"). 39 | -define(CLREOL, "\e[K"). 40 | -define(CSI(Code), ["\e[", integer_to_binary(Code), $m]). 41 | 42 | -export([check_config/1, 43 | format/2]). 44 | 45 | %% @hidden 46 | check_config(Config0) -> 47 | Formatter = maps:get(formatter, Config0, logger_formatter), 48 | Colors = maps:get(colors, Config0, #{}), 49 | case check_colors(Colors) of 50 | true -> 51 | Config = maps:without([formatter, colors], Config0), 52 | try_callback_call(Formatter, ?FUNCTION_NAME, [Config], ok); 53 | _ -> 54 | {error, invalid_colors} 55 | end. 56 | 57 | check_colors(Colors) when is_map(Colors) -> 58 | lists:all(fun check_value/1, maps:to_list(Colors)); 59 | check_colors(_Colors) -> false. 60 | 61 | check_value({Level, Color}) -> 62 | lists:member(Level, [emergency, alert, critical, error, warning, notice, info, debug]) 63 | andalso is_color(Color). 64 | 65 | -define(color(C), lists:member(C, [black, red, green, yellow, blue, magenta, cyan, white])). 66 | -define(mod(C), lists:member(C, [fg, bg, bright])). 67 | 68 | is_color(normal) -> true; 69 | is_color({Mod1, Mod2, Color}) -> 70 | ?mod(Mod1) andalso ?mod(Mod2) andalso ?color(Color); 71 | is_color({Mod, Color}) -> 72 | ?mod(Mod) andalso ?color(Color); 73 | is_color(Color) -> 74 | ?color(Color). 75 | 76 | %% @hidden 77 | format(#{level := Level} = Event, Config0) -> 78 | Formatter = maps:get(formatter, Config0, logger_formatter), 79 | Color = color(Level, Config0), 80 | Config = maps:without([formatter, colors], Config0), 81 | Formatted = Formatter:format(Event, Config), 82 | {Leading, Trailing} = string:take(Formatted, "\n", false, trailing), 83 | FullLines = string:replace(Leading, "\n", [$\n, ?CLREOL], all), 84 | [?RESET, Color, FullLines, ?CLREOL, ?RESET, Trailing]. 85 | 86 | color(Level, Config) -> 87 | Color = case Config of 88 | #{colors := #{Level := C}} -> C; 89 | _ -> default(Level) 90 | end, 91 | color_to_escape(Color). 92 | 93 | default(emergency) -> {bg, red}; 94 | default(alert) -> {bg, red}; 95 | default(critical) -> {bg, red}; 96 | default(error) -> red; 97 | default(warning) -> yellow; 98 | default(debug) -> blue; 99 | default(_) -> normal. 100 | 101 | color_to_escape(normal) -> []; 102 | color_to_escape({Mod, Color}) -> ?CSI(mod(Mod) + code(Color)); 103 | color_to_escape({Mod1, Mod2, Color}) -> 104 | ?CSI(mod(Mod1) + mod(Mod2) + code(Color)); 105 | color_to_escape(Color) -> ?CSI(code(Color)). 106 | 107 | mod(fg) -> 0; 108 | mod(bg) -> 10; 109 | mod(bright) -> 60. 110 | 111 | code(black) -> 30; 112 | code(red) -> 31; 113 | code(green) -> 32; 114 | code(yellow) -> 33; 115 | code(blue) -> 34; 116 | code(magenta) -> 35; 117 | code(cyan) -> 36; 118 | code(white) -> 37. 119 | 120 | try_callback_call(Module, Function, Args, DefRet) -> 121 | try apply(Module, Function, Args) 122 | catch 123 | error:undef:S -> 124 | case S of 125 | [{Module, Function, Args, _}|_] -> 126 | DefRet; 127 | _ -> 128 | erlang:raise(error, undef, S) 129 | end 130 | end. 131 | -------------------------------------------------------------------------------- /test/logger_colorful_formatter_SUITE.erl: -------------------------------------------------------------------------------- 1 | -module(logger_colorful_formatter_SUITE). 2 | 3 | -compile(export_all). 4 | 5 | -include_lib("stdlib/include/assert.hrl"). 6 | -include_lib("common_test/include/ct.hrl"). 7 | 8 | all() -> [check_config]. 9 | 10 | check_config(_Config) -> 11 | ok = logger_colorful_formatter:check_config(#{}), 12 | ok = logger_colorful_formatter:check_config(#{colors => #{}}), 13 | ok = logger_colorful_formatter:check_config(#{colors => #{info => blue}}), 14 | ok = logger_colorful_formatter:check_config(#{colors => #{info => {bg, blue}}}), 15 | ok = logger_colorful_formatter:check_config(#{colors => #{info => {fg, bright, blue}}}), 16 | {error, _} = logger_colorful_formatter:check_config(#{colors => #{foo => blue}}), 17 | {error, _} = logger_colorful_formatter:check_config(#{colors => #{info => foo}}). 18 | --------------------------------------------------------------------------------