Make log timestamps ISO8601 and RFC3339 compliant
ISO8601 compliant timestamps were added with:
31037d3 - "Use ISO 8601 timestamp format for error/httpd/sshd logs"
Some logging frameworks (like ES beats) does not support ISO8601 but
does support RFC3339. By complying to both standards we make the life
of Gerrit admins much easier.
The current timeformat for timestamps in json-logs is:
"yyyy-MM-dd'T'HH:mm:ss.SSSZ"
This results in a timestamp that is ISO8601 compliant:
2020-09-10T16:21:13.571+0200
However RFC3339 does only allows timezones in the format:
("+" / "-") time-hour ":" time-minute [1]
By changing the zone part of the timeformat:
"yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
We will get a timestamp like:
2020-09-10T16:21:13.571+02:00
This complies with both RFC3339 and ISO8601 since ISO8601 allows:
("+" / "-") time-hour [[":"] time-minute]
[1] https://tools.ietf.org/html/rfc3339
Change-Id: I5b56c5871215f8753e8b25e7664ed078461d5a00
diff --git a/Documentation/logs.txt b/Documentation/logs.txt
index 43a8e62..6624366 100644
--- a/Documentation/logs.txt
+++ b/Documentation/logs.txt
@@ -8,6 +8,12 @@
at server startup and then daily at 11pm and
link:config-gerrit.html#log.rotate[rotated] every midnight.
+== Time format
+
+For all timestamps the format `[yyyy-MM-dd'T'HH:mm:ss,SSSXXX]` is used.
+This format is both link:https://www.w3.org/TR/NOTE-datetime[ISO 8601] and
+link:https://tools.ietf.org/html/rfc3339[RFC3339] compatible.
+
== Logs
The following logs can be written.
@@ -32,10 +38,7 @@
* `username`: the username used by the client for authentication. "-" for
anonymous requests.
* `[date:time]`: The date and time stamp of the HTTP request.
- The time that the request was received. The format is until Gerrit 3.1
- `[dd/MMM/yyyy:HH:mm:ss.SSS ZZZZ]`. For Gerrit 3.2 or newer
- link:https://www.w3.org/TR/NOTE-datetime[ISO 8601 format] `[yyyy-MM-dd'T'HH:mm:ss,SSSZ]`
- is used for all timestamps.
+ The time that the request was received.
* `request`: The request line from the client is given in double quotes.
** the HTTP method used by the client.
** the resource the client requested.
@@ -63,10 +66,6 @@
Log format:
* `[date time]`: The time that the request was received.
- The format is until Gerrit 3.1 `[yyyy-mm-dd HH:mm:ss.SSS ZZZZ]`.
- For Gerrit 3.2 or newer
- link:https://www.w3.org/TR/NOTE-datetime[ISO 8601 format] `[yyyy-MM-dd'T'HH:mm:ss,SSSZ]`
- is used for all timestamps.
* `sessionid`: hexadecimal session identifier, all requests of the
same connection share the same sessionid. Gerrit does not support multiplexing multiple
sessions on the same connection. Grep the log file using the sessionid as filter to
@@ -135,10 +134,6 @@
Log format:
* `[date time]`: The time that the request was received.
- The format is until Gerrit 3.1 `[yyyy-mm-dd HH:mm:ss.SSS ZZZZ]`.
- For Gerrit 3.2 or newer
- link:https://www.w3.org/TR/NOTE-datetime[ISO 8601 format] `[yyyy-MM-dd'T'HH:mm:ss,SSSZ]`
- is used for all timestamps.
* `[thread name]`: : name of the Java thread executing the request.
* `level`: log level (ERROR, WARN, INFO, DEBUG).
* `logger`: name of the logger.
@@ -153,10 +148,6 @@
Log format:
* `[date time]`: The time that the request was received.
- The format is until Gerrit 3.1 `[yyyy-mm-dd HH:mm:ss.SSS ZZZZ]`.
- For Gerrit 3.2 or newer
- link:https://www.w3.org/TR/NOTE-datetime[ISO 8601 format] `[yyyy-MM-dd'T'HH:mm:ss,SSSZ]`
- is used for all timestamps.
* `level`: log level (ERROR, WARN, INFO, DEBUG).
* `message`: log message.
diff --git a/java/com/google/gerrit/util/logging/LogTimestampFormatter.java b/java/com/google/gerrit/util/logging/LogTimestampFormatter.java
index 9637b8b..cf071de 100644
--- a/java/com/google/gerrit/util/logging/LogTimestampFormatter.java
+++ b/java/com/google/gerrit/util/logging/LogTimestampFormatter.java
@@ -24,7 +24,7 @@
/** Formatter for timestamps used in log entries. */
public class LogTimestampFormatter {
- public static final String TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
+ public static final String TIMESTAMP_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSXXX";
private final DateTimeFormatter dateFormatter;
private final ZoneOffset timeOffset;
