tarantool / tarantool/doc

Document that logger now encodes table arguments in JSON

Open
#4,721 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.4 logging
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/8611
Product: Tarantool
Since: 3.4
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/log/#overview
SME: @ locker

Details

Scope:

How it used to work:

tarantool> require('log').info('%s', {foo = 'bar'})
table: 0x41f9d2e8

How it works now:

tarantool> require('log').info('%s', {foo = 'bar'})
{"foo":"bar"}

Note, JSON encoding is enabled only for tables that don't have
the __tostring meta-method:

tarantool> require('log').info('%s', setmetatable({foo = 'bar'}, {__tostring = function() return 'foobar' end}))
foobar

Requested by @ locker in https://github.com/tarantool/tarantool/commit/3db73c65f29a7d1991f7a94e5b488cd7c142bba1.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the root log reference and the three named anchors for log.error, log.warn, and log.info. Add the documented table-argument JSON behavior, the existing examples, and the __tostring exception; done means all three sections describe the output shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.