Readme for logs #1102

Mixaster995 · 2021-10-12T05:57:58Z

Signed-off-by: Mikhail Avramenko avramenkomihail15@gmail.com

Description

Added document with useful tips for analysing logs

Issue link

#1008

Types of changes

denis-tingaikin · 2021-10-12T06:33:25Z

pkg/tools/log/Readme.md

@@ -0,0 +1,34 @@
+## Tips for reading and manipulating logs.
+
+### Hot to understand logs


Bolodya1997 · 2021-10-12T07:09:34Z

pkg/tools/log/Readme.md

+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")"


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")"

Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>

glazychev-art · 2021-10-12T11:08:56Z

pkg/tools/log/Readme.md

+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)


... - is a good ...

Bolodya1997 · 2021-10-14T04:55:30Z

pkg/tools/log/Readme.md

+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


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

Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>

denis-tingaikin

I think this is fine as a first version

…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>

denis-tingaikin reviewed Oct 12, 2021

View reviewed changes

denis-tingaikin assigned glazychev-art, Bolodya1997 and Mixaster995 Oct 12, 2021

Bolodya1997 reviewed Oct 12, 2021

View reviewed changes

Mixaster995 force-pushed the documentation/log-tips branch 2 times, most recently from ea93f2a to 48f3b1d Compare October 12, 2021 07:12

added doc for logs

337389d

Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>

Mixaster995 force-pushed the documentation/log-tips branch from 48f3b1d to 337389d Compare October 12, 2021 07:13

Mixaster995 added this to Review in progress in Issue/PR tracking Oct 12, 2021

glazychev-art reviewed Oct 12, 2021

View reviewed changes

Mixaster995 requested review from glazychev-art, denis-tingaikin and Bolodya1997 October 13, 2021 04:45

Bolodya1997 reviewed Oct 14, 2021

View reviewed changes

Mixaster995 force-pushed the documentation/log-tips branch from 8991338 to 16ad32b Compare October 14, 2021 05:24

review fixes

746207f

Signed-off-by: Mikhail Avramenko <avramenkomihail15@gmail.com>

Mixaster995 force-pushed the documentation/log-tips branch from 16ad32b to 746207f Compare October 14, 2021 05:47

denis-tingaikin approved these changes Oct 14, 2021

View reviewed changes

denis-tingaikin merged commit f264fec into networkservicemesh:main Oct 14, 2021

Issue/PR tracking automation moved this from Review in progress to Done Oct 14, 2021

This was referenced Oct 14, 2021

Update from update/networkservicemesh/sdk networkservicemesh/cmd-registry-memory#414

Merged

Update from update/networkservicemesh/sdk networkservicemesh/sdk-kernel#352

Merged

Update from update/networkservicemesh/sdk networkservicemesh/cmd-nse-vfio#245

Merged

This was referenced Oct 14, 2021

Update from update/networkservicemesh/sdk networkservicemesh/sdk-k8s#258

Merged

Update from update/networkservicemesh/sdk networkservicemesh/cmd-registry-proxy-dns#397

Merged

Update from update/networkservicemesh/sdk networkservicemesh/cmd-nsc-init#225

Merged

Mixaster995 deleted the documentation/log-tips branch October 15, 2021 02:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Readme for logs #1102

Readme for logs #1102

Mixaster995 commented Oct 12, 2021

denis-tingaikin Oct 12, 2021

Mixaster995 Oct 12, 2021

Bolodya1997 Oct 12, 2021

Mixaster995 Oct 12, 2021

glazychev-art Oct 12, 2021

Mixaster995 Oct 13, 2021

Bolodya1997 Oct 14, 2021

Mixaster995 Oct 14, 2021

denis-tingaikin left a comment

		@@ -0,0 +1,34 @@
		## Tips for reading and manipulating logs.

		### Hot to understand logs

	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")"

	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

Readme for logs #1102

Readme for logs #1102

Conversation

Mixaster995 commented Oct 12, 2021

Description

Issue link

Types of changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

denis-tingaikin left a comment

Choose a reason for hiding this comment