Readme for logs #1102
Merged
Readme for logs #1102
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
pkg/tools/log/Readme.md
Outdated
| @@ -0,0 +1,34 @@ | |||
| ## Tips for reading and manipulating logs. | |||
|
|
|||
| ### Hot to understand logs | |||
Bolodya1997
reviewed
Oct 12, 2021
pkg/tools/log/Readme.md
Outdated
| 1. Applied to folder containing resulting logs. It removes lines related to Jaeger and remove lines with just spans. Also it changes file extension to be suitable for highlighters | ||
| ```bash | ||
| for filename in *.logs; do | ||
| cat "${filename}" | grep -v "Reporting span" | grep -v "Jaeger" | sed -E "s/^.*(Sep)/\1/g" > "$(echo "${filename}" | sed "s/\.logs/\.log/g")" |
There was a problem hiding this comment.
We are no more using timestamps in k8s logs, so:
Suggested change
| cat "${filename}" | grep -v "Reporting span" | grep -v "Jaeger" | sed -E "s/^.*(Sep)/\1/g" > "$(echo "${filename}" | sed "s/\.logs/\.log/g")" | |
| cat "${filename}" | grep -v "Reporting span" | grep -v "Jaeger" > "$(echo "${filename}" | sed "s/\.logs/\.log/g")" |
Mixaster995
force-pushed
the
documentation/log-tips
branch
2 times, most recently
from
ea93f2a to
48f3b1d
Compare
Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>
Mixaster995
force-pushed
the
documentation/log-tips
branch
from
48f3b1d to
337389d
Compare
pkg/tools/log/Readme.md
Outdated
| 3. Most of the log lines contains `[id:'some value']` which is helpful when tracing request in application chain | ||
| 4. It is useful to transform logs using `grep` utility to discard 'noise' logs that is not needed for analyzing(examples will be in section `Useful scripts`) | ||
| 5. It is helpful to install plugin to IDE which is colorizing logs. (for example ANSI highlighter for Goland) | ||
| 6. Message `an error during getting metadata from context: metadata is missed in ctx` - id a good criteria for separating ordinary request from refresh request(refresh do not have metadata) |
Mixaster995
requested review from
glazychev-art,
denis-tingaikin and
Bolodya1997
Bolodya1997
reviewed
Oct 14, 2021
pkg/tools/log/Readme.md
Outdated
| 2. It is useful to grep logs for extracting specific information that you want - by id, type, loglevel etc. For example: | ||
| - get only networkService type lines | ||
| ```bash | ||
| grep -w grep -w type:networkService some_log_file.log > another_log_file.log |
There was a problem hiding this comment.
Isn't it a duplucation?
Suggested change
| grep -w grep -w type:networkService some_log_file.log > another_log_file.log | |
| grep -w type:networkService some_log_file.log > another_log_file.log |
Mixaster995
force-pushed
the
documentation/log-tips
branch
from
8991338 to
16ad32b
Compare
Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>
Mixaster995
force-pushed
the
documentation/log-tips
branch
from
16ad32b to
746207f
Compare
denis-tingaikin
approved these changes
Oct 14, 2021
nsmbot
pushed a commit
to networkservicemesh/cmd-registry-memory
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/sdk-kernel
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/cmd-nse-vfio
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/cmd-registry-proxy-dns
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/cmd-nsc-init
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/sdk-k8s
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
nsmbot
pushed a commit
to networkservicemesh/cmd-nsmgr-proxy
that referenced
this pull request
Oct 14, 2021
…k@main PR link: networkservicemesh/sdk#1102 Commit: f264fec Author: Авраменко Михаил Date: 2021-10-14 16:25:25 +0700 Message: - Readme for logs (#1102) * added doc for logs Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com> * review fixes Signed-off-by: NSMBot <nsmbot@networkservicmesh.io>
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.
Signed-off-by: Mikhail Avramenko avramenkomihail15@gmail.com
Description
Added document with useful tips for analysing logs
Issue link
#1008
Types of changes