Browse files

Add, LICENSE files

  • Loading branch information...
1 parent 3c52872 commit 2a18c9c16a9466352b9d11e29168b45ca344da34 @slfritchie slfritchie committed Nov 10, 2010
Showing with 313 additions and 0 deletions.
  1. +178 −0 LICENSE
  2. +135 −0
@@ -0,0 +1,178 @@
+ Apache License
+ Version 2.0, January 2004
+ 1. Definitions.
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ implied, including, without limitation, any warranties or conditions
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
@@ -0,0 +1,135 @@
+riak_err: Limiting the maximum size of Erlang/OTP error_logger messages
+The `riak_err` OTP application replaces about 90% of the default
+Erlang/OTP info/error/warning event handling mechanism.
+The replacement places strict limits on the maximum size of a
+formatted message.
+Why replace the default error handlers?
+The Erlang/OTP default event handler will format a message using a
+user-supplied formatting string or a default `"~p"` formatting string
+(for report-style messages). Using `~p` and/or `~w` formatting can
+consume enormous amounts of RAM, due to how Erlang strings are
+handled. It isn't uncommon to submit an error message that is only
+5MB, but formatting that message can use anywhere from 80MB to 320MB
+on CPUs with a 64-bit word size.
+A very brief tour of the error_logger
+The OTP `kernel` application starts a system-wide event handler named
+`error_logger` to receive events, format them, and write them to the
+ $ erl -sname asdf -pz ./b/src/riak_err/ebin
+ Erlang R13B04 (erts-5.7.5) [source] [64-bit] [smp:4:4] [rq:4] [async-threads:0] [hipe] [kernel-poll:false]
+ Eshell V5.7.5 (abort with ^G)
+ (asdf@sbb)1> gen_event:which_handlers(error_logger).
+ [error_logger,error_logger_tty_h]
+The OTP `sasl` application adds more handlers, specifically for
+formatting events from processes that use `supervisor`, `gen_server`,
+`gen_event`, and `gen_fsm` behavior (as well as any process that uses
+`proc_lib` helper functions).
+ (asdf@sbb)2> application:start(sasl).
+ ok
+ (asdf@sbb)3> gen_event:which_handlers(error_logger).
+ [sasl_report_tty_h,error_logger,error_logger_tty_h]
+The `sasl` application can be configured to add additional event
+handlers that will write events to disk, either as human-friendly
+ASCII/Latin-1 formatting or machine-friendly binary format. For
+example, this is the list of `error_logger`'s event handlers when the
+Basho's Riak application is started.
+ (riaksearch@> gen_event:which_handlers(error_logger).
+ [log_mf_h,sasl_report_file_h,error_logger,error_logger_tty_h]
+When the `riak_err` application is started, the following event
+handlers are removed from the `error_logger`:
+* `error_logger`
+* `error_logger_tty_h`
+* `sasl_report_tty_h`
+* `sasl_report_file_h`
+... and are replaced by the `riak_err_handler` handler.
+There are two config knobs may be specified on the command line
+via `-riak_err KnobName Integer` on the command line or (in a
+Basho application like Riak) via the same `-riak_err KnobName Integer`
+line in the `etc/vm.args` file). Alternatively, these properties
+may be set using application environment variables by the same name.
+* `term_max_size` For arguments formatted in FormatString and
+ArgList style, if the total size of ArgList is more than `term_max_size`,
+then we'll ignore FormatString and log the message with a well-known
+(and therefore safe) formatting string. The default is 10KBytes.
+* `fmt_max_bytes` When formatting a log-related term that might
+be "big", limit the term's formatted output to a maximum of
+`fmt_max_bytes` bytes. The default is 12KBytes.
+For example, `erl -riak_err term_max_size 8192 fmt_max_bytes 9000`
+If the SASL error logger's `sasl_error_logger` configuration
+parameter is set to the `{file, FileName}` form, then this
+module will attempt to emulate the SASL error logger's
+logging-to-file behavior. However, the interpretation of the
+`errlog_type` configuration parameter is limited: if its
+value is `error`, then only error and warning messages will
+be written to the file. In all other cases (namely both
+`progress` and `all`), all events will be formatted
+and written to the file.
+A short note about log file rotation
+* *NOTE:* The log file's filehandle will be re-opened once
+per second, which will allow log file rotation schemes
+to rotate the log file safely without undue worry about
+losing log file entries or worrying about sending a
+SIGHUP signal to the owner process before rotation.
+Building via rebar
+To build using [`rebar`](, add the
+following line to your project's `rebar.config` file, in the `deps`
+ {riak_err, ".*", {git, "", "HEAD"}}
+As an example, this is a mostly-complete `rebar.config` file from
+Basho's Riak package:
+ {sub_dirs, ["rel"]}.
+ {require_otp_vsn, "R13B04|R14"}.
+ {cover_enabled, true}.
+ {erl_opts, [debug_info, fail_on_warning]}.
+ %% Technically speaking, this dependency list is incomplete, but
+ %% I wanted to show a complete rebar.config file here....
+ {deps, [
+ {riak_err, ".*", {git, "", "HEAD"}},
+ {riak_kv, "0.13.0", {git, "git://", "HEAD"}},
+ {luwak, "1.*", {git, "git://", "HEAD"}}
+ ]}.
+* Code written by Basho Technologies, Inc. is licensed under an Apache
+Public License version 2.0, see the "LICENSE" file in this source code
+* Code written by Ericsson AB and contributors is licensed under the
+Erlang Public License version 1.1, see
+* Code written by Corelatus AB and contributors is licensed under the
+Erlang Public License version 1.1, see

0 comments on commit 2a18c9c

Please sign in to comment.