This is an automated email from the ASF dual-hosted git repository. ningjiang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-java-chassis.git
commit 2b0c964184ef140bfeb0d5b552fc599d2c223c28 Author: yaohaishi <[email protected]> AuthorDate: Mon Dec 18 19:20:36 2017 +0800 [JAV-589] modify some configurations and comments. --- .../rest/vertx/accesslog/AccessLogConfiguration.java | 5 ++--- .../transport/rest/vertx/accesslog/README.md | 19 ++++++++++++------- .../accesslog/element/impl/BytesWrittenV1Element.java | 3 +++ .../accesslog/element/impl/BytesWrittenV2Element.java | 3 +++ .../parser/impl/DefaultAccessLogPatternParser.java | 10 ++++------ .../src/main/resources/config/base/log4j.properties | 2 +- 6 files changed, 25 insertions(+), 17 deletions(-) diff --git a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/AccessLogConfiguration.java b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/AccessLogConfiguration.java index cc71121..ff5dd16 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/AccessLogConfiguration.java +++ b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/AccessLogConfiguration.java @@ -19,7 +19,7 @@ package io.servicecomb.transport.rest.vertx.accesslog; import com.netflix.config.DynamicPropertyFactory; public final class AccessLogConfiguration { - private static final String BASE = "cse.accesslog."; + private static final String BASE = "servicecomb.accesslog."; private static final String ACCESSLOG_ENABLED = BASE + "enabled"; @@ -37,8 +37,7 @@ public final class AccessLogConfiguration { } public String getAccesslogPattern() { - String pattern = getProperty("%h - - %t %r %s %B", ACCESSLOG_PATTERN); - return pattern; + return getProperty("%h - - %t %r %s %B", ACCESSLOG_PATTERN); } private String getProperty(String defaultValue, String key) { diff --git a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/README.md b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/README.md index 840ea59..2b24062 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/README.md +++ b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/README.md @@ -4,7 +4,7 @@ To enable access log printing, you can config access log in microservice.yaml like below: ```yaml -cse: +servicecomb: accesslog: enabled: true pattern: "%h - - %t %r !! %q cs-uri %% %s %B" @@ -14,11 +14,11 @@ cse: | Config Item | Range of Value | Default Value | Meaning | | :---------- | :------------- | :------------ | :------ | -| cse.accesslog.enabled | true/false | false | print access log if true | -| cse.accesslog.pattern | a string field representing log pattern | "%h - - %t %r %s %B" | see details of ***Currently Supported Elements*** below | +| servicecomb.accesslog.enabled | true/false | false | print access log if true | +| servicecomb.accesslog.pattern | a string field representing log pattern | "%h - - %t %r %s %B" | see details of ***Currently Supported Elements*** below | > ***Caution:*** -> - all of the configuration item above can be omitted, in this case, default value will take effect. +> - all of the configuration items above can be omitted, in this case, default value will take effect. ## Supported log elements @@ -49,8 +49,13 @@ cse: ## Access log file settings -Default access log configurations is in `config/base/log4j.properties`. +Access log will be written in a separate log file named `access.log` located in the same directory with common logs. -Access log will be written in a separate log file named `cse.access.log` located in the same directory with common logs. +Default access log printer is based on Log4j, users can override access log file configuration in their `log4j.properties` file. -Users can override access log file configuration as the same way of common logs. \ No newline at end of file +***Common access log file configuration items*** + +| Configuration Item | Default Value | Meaning | +| :----------------- | :------------ | :------ | +| paas.logs.accesslog.dir | ${paas.logs.dir} | access log output directory | +| paas.logs.accesslog.file | access.log | access log file name | \ No newline at end of file diff --git a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV1Element.java b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV1Element.java index bb504ab..0212d0f 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV1Element.java +++ b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV1Element.java @@ -20,6 +20,9 @@ import io.servicecomb.transport.rest.vertx.accesslog.AccessLogParam; import io.servicecomb.transport.rest.vertx.accesslog.element.AccessLogElement; import io.vertx.core.http.HttpServerResponse; +/** + * Zero bytes written as 0 + */ public class BytesWrittenV1Element implements AccessLogElement { public static final String ZERO_BYTES = "0"; diff --git a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV2Element.java b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV2Element.java index 5d6d999..c7b81b0 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV2Element.java +++ b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/element/impl/BytesWrittenV2Element.java @@ -20,6 +20,9 @@ import io.servicecomb.transport.rest.vertx.accesslog.AccessLogParam; import io.servicecomb.transport.rest.vertx.accesslog.element.AccessLogElement; import io.vertx.core.http.HttpServerResponse; +/** + * Zero bytes written as - + */ public class BytesWrittenV2Element implements AccessLogElement { public static final String ZERO_BYTES = "-"; diff --git a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/parser/impl/DefaultAccessLogPatternParser.java b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/parser/impl/DefaultAccessLogPatternParser.java index f2f37e5..642c5af 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/parser/impl/DefaultAccessLogPatternParser.java +++ b/transports/transport-rest/transport-rest-vertx/src/main/java/io/servicecomb/transport/rest/vertx/accesslog/parser/impl/DefaultAccessLogPatternParser.java @@ -18,7 +18,6 @@ package io.servicecomb.transport.rest.vertx.accesslog.parser.impl; import java.util.ArrayList; import java.util.Arrays; -import java.util.Collections; import java.util.Comparator; import java.util.List; @@ -69,9 +68,8 @@ public class DefaultAccessLogPatternParser implements AccessLogPatternParser { new StatusMatcher() ); - public static final Comparator<AccessLogElementExtraction> ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR = (e1, e2) -> { - return e1.getStart() - e2.getStart(); - }; + public static final Comparator<AccessLogElementExtraction> ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR = Comparator + .comparingInt(AccessLogElementExtraction::getStart); @Override public List<AccessLogElementExtraction> parsePattern(String rawPattern) { @@ -83,7 +81,7 @@ public class DefaultAccessLogPatternParser implements AccessLogPatternParser { } } - Collections.sort(extractionList, ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR); + extractionList.sort(ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR); checkExtractionList(extractionList); fillInPlainTextElement(rawPattern, extractionList); @@ -123,6 +121,6 @@ public class DefaultAccessLogPatternParser implements AccessLogPatternParser { } extractionList.addAll(plainTextExtractionList); - Collections.sort(extractionList, ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR); + extractionList.sort(ACCESS_LOG_ELEMENT_EXTRACTION_COMPARATOR); } } diff --git a/transports/transport-rest/transport-rest-vertx/src/main/resources/config/base/log4j.properties b/transports/transport-rest/transport-rest-vertx/src/main/resources/config/base/log4j.properties index efdaf63..b423561 100644 --- a/transports/transport-rest/transport-rest-vertx/src/main/resources/config/base/log4j.properties +++ b/transports/transport-rest/transport-rest-vertx/src/main/resources/config/base/log4j.properties @@ -1,6 +1,6 @@ # access log default configuration paas.logs.accesslog.dir=${paas.logs.dir} -paas.logs.accesslog.file=cse.access.log +paas.logs.accesslog.file=access.log # access log File appender log4j.logger.accesslog=INFO,access log4j.appender.access=io.servicecomb.foundation.common.utils.RollingFileAppenderExt -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
