Add documentation for logging in odo and odo create enhancements #673

anmolbabu · 2018-08-28T10:13:39Z

This PR adds the following information:

Enhancements in odo create command added to docs/cli-reference.md
docs/logging.md describes about the use of glog for logging

fixes #667
Signed-off-by: anmolbabu anmolbudugutta@gmail.com

cdrage

Please remove any cli-reference.md changes. We auto generate this through: https://github.com/redhat-developer/odo/blob/master/scripts/cli-reference/generate-cli-reference.go if you want to make changes, you should look at the cmd folder and edit the help menu / descriptions there!

cdrage · 2018-08-29T14:19:44Z

docs/development.md

@@ -122,7 +122,7 @@ When new git tag is created, Travis-ci deploy job automatically builds binaries
    Do not upload any binaries for release
    When new tag is created Travis-CI starts a special deploy job.
    This job builds binaries automatically (via `make prepare-release`) and then uploads it to GitHub release page (done using odo-bot user).
-3. When job fishes you should see binaries on GitHub release page. Release is now marked as a draft. Update descriptions and publish release.
+3. When job finishes you should see binaries on GitHub release page. Release is now marked as a draft. Update descriptions and publish release.


When a job finishes

on the GitHub release page

cdrage · 2018-08-29T14:20:08Z

docs/logging.md

