Skip to content

chore(docs): update log level descriptions #14307

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −8
Open

chore(docs): update log level descriptions #14307

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
20 changes: 12 additions & 8 deletions kong/pdk/log.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,15 +276,19 @@ end

---
-- Similar to `kong.log()`, but the produced log has the severity given by
-- `<level>`, instead of `notice`. The supported levels are:
-- `<level>`, instead of `notice`. For each message written to the logs,
-- carefully consider who the target audience is, and set the level accordingly.
-- The supported levels are:
--
-- * `kong.log.alert()`
-- * `kong.log.crit()`
-- * `kong.log.err()`
-- * `kong.log.warn()`
-- * `kong.log.notice()`
-- * `kong.log.info()`
-- * `kong.log.debug()`
-- function | usage | audience
-- -|-|-
-- `kong.log.alert()` | Conditions that require immediate intervention. | Platform operators
-- `kong.log.crit()` | Errors that indicate serious failures in Kong or the underlying system. | Platform operators
-- `kong.log.err()` | Serious issues that prevent proper request handling but do not cause Kong to stop/fail. | Platform operators
-- `kong.log.warn()` | Warnings about potential issues that may require intervention but are not immediate failures. | Platform operators
-- `kong.log.notice()`| Typically used for plugin flow analysis, eg. authentication failures. | Plugin author/user
-- `kong.log.info()` | Used for debugging plugins. Consider this the `debug` level for plugins. | Plugin author
-- `kong.log.debug()` | Reserved for the core engine debug logs, do not use this for plugins. | Kong support/engineering
--
-- Logs have the same format as that of `kong.log()`. For
-- example, the following call:
Expand Down
Loading