-
Notifications
You must be signed in to change notification settings - Fork 14.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add %z for %(asctime)s to fix timezone for logs on UI #24811
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you under the Apache License, Version 2.0 (the | ||
# "License"); you may not use this file except in compliance | ||
# with the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, | ||
# software distributed under the License is distributed on an | ||
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
# KIND, either express or implied. See the License for the | ||
# specific language governing permissions and limitations | ||
# under the License. | ||
import logging | ||
|
||
import pendulum | ||
|
||
|
||
class TimezoneAware(logging.Formatter): | ||
""" | ||
Override `default_time_format`, `default_msec_format` and `formatTime` to specify utc offset. | ||
utc offset is the matter, without it, time conversion could be wrong. | ||
With this Formatter, `%(asctime)s` will be formatted containing utc offset. (ISO 8601) | ||
(e.g. 2022-06-12T13:00:00.123+0000) | ||
""" | ||
|
||
default_time_format = '%Y-%m-%dT%H:%M:%S' | ||
default_msec_format = '%s.%03d' | ||
default_tz_format = '%z' | ||
|
||
def formatTime(self, record, datefmt=None): | ||
""" | ||
Returns the creation time of the specified LogRecord in ISO 8601 date and time format | ||
in the local time zone. | ||
""" | ||
dt = pendulum.from_timestamp(record.created, tz=pendulum.local_timezone()) | ||
if datefmt: | ||
s = dt.strftime(datefmt) | ||
else: | ||
s = dt.strftime(self.default_time_format) | ||
|
||
if self.default_msec_format: | ||
s = self.default_msec_format % (s, record.msecs) | ||
if self.default_tz_format: | ||
s += dt.strftime(self.default_tz_format) | ||
return s |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -103,6 +103,7 @@ function autoTailingLog(tryNumber, metadata = null, autoTailing = false) { | |
// Detect urls and log timestamps | ||
const urlRegex = /http(s)?:\/\/[\w.-]+(\.?:[\w.-]+)*([/?#][\w\-._~:/?#[\]@!$&'()*+,;=.%]+)?/g; | ||
const dateRegex = /\d{4}[./-]\d{2}[./-]\d{2} \d{2}:\d{2}:\d{2},\d{3}/g; | ||
const iso8601Regex = /\d{4}[./-]\d{2}[./-]\d{2}T\d{2}:\d{2}:\d{2}.\d{3}[+-]\d{4}/g; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we not do both of these checks in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The regular expression on the |
||
|
||
res.message.forEach((item) => { | ||
const logBlockElementId = `try-${tryNumber}-${item[0]}`; | ||
|
@@ -120,7 +121,8 @@ function autoTailingLog(tryNumber, metadata = null, autoTailing = false) { | |
const escapedMessage = escapeHtml(item[1]); | ||
const linkifiedMessage = escapedMessage | ||
.replace(urlRegex, (url) => `<a href="${url}" target="_blank">${url}</a>`) | ||
.replaceAll(dateRegex, (date) => `<time datetime="${date}+00:00" data-with-tz="true">${formatDateTime(`${date}+00:00`)}</time>`); | ||
.replaceAll(dateRegex, (date) => `<time datetime="${date}+00:00" data-with-tz="true">${formatDateTime(`${date}+00:00`)}</time>`) | ||
.replaceAll(iso8601Regex, (date) => `<time datetime="${date}" data-with-tz="true">${formatDateTime(`${date}`)}</time>`); | ||
logBlock.innerHTML += `${linkifiedMessage}\n`; | ||
}); | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Added new config ``[logging]log_formatter_class`` to fix timezone display for logs on UI | ||
|
||
If you are using a custom Formatter subclass in your ``[logging]logging_config_class``, please inherit from ``airflow.utils.log.timezone_aware.TimezoneAware`` instead of ``logging.Formatter``. | ||
For example, in your ``custom_config.py``: | ||
|
||
.. code-block:: python | ||
from airflow.utils.log.timezone_aware import TimezoneAware | ||
|
||
# before | ||
class YourCustomFormatter(logging.Formatter): | ||
... | ||
|
||
|
||
# after | ||
class YourCustomFormatter(TimezoneAware): | ||
... | ||
|
||
|
||
AIRFLOW_FORMATTER = LOGGING_CONFIG["formatters"]["airflow"] | ||
AIRFLOW_FORMATTER["class"] = "somewhere.your.custom_config.YourCustomFormatter" | ||
# or use TimezoneAware class directly. If you don't have custom Formatter. | ||
AIRFLOW_FORMATTER["class"] = "airflow.utils.log.timezone_aware.TimezoneAware" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bump up.
#24373 didn't show up on https://github.com/apache/airflow/pull/24762/files#diff-9b07fd28838e759e05bdaa5293886d860374fe291bdc6cc43c20f951fc77eab4 and it's commits