✨clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable #2996

cpanato · 2020-05-03T15:57:30Z

What this PR does / why we need it:
add a CLUSTERCTL_LOG_LEVEL environment variable to be used instead of the -v.
if CLUSTERCTL_LOG_LEVEL is set it will override the flag -v

example, I did not have any running cluster, then I added some log output to make the example.
UPDATED with the new behavior

$ export CLUSTERCTL_LOG_LEVEL=5
$  ./bin/clusterctl config cluster my -v3
Info
info level 0
info level 1
info level 2
info level 3
Error: failed to identify the default infrastructure provider. Please specify an infrastructure provider: unsupported management cluster server version: v1.14.6 - minimum required version is v1.16.0

$ export CLUSTERCTL_LOG_LEVEL=5
$  ./bin/clusterctl config cluster my
Info
info level 0
info level 1
info level 2
info level 3
info level 4
info level 5
Error: failed to identify the default infrastructure provider. Please specify an infrastructure provider: unsupported management cluster server version: v1.14.6 - minimum required version is v1.16.0

and

$ unset CLUSTERCTL_LOG_LEVEL
$  ./bin/clusterctl config cluster my -v3
Info
info level 0
info level 1
info level 2
info level 3
Error: failed to identify the default infrastructure provider. Please specify an infrastructure provider: unsupported management cluster server version: v1.14.6 - minimum required version is v1.16.0

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

Fixes: Define config var for clusterctl log level #2957

/kind feature
cc @wfernandes

cpanato · 2020-05-03T15:58:59Z

/area clusterctl

fabriziopandini

@cpanato thanks for this PR
In clusterctl flags takes precedence on env variables.
Is it possible to change this PR to comply with the above rule?

Also, in clusterctl we are allowing to use env variables or config variables by using a pluggable config component, while the management of this variable is totally detached from the rest of the config variables (e.g. this variable can't be set using the config file).
@wfernandes is this what you are expecting?

cpanato · 2020-05-04T09:07:03Z

@fabriziopandini yes i can change that, also can you point to me this part of the config variables?

and i will wait as well from @wfernandes for some feedback before apply any changes because it might change everything :)

fabriziopandini · 2020-05-04T11:49:59Z

the config is managed in this package https://github.com/kubernetes-sigs/cluster-api/tree/master/cmd/clusterctl/client/config
you might look for client (the package entry point) and variable_client

cpanato · 2020-05-04T16:07:37Z

@fabriziopandini did one change for feedback and keep the old change in the previous commit for feedback

one thing that is weird and maybe because I'm doing something wrong is i tried to print the verbosity and it shows to me always 0 even when i set the -v3but the logs get the correct levels, i might doing something very wrong

verbosity := flag.CommandLine.Int("v", 0, "Set the log level verbosity.")
fmt.Println(*verbosity)

wfernandes · 2020-05-04T17:12:24Z

@cpanato Thanks for this PR. I'll take a look at it by EOD today. Also in the above comment, I think you intended it for @fabriziopandini instead of fabianofranz.

cpanato · 2020-05-04T17:13:59Z

Ok, figured out, the value is not available in the init function, only outside that.
added an initConfig fund to check the values and set from the config file or env var the log level

cpanato · 2020-05-04T17:14:42Z

@wfernandes correct 😬 fixed

wfernandes · 2020-05-05T14:24:14Z

Reviewing

wfernandes

This looks good to me. I agree with @fabriziopandini suggestions regarding log level priority. That is, flag value should take precedence.

The only other thing I'd like to add is documentation for this config variable. It could either be a new section in https://cluster-api.sigs.k8s.io/clusterctl/developers.html or https://cluster-api.sigs.k8s.io/clusterctl/configuration.html since it still could be useful to others and it pertains to clusterctl configuration.
I prefer the latter since we could just add a section about debugging/logging in clusterctl and mention the -v flag and then also mention the env var CLUSTERCTL_LOG_LEVEL. But I leave it up to you 🙂

cmd/clusterctl/cmd/root.go

cpanato · 2020-05-06T09:41:29Z

@wfernandes applied the feedback changes you requested. PTAL when you have time

cpanato · 2020-05-06T10:49:24Z

/test pull-cluster-api-capd-e2e

fabriziopandini

@cpanato thanks for this new version
Looks good to me, I will test it locally ASAP and report back

docs/book/src/clusterctl/configuration.md

wfernandes · 2020-05-06T15:48:14Z

I ran this locally and it looks good to me. Thanks so much for doing this PR. I'm going to use the heck out of this feature 😄

