Logging guidelines draft #512
Conversation
stranger80
requested review from
azawlocki,
filipgolem,
rad9k,
shadeofblue and
kmazurek
docs/logging-guidelines.md
Outdated
| ``` | ||
| do this: | ||
| ``` | ||
| [2020-08-27T07:56:22Z DEBUG yagna] Initializing GNT payment driver... |
There was a problem hiding this comment.
| [2020-08-27T07:56:22Z DEBUG yagna] Initializing GNT payment driver... | |
| [2020-08-27T07:56:22Z DEBUG yagna] Initializing GNT payment driver |
|
|
||
| **Audience:** | ||
| - Users | ||
|
|
There was a problem hiding this comment.
I think this is also very important for node owners/admins.
| log this: | ||
|
|
||
| ``` | ||
| [2020-08-27T07:56:22Z ERROR yagna] E00342 - WASM ExeUnit DEPLOY: Error downloading remote file to temp folder '/tmp/yagna_data': File IO error: Path not found |
There was a problem hiding this comment.
From my experience of debugging yagna: the file name and line number where the error occurred is very important as it's ofter easier to just read the source code to find the problem. (I know you mentioned it in "Log entry content" section.)
There was a problem hiding this comment.
Agreed, albeit the error code indicated in this example serves this purpose: with a specific error code it should be fairly instantaneous to identify the location responsible for a particular issue (I'm conscious that providing file/line number may not be feasible for many dev platforms).
docs/logging-guidelines.md
Outdated
| - **Grouping or correlating** attribute (attribute which allows to filter events related to a single command, activity, API request, etc.) | ||
| - Thread id | ||
| - Bespoke correlation id | ||
| - Log entry **description** (human readable, no linebreaks) |
There was a problem hiding this comment.
Sometimes "no linebreaks" is opposite of "human readable"
There was a problem hiding this comment.
Agreed, rewritten
stranger80
dismissed stale reviews from filipgolem and shadeofblue
via
66fc3a6
stranger80
requested review from
nieznanysprawiciel,
shadeofblue and
filipgolem
|
Merged latest master state and added reference to logging guidelines from the SDP doc. |
| @@ -106,6 +106,10 @@ https://doc.rust-lang.org/1.0.0/style/README.html | |||
| To enforce formatting, code should be formatted using rustfmt tool (https://github.com/rust-lang/rustfmt). | |||
| To install it, run `rustup component add rustfmt` command. To format files in the working dictory, please run `cargo fmt` command. | |||
|
|
|||
| ### Logging Guidelines | |||
|
|
|||
| The logging guidelines for Yagna component development can be found here: logging-guidelines.md. | |||
There was a problem hiding this comment.
this does not render as link
|
👍 good job guys! Thx! |
No description provided.