Skip to content

Document logging configuration settings #4139

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

Merged
merged 7 commits into from
Apr 12, 2024
Merged

Document logging configuration settings #4139

merged 7 commits into from
Apr 12, 2024

Conversation

andreyaksenov
Copy link
Contributor

@andreyaksenov andreyaksenov commented Apr 8, 2024

  1. Runnable samples/tests used in docs:

    • Added samples showing how to configure various logging options (placed in the doc/code_snippets/snippets/config/instances.enabled/ directory, names start with log_).
    • Updated log_test.lua used in the log module docs.
  2. Docs:

  3. Changes not directly related to log settings - fixed audit_log samples:

    • audit_log_pipe had an incorrect value in the audit_log.pipe option.
    • audit_log_syslog had a broken cluster topology and an incorrect value in the audit_log.filter option (string instead of array).

@andreyaksenov andreyaksenov linked an issue Apr 8, 2024 that may be closed by this pull request
@andreyaksenov andreyaksenov force-pushed the logging branch 14 times, most recently from 179cb7a to 59e3e00 Compare April 9, 2024 15:33
@andreyaksenov andreyaksenov force-pushed the logging branch 2 times, most recently from b311842 to a90ffcc Compare April 10, 2024 07:34
@andreyaksenov andreyaksenov marked this pull request as ready for review April 10, 2024 08:01
Copy link
Contributor

@xuniq xuniq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


.. confval:: log.format

Specify a format is used for a log entry.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Specify a format is used for a log entry.
Specify a format that is used for a log entry.

Example on GitHub: `log_level <https://github.com/tarantool/doc/tree/latest/doc/code_snippets/snippets/config/instances.enabled/log_level>`_.

|
| Type: number, string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The option here accepts both string and number as values, as stated in instance_config.lua

In the box.cfg reference, only the number is mentioned - is this correct?

Copy link
Contributor Author

@andreyaksenov andreyaksenov Apr 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The option here accepts both string and number as values, as stated in instance_config.lua

In the box.cfg reference, only the number is mentioned - is this correct?

Checked - also accepts string values. Also fixed string values that log_level accepts (db007f8). For example, CRITICAL is an incorrect value. Thanks!

@andreyaksenov andreyaksenov merged commit 3b51c8b into latest Apr 12, 2024
@andreyaksenov andreyaksenov deleted the logging branch April 12, 2024 08:52
@andreyaksenov andreyaksenov linked an issue Apr 12, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Config] Document 'log' configuration settings [Config] Update the 'Logs' guide to using a new config
2 participants