I like the fact that I can set the config variable to a high number but then I can do something like clusterctl config cluster foo -v1 | kubectl apply -f - if I need to create workload clusters (for now).

/lgtm

wfernandes · 2020-05-06T16:02:14Z

/lgtm

wfernandes · 2020-05-06T16:03:05Z

I'll leave approval for @fabriziopandini since he mentioned that he'd like to test it out.

jodavis-suse

Looks really good. I had to get nitpicky to find anything to comment on. I wouldn't hold this commit back for any of my nits, just thought I would suggest them in case you wish to do another revision.

cmd/clusterctl/cmd/root.go

jodavis-suse · 2020-05-06T20:51:09Z

docs/book/src/clusterctl/configuration.md

+To have more verbose logs you can use the `-v` flag when running the `clusterctl` and set the level of the logging verbose from 0 to 5.
+
+If you do not want to use the flag every time you issue a command you can set the environment variable `CLUSTERCTL_LOG_LEVEL` or set the variable in the `clusterctl` config file which is located by default at `$HOME/.cluster-api/clusterctl.yaml`.


It may be helpful to have a link to the book at https://cluster-api.sigs.k8s.io/clusterctl/configuration.html for more details.

not clear to me your comment, this piece of the documentation will be in the https://cluster-api.sigs.k8s.io/clusterctl/configuration.html page

Fair point, I should have paid attention to the path of the file. 😅

docs/book/src/clusterctl/configuration.md

fabriziopandini

Two small nits and then lgtm for me as well

cmd/clusterctl/cmd/root.go

wfernandes · 2020-05-08T19:07:25Z

cmd/clusterctl/cmd/root.go

+			if err == nil && v != "" {
+				verbosityFromEnv, err := strconv.Atoi(v)
+				if err != nil {
+					fmt.Printf("Failed to convert CLUSTERCTL_LOG_LEVEL string to an int. err=%s", err.Error())


Add a new line at the end and redirect to os.Stderr.

Suggested change

fmt.Printf("Failed to convert CLUSTERCTL_LOG_LEVEL string to an int. err=%s", err.Error())

fmt.Fprintf(os.Stderr, "Failed to convert CLUSTERCTL_LOG_LEVEL string to an int. err=%s\n", err.Error())

if -v is set it will override the CLUSTERCTL_LOG_LEVEL variable.

cpanato · 2020-05-09T13:51:50Z

/test pull-cluster-api-e2e

cpanato · 2020-05-09T16:03:21Z

/test pull-cluster-api-e2e

k8s-ci-robot · 2020-05-09T16:37:51Z

@cpanato: The following test failed, say /retest to rerun all failed tests:

Test name	Commit	Details	Rerun command
pull-cluster-api-e2e	`0ca8bdf`	link	`/test pull-cluster-api-e2e`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

fabriziopandini

/approve
/lgtm

k8s-ci-robot · 2020-05-09T18:16:08Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cpanato, fabriziopandini

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [fabriziopandini]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 3, 2020

k8s-ci-robot requested review from benmoss and vincepri May 3, 2020 15:57

k8s-ci-robot added the area/clusterctl Issues or PRs related to clusterctl label May 3, 2020

fabriziopandini reviewed May 4, 2020

View reviewed changes

cpanato force-pushed the GH-2957 branch from 6717968 to 0853fc1 Compare May 4, 2020 17:12

wfernandes suggested changes May 5, 2020

View reviewed changes

cmd/clusterctl/cmd/root.go Outdated Show resolved Hide resolved

cmd/clusterctl/cmd/root.go Outdated Show resolved Hide resolved

cmd/clusterctl/cmd/root.go Outdated Show resolved Hide resolved

cpanato force-pushed the GH-2957 branch from 0853fc1 to ca8d82e Compare May 6, 2020 09:40

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 6, 2020

fabriziopandini reviewed May 6, 2020

View reviewed changes

docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved

docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved

cpanato force-pushed the GH-2957 branch 2 times, most recently from 55657de to e76f123 Compare May 6, 2020 14:50

wfernandes reviewed May 6, 2020

View reviewed changes

docs/book/src/clusterctl/configuration.md Outdated Show resolved Hide resolved

k8s-ci-robot assigned wfernandes May 6, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2020

cpanato force-pushed the GH-2957 branch from e76f123 to 6a73873 Compare May 6, 2020 15:51

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2020

jodavis-suse reviewed May 6, 2020

View reviewed changes

cpanato force-pushed the GH-2957 branch from 6a73873 to 33ea05b Compare May 7, 2020 06:54

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 7, 2020

fabriziopandini requested changes May 7, 2020

View reviewed changes

cmd/clusterctl/cmd/root.go Outdated Show resolved Hide resolved

cmd/clusterctl/cmd/root.go Outdated Show resolved Hide resolved

cpanato force-pushed the GH-2957 branch from 33ea05b to 5e34271 Compare May 8, 2020 18:34

wfernandes reviewed May 8, 2020

View reviewed changes

clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable

0ca8bdf

if -v is set it will override the CLUSTERCTL_LOG_LEVEL variable.

cpanato force-pushed the GH-2957 branch from 5e34271 to 0ca8bdf Compare May 9, 2020 13:11

fabriziopandini approved these changes May 9, 2020

View reviewed changes

k8s-ci-robot assigned fabriziopandini May 9, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 9, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 9, 2020

k8s-ci-robot merged commit 98d4619 into kubernetes-sigs:master May 9, 2020

cpanato deleted the GH-2957 branch May 9, 2020 20:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable #2996

✨clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable #2996

cpanato commented May 3, 2020 •

edited

Loading

cpanato commented May 3, 2020

fabriziopandini left a comment

cpanato commented May 4, 2020

fabriziopandini commented May 4, 2020

cpanato commented May 4, 2020 •

edited

Loading

wfernandes commented May 4, 2020

cpanato commented May 4, 2020

cpanato commented May 4, 2020

wfernandes commented May 5, 2020

wfernandes left a comment

cpanato commented May 6, 2020

cpanato commented May 6, 2020

fabriziopandini left a comment

wfernandes commented May 6, 2020

wfernandes commented May 6, 2020

wfernandes commented May 6, 2020

jodavis-suse left a comment

jodavis-suse May 6, 2020

cpanato May 7, 2020

jodavis-suse May 8, 2020

fabriziopandini left a comment

wfernandes May 8, 2020

cpanato May 9, 2020

cpanato commented May 9, 2020

cpanato commented May 9, 2020

k8s-ci-robot commented May 9, 2020

fabriziopandini left a comment

k8s-ci-robot commented May 9, 2020

		To have more verbose logs you can use the `-v` flag when running the `clusterctl` and set the level of the logging verbose from 0 to 5.

		If you do not want to use the flag every time you issue a command you can set the environment variable `CLUSTERCTL_LOG_LEVEL` or set the variable in the `clusterctl` config file which is located by default at `$HOME/.cluster-api/clusterctl.yaml`.

	fmt.Printf("Failed to convert CLUSTERCTL_LOG_LEVEL string to an int. err=%s", err.Error())
	fmt.Fprintf(os.Stderr, "Failed to convert CLUSTERCTL_LOG_LEVEL string to an int. err=%s\n", err.Error())

✨clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable #2996

✨clusterctl: add CLUSTERCTL_LOG_LEVEL environment variable #2996

Conversation

cpanato commented May 3, 2020 • edited Loading

cpanato commented May 3, 2020

fabriziopandini left a comment

Choose a reason for hiding this comment

cpanato commented May 4, 2020

fabriziopandini commented May 4, 2020

cpanato commented May 4, 2020 • edited Loading

wfernandes commented May 4, 2020

cpanato commented May 4, 2020

cpanato commented May 4, 2020

wfernandes commented May 5, 2020

wfernandes left a comment

Choose a reason for hiding this comment

cpanato commented May 6, 2020

cpanato commented May 6, 2020

fabriziopandini left a comment

Choose a reason for hiding this comment

wfernandes commented May 6, 2020

wfernandes commented May 6, 2020

wfernandes commented May 6, 2020

jodavis-suse left a comment

Choose a reason for hiding this comment

jodavis-suse May 6, 2020

Choose a reason for hiding this comment

cpanato May 7, 2020

Choose a reason for hiding this comment

jodavis-suse May 8, 2020

Choose a reason for hiding this comment

fabriziopandini left a comment

Choose a reason for hiding this comment

wfernandes May 8, 2020

Choose a reason for hiding this comment

cpanato May 9, 2020

Choose a reason for hiding this comment

cpanato commented May 9, 2020

cpanato commented May 9, 2020

k8s-ci-robot commented May 9, 2020

fabriziopandini left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 9, 2020

cpanato commented May 3, 2020 •

edited

Loading

cpanato commented May 4, 2020 •

edited

Loading