8000 Allow for `fmt` to be a callable that formats the record. by arcivanov · Pull Request #114 · fluent/fluent-logger-python · GitHub
[go: up one dir, main page]
Skip to content

Allow for fmt to be a callable that formats the record. #114

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Dec 10, 2017
Merged

Allow for fmt to be a callable that formats the record. #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 48 additions & 29 deletions fluent/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ class FluentRecordFormatter(logging.Formatter, object):

Best used with server storing data in an ElasticSearch cluster for example.

:param fmt: a dict with format string as values to map to provided keys.
:param fmt: a dict or a callable with format string as values to map to provided keys.
If callable, should accept a single argument `LogRecord` and return a dict,
and have a field `usesTime` that is callable and return a bool as would
`FluentRecordFormatter.usesTime`
:param datefmt: strftime()-compatible date/time format string.
:param style: '%', '{' or '$' (used only with Python 3.2 or above)
:param fill_missing_fmt_key: if True, do not raise a KeyError if the format
Expand All @@ -32,7 +35,7 @@ class FluentRecordFormatter(logging.Formatter, object):
:param exclude_attrs: switches this formatter into a mode where all attributes
except the ones specified by `exclude_attrs` are logged with the record as is.
If `None`, operates as before, otherwise `fmt` is ignored.
Can be a `list`, `tuple` or a `set`.
Can be an iterable.
"""

def __init__(self, fmt=None, datefmt=None, style='%', fill_missing_fmt_key=False, format_json=True,
Expand Down Expand Up @@ -63,12 +66,22 @@ def __init__(self, fmt=None, datefmt=None, style='%', fill_missing_fmt_key=False
if exclude_attrs is not None:
self._exc_attrs = set(exclude_attrs)
self._fmt_dict = None
self._formatter = self._format_by_exclusion
8000 self.usesTime = super(FluentRecordFormatter, self).usesTime
else:
self._exc_attrs = None
if not fmt:
self._fmt_dict = basic_fmt_dict
self._formatter = self._format_by_dict
self.usesTime = self._format_by_dict_uses_time
else:
self._fmt_dict = fmt
if hasattr(fmt, "__call__"):
self._formatter = fmt
self.usesTime = fmt.usesTime
else:
self._fmt_dict = fmt
self._formatter = self._format_by_dict
self.usesTime = self._format_by_dict_uses_time

if format_json:
self._format_msg = self._format_msg_json
Expand All @@ -90,37 +103,13 @@ def format(self, record):
record.hostname = self.hostname

# Apply format
data = {}
if self._exc_attrs is not None:
for key, value in record.__dict__.items():
if key not in self._exc_attrs:
data[key] = value
else:
for key, value in self._fmt_dict.items():
try:
if self.__style:
value = self.__style(value).format(record)
else:
value = value % record.__dict__
except KeyError as exc:
value = None
if not self.fill_missing_fmt_key:
raise exc

data[key] = value
data = self._formatter(record)

self._structuring(data, record)
return data

def usesTime(self):
if self._exc_attrs is not None:
return super(FluentRecordFormatter, self).usesTime()
else:
if self.__style:
search = self.__style.asctime_search
else:
search = "%(asctime)"
return any([value.find(search) >= 0 for value in self._fmt_dict.values()])
"""This method is substituted on construction based on settings for performance reasons"""

def _structuring(self, data, record):
""" Melds `msg` into `data`.
Expand Down Expand Up @@ -153,6 +142,36 @@ def _format_msg_json(self, record, msg):
def _format_msg_default(self, record, msg):
return {'message': record.getMessage()}

def _format_by_exclusion(self, record):
data = {}
for key, value in record.__dict__.items():
if key not in self._exc_attrs:
data[key] = value
return data

def _format_by_dict(self, record):
data = {}
for key, value in self._fmt_dict.items():
try:
if self.__style:
value = self.__style(value).format(record)
else:
value = value % record.__dict__
except KeyError as exc:
value = None
if not self.fill_missing_fmt_key:
raise exc

data[key] = value
return data

def _format_by_dict_uses_time(self):
if self.__style:
search = self.__style.asctime_search
else:
search = "%(asctime)"
return any([value.find(search) >= 0 for value in self._fmt_dict.values()])

@staticmethod
def _add_dic(data, dic):
for key, value in dic.items():
Expand Down
27 changes: 27 additions & 0 deletions tests/test_handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,33 @@ def test_exclude_attrs_with_extra(self):
self.assertEqual("Test with value 'test value'", data[0][2]['message'])
self.assertEqual(1234, data[0][2]['x'])

def test_format_dynamic(self):
def formatter(record):
return {
"message": record.message,
"x": record.x,
"custom_value": 1
}

formatter.usesTime = lambda: True

handler = fluent.handler.FluentHandler('app.follow', port=self._port)

with handler:
logging.basicConfig(level=logging.INFO)
log = logging.getLogger('fluent.test')
handler.setFormatter(
fluent.handler.FluentRecordFormatter(fmt=formatter)
)
log.addHandler(handler)
log.info("Test with value '%s'", "test value", extra={"x": 1234})
log.removeHandler(handler)

data = self.get_data()
self.assertTrue('x' in data[0][2])
self.assertEqual(1234, data[0][2]['x'])
self.assertEqual(1, data[0][2]['custom_value'])

@unittest.skipUnless(sys.version_info[0:2] >= (3, 2), 'supported with Python 3.2 or above')
def test_custom_fmt_with_format_style(self):
handler = fluent.handler.FluentHandler('app.follow', port=self._port)
Expand Down
0