From 5478c76f85397274d4eb4063c1e2bf3091c473e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Willi=20Sch=C3=B6nborn?= Date: Fri, 25 Mar 2016 11:16:17 +0100 Subject: [PATCH 1/5] Refined readme --- CONTRIBUTING.md | 13 +++++++++++++ README.md | 15 ++++----------- 2 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..00b242b17 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contributing + +## Pull requests only + +**DON'T** push to the master branch directly. Always use pull requests and let people discuss changes in pull request. +Pull requests should only be merged after all discussions have been concluded and at least 1 reviewer gave his +**approval**. + +## Guidelines + +- **every change** needs a test +- required 100% code coverage +- keep the current code style \ No newline at end of file diff --git a/README.md b/README.md index 3206b73aa..a07b8f933 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ technologies. It satisfies a special need by allowing web application developers ## Installation +Selectively add the following dependencies to your project: + ```xml org.zalando @@ -382,23 +384,14 @@ logbook: level: INFO ``` -## How to test the software - -``` -mvn clean verify -``` - ## Getting help If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker. ## Getting involved -To contribute, simply make a pull request and add a brief description (1-2 sentences) of your addition or change. - -## Open source licensing info - -[Apache 2.0](LICENSE) +To contribute, simply make a pull request and add a brief description (1-2 sentences) of your addition or change. For +more details check the [contribution guidelines](CONTRIBUTING.md). ## Credits and references From ebe3d4018b346a1ca12e6c5e298a677c4f9dda0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Willi=20Sch=C3=B6nborn?= Date: Sat, 26 Mar 2016 23:45:44 +0100 Subject: [PATCH 2/5] Fixed missing parenthesis --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a07b8f933..c16ae2624 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,7 @@ Logbook logbook = Logbook.builder() .predicate(new CustomRequestPredicate()) .headerObfuscator(new CustomHeaderObfuscator()) .parameterObfuscator(new CustomParameterObfuscator()) - .bodyObfuscator(new CustomBodyObfuscator() + .bodyObfuscator(new CustomBodyObfuscator()) .build(); ``` From 1ec70637441fa6c499b33af071d287c54f2a9ea6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Willi=20Sch=C3=B6nborn?= Date: Sat, 26 Mar 2016 23:49:01 +0100 Subject: [PATCH 3/5] Fixed content type in example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c16ae2624..45112b520 100644 --- a/README.md +++ b/README.md @@ -232,7 +232,7 @@ a JSON response body will **not** be escaped and represented as a string: "correlation": "2d66e4bc-9a0d-11e5-a84c-1f39510f0d6b", "status": 200, "headers": { - "Content-Type": ["text/plain"] + "Content-Type": ["application/json"] }, "body": { "greeting": "Hello, world!" From 4d4211d229d5631e581ae55f0b0fb9ed82c95a2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Willi=20Sch=C3=B6nborn?= Date: Sat, 26 Mar 2016 23:51:35 +0100 Subject: [PATCH 4/5] Wording --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 45112b520..5fb764b05 100644 --- a/README.md +++ b/README.md @@ -299,7 +299,7 @@ context.addFilter("LogbookFilter", new LogbookFilter(logbook)) #### Security -Secure application usually a slightly different setup due to the reason that you should generally avoid logging +Secure applications usually have a slightly different setup due to the reason that you should generally avoid logging unauthorized requests, especially the body, as it allows attackers to flood your logfile, and therefore your precious disk space, pretty quickly. Assuming that your application handles authorization inside another filter you have two possible scenarios: @@ -320,8 +320,8 @@ context.addFilter("authorizedLogbookFilter", new LogbookFilter(logbook)) .addMappingForUrlPatterns(EnumSet.of(REQUEST, ASYNC, ERROR), true, "/*"); ``` -The first logbook filter will log unauthorized requests only while the second one will log authorized requests as -always. +The first logbook filter will log unauthorized requests and unauthorized requests only while the second one will log +authorized requests as always. ### HTTP Client From f2877229dc0c2d48c804bd6a71613c92a9569760 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Willi=20Sch=C3=B6nborn?= Date: Sat, 26 Mar 2016 23:55:23 +0100 Subject: [PATCH 5/5] Wording --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fb764b05..440933f9d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,11 @@ [![Maven Central](https://img.shields.io/maven-central/v/org.zalando/logbook-parent.svg)](https://maven-badges.herokuapp.com/maven-central/org.zalando/logbook-parent) *Logbook* is an extensible library to enable complete request and response logging for different client- and server-side -technologies. It satisfies a special need by allowing web application developers to log any HTTP traffic that an application receives or sends in a way that makes it easy to persist and analyze it later. This can be used for traditional log analysis, for audit requirements or for investigating individual historic traffic issues. *Logbook* is meant to be ready to use out of the box for most common setups, but even for uncommon applications and technologies it should be very easy to implement the necessary interfaces to connect some library/framework/etc. to Logbook. +technologies. It satisfies a special need by allowing web application developers to log any HTTP traffic that an application +receives or sends in a way that makes it easy to persist and analyze it later. This can be used for traditional log analysis, +for audit requirements or for investigating individual historic traffic issues. *Logbook* is ready to use out of the box for +most common setups, but even for uncommon applications and technologies it should be very easy to implement the +necessary interfaces to connect some library/framework/etc. to Logbook. ## Features