@@ -0,0 +1,41 @@
+# Logging in ODO
+
+[Glog](https://godoc.org/github.com/golang/glog) is used for v style logging in ODO.


ODO should be Odo

cdrage · 2018-08-29T14:20:58Z

docs/logging.md

+# Logging in ODO
+
+[Glog](https://godoc.org/github.com/golang/glog) is used for v style logging in ODO.
+glog provides functions such as Info, Warning, Error, Fatal, plus formatting variants such as Infof. It also provides V-style logging controlled by the -v for better runtime control


I don't we need this in here. Perhaps we can replace it with the different levels of logging we use? For example, we do not yet know how many levels in-terms of numbers. (zero to 4?)

0 to 9 as in the link in https://github.com/redhat-developer/odo/pull/673/files#diff-6fede6782d33a3306a99cb1a47ea5f6bR28

added the same here now

cdrage

LGTM

This PR adds the following information: 1. Enhancements in odo create command added to docs/cli-reference.md 2. docs/logging.md describes about the use of glog for logging fixes redhat-developer#667 Signed-off-by: anmolbabu <anmolbudugutta@gmail.com>

cdrage · 2018-08-31T16:23:52Z

cmd/root.go

@@ -122,6 +122,10 @@ func init() {
 	pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
 	pflag.CommandLine.Set("logtostderr", "true")

+	// Override the verbosity flag description
+	verbosity := pflag.Lookup("v")
+	verbosity.Usage += ". Level varies from 0 to 9 (default 0)."


cdrage · 2018-08-31T16:24:55Z

docs/logging.md

+
+## Working
+
+Every ODO command takes an optional flag `-v` that must be used with an integer log level in the range from 0-9. And any INFO severity log statement that is logged at a level lesser than or equal to the one passed with the command alongside `-v` flag will be logged to the STDOUT.


Should be Odo not ODO.

Any INFO severity log statement Don't start sentences with "And"

logged to STDOUT

cdrage · 2018-08-31T16:25:17Z

docs/logging.md

+
+Every ODO command takes an optional flag `-v` that must be used with an integer log level in the range from 0-9. And any INFO severity log statement that is logged at a level lesser than or equal to the one passed with the command alongside `-v` flag will be logged to the STDOUT.
+
+All ERROR severity level log messages will always be logged immaterial of the passed `v` level.


always be logged regardless of the passed V level.

cdrage · 2018-08-31T16:26:07Z

docs/logging.md

+
+Every source file that needs to log messages will need to import glog as under:
+
+```


make it ```go

not ```

so there is formatting in markdown

Did you mean get ``` and the statement in same line ?
If so, done

cdrage · 2018-08-31T16:26:35Z

docs/logging.md

+
+## Usage
+
+Every source file that needs to log messages will need to import glog as under:


Every source file that requires logging will need to import glog

cdrage · 2018-08-31T16:26:58Z

docs/logging.md

+glog.V(4).Infof(msg, args...)
+```
+
+For more info level logging conventions please refer [here](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-output-verbosity-and-debugging)


missing period at end of sentence

cdrage · 2018-08-31T16:27:12Z

docs/logging.md

+```
+glog.Warningf(msg, args...)
+```
+Similarly there are also Info, Error and Warning counterparts of each of thes above that don't take format args but instead a string message


missing newline above

Similarly there is also

Actually, maybe remove this sentence. The user can look at https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-output-verbosity-and-debugging if they need help

Signed-off-by: anmolbabu <anmolbudugutta@gmail.com>

cdrage · 2018-09-04T16:39:04Z

This LGTM! Let's merge.

anmolbabu requested review from cdrage, kadel, surajnarwade, syamgk and mik-dass August 28, 2018 10:13

anmolbabu self-assigned this Aug 28, 2018

This was referenced Aug 28, 2018

Include imagestreams in current namespace for catalog listing #618

Merged

Enable levelled logging #590

Merged

cdrage reviewed Aug 29, 2018

View reviewed changes

anmolbabu force-pushed the docs branch from 53edf79 to ab10a68 Compare August 30, 2018 11:38

cdrage approved these changes Aug 30, 2018

View reviewed changes

anmolbabu force-pushed the docs branch from ab10a68 to e1cc896 Compare August 31, 2018 10:00

cdrage suggested changes Aug 31, 2018

View reviewed changes

Incoporate @cdrage comments

59f8d2c

Signed-off-by: anmolbabu <anmolbudugutta@gmail.com>

cdrage approved these changes Sep 4, 2018

View reviewed changes

cdrage merged commit 8ced49f into redhat-developer:master Sep 4, 2018

anmolbabu deleted the docs branch September 4, 2018 18:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for logging in odo and odo create enhancements #673

Add documentation for logging in odo and odo create enhancements #673

anmolbabu commented Aug 28, 2018

cdrage left a comment

cdrage Aug 29, 2018

cdrage Aug 29, 2018

anmolbabu Aug 30, 2018

cdrage Aug 29, 2018

cdrage Aug 29, 2018

anmolbabu Aug 30, 2018

cdrage Aug 29, 2018

anmolbabu Aug 30, 2018

anmolbabu Aug 30, 2018

cdrage left a comment

cdrage Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage Aug 31, 2018

cdrage Aug 31, 2018

cdrage Aug 31, 2018

cdrage Aug 31, 2018

anmolbabu Aug 31, 2018

cdrage commented Sep 4, 2018

		@@ -0,0 +1,41 @@
		# Logging in ODO

		[Glog](https://godoc.org/github.com/golang/glog) is used for v style logging in ODO.


		## Working

		Every ODO command takes an optional flag `-v` that must be used with an integer log level in the range from 0-9. And any INFO severity log statement that is logged at a level lesser than or equal to the one passed with the command alongside `-v` flag will be logged to the STDOUT.


		Every ODO command takes an optional flag `-v` that must be used with an integer log level in the range from 0-9. And any INFO severity log statement that is logged at a level lesser than or equal to the one passed with the command alongside `-v` flag will be logged to the STDOUT.

		All ERROR severity level log messages will always be logged immaterial of the passed `v` level.


		Every source file that needs to log messages will need to import glog as under:

		```


		## Usage

		Every source file that needs to log messages will need to import glog as under:

Add documentation for logging in odo and odo create enhancements #673

Add documentation for logging in odo and odo create enhancements #673

Conversation

anmolbabu commented Aug 28, 2018

cdrage left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdrage left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdrage commented Sep 4, 2018