Change logging documentation #91
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
devanych
commented
Dec 4, 2020
•
devanych
commented
| Q | A |
|---|---|
| Is bugfix? | ❌ |
| New feature? | ❌ |
| Breaks BC? | ❌ |
| Fixed issues | yiisoft/log#19 |
samdark
requested changes
Dec 4, 2020
guide/en/runtime/logging.md
Outdated
|
|
||
| ``` | ||
| 2014-10-04 18:10:15 [::1][][-][trace][yii\base\Module::getModule] Loading module: debug | ||
| Timestamp Prifix[Level][Category] Message Context |
There was a problem hiding this comment.
Suggested change
| Timestamp Prifix[Level][Category] Message Context | |
| Timestamp Prefix[Level][Category] Message Context |
There was a problem hiding this comment.
A real example was handy here. I think it's a good idea to provide it as well.
guide/en/runtime/logging.md
Outdated
Comment on lines
120
to
122
| * [[\Yiisoft\Log\PsrTarget]]: passes log messages to another PSR-3 compatible logger. | ||
| * [[\Yiisoft\Log\StreamTarget]]: writes log messages in specified output stream. | ||
| * [[\Yiisoft\Log\Target\Db\DbTarget]]: saves log messages in database. |
There was a problem hiding this comment.
Suggested change
| * [[\Yiisoft\Log\PsrTarget]]: passes log messages to another PSR-3 compatible logger. | |
| * [[\Yiisoft\Log\StreamTarget]]: writes log messages in specified output stream. | |
| * [[\Yiisoft\Log\Target\Db\DbTarget]]: saves log messages in database. | |
| * [[\Yiisoft\Log\PsrTarget]]: passes log messages to another PSR-3 compatible logger. | |
| * [[\Yiisoft\Log\StreamTarget]]: writes log messages into specified output stream. | |
| * [[\Yiisoft\Log\Target\Db\DbTarget]]: saves log messages in database. |
guide/en/runtime/logging.md
Outdated
| ``` | ||
|
|
||
| By default, log messages will be formatted as follows by the [[\Yiisoft\Log\Target::formatMessage()]]: | ||
| You may customize this format by calling [[\Yiisoft\Log\Target::setFormat()|setFormat()]] method, | ||
| which takes a PHP callable returning a customized message format. |
There was a problem hiding this comment.
Suggested change
| which takes a PHP callable returning a customized message format. | |
| which takes a PHP callable returning a custom formatted message. |
guide/en/runtime/logging.md
Outdated
| The following protected methods will also be available for child targets: | ||
|
|
||
| - `getMessages` - Gets a list of log messages ([[\Yii\Log\Message]] instances). | ||
| - `getFormattedMessages` - Gets a list of formatted string log messages. |
There was a problem hiding this comment.
Suggested change
| - `getFormattedMessages` - Gets a list of formatted string log messages. | |
| - `getFormattedMessages` - Get a list of log messages formatted as strings. |
guide/en/runtime/logging.md
Outdated
|
|
||
| - `getMessages` - Gets a list of log messages ([[\Yii\Log\Message]] instances). | ||
| - `getFormattedMessages` - Gets a list of formatted string log messages. | ||
| - `formatMessages` - Gets formatted all log messages for display as a string. |
There was a problem hiding this comment.
Suggested change
| - `formatMessages` - Gets formatted all log messages for display as a string. | |
| - `formatMessages` - Get all log messages formatted as a string. |
guide/en/runtime/logging.md
Outdated
| - `getMessages` - Gets a list of log messages ([[\Yii\Log\Message]] instances). | ||
| - `getFormattedMessages` - Gets a list of formatted string log messages. | ||
| - `formatMessages` - Gets formatted all log messages for display as a string. | ||
| - `getCommonContext` - Gets an array with common context data in the `key => value` format. |
There was a problem hiding this comment.
Suggested change
| - `getCommonContext` - Gets an array with common context data in the `key => value` format. | |
| - `getCommonContext` - Get an array with common context data in the `key => value` format. |
guide/en/runtime/logging.md
Outdated
| - `formatMessages` - Gets formatted all log messages for display as a string. | ||
| - `getCommonContext` - Gets an array with common context data in the `key => value` format. | ||
|
|
||
| For more details, you may refer to any of the log target classes included in the Yii release. |
There was a problem hiding this comment.
Suggested change
| For more details, you may refer to any of the log target classes included in the Yii release. | |
| For more details, you may refer to any of the log target classes included in the package. |
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.