sdk-server expects SDK_LOG_LEVEL

[KAllan357]

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking

/kind bug

/kind cleanup
/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it:
I think I noticed a bug in my Agones sdk-server where I was constantly seeing the log line:

{"error":"not a valid logrus Level: \"\"","message":"Invalid LOG_LEVEL value. Defaulting to 'info'.","severity":"warning","time":"2024-06-05T13:53:37.5359166-04:00"}

I'm also seeing this in my local K8s cluster running Agones v1.40:

agones-gameserver-sidecar {"error":"not a valid logrus Level: \"\"","message":"Invalid LOG_LEVEL value. Defaulting to 'info'.","severity":"warning","time":"2024-06-05T18:08:05.006261795Z"}

There is a chance this is a bug introduced in #3631. The relevant code in the sdk-server binary is

https://github.com/googleforgames/agones/blob/main/cmd/sdk-server/main.go#L326

runtime.Must(viper.BindEnv("logLevel", "SDK_LOG_LEVEL"))

This PR simply adjusts the name Env Var attached to the Gameserver's Agones SDK Sidecar container.

Which issue(s) this PR fixes:

Closes #

Special notes for your reviewer:

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[KAllan357]

I just signed the CLA but I'm not seeing how to retrigger that.

[agones-bot]

Build Failed 😱

Build Id: 650b4a04-8b10-4a94-bd86-a1ed47bf8791

• Cloud Build view
• Cloud Build log download

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

[markmandel]

Ooh! Good catch. I didn't see that in the PR!

Rather than change Env var settings from what they used to be (should be?), I'd suggest fixing:

agones/cmd/sdk-server/main.go

Line 326 in bc42fd5

runtime.Must(viper.BindEnv("logLevel", "SDK_LOG_LEVEL"))

And setup a proper logLevelFlag variable etc, and make the above line be:

runtime.Must(viper.BindEnv(logLevelFlag))

Then we fix the bug in the sdk-server rather than potentially force an env var change.

Also that default here:

agones/cmd/sdk-server/main.go

Line 290 in bc42fd5

viper.SetDefault("logLevel", string(gs.Spec.SdkServer.LogLevel))

-- that's no good. It should also be "info" 😄

[KAllan357]

@markmandel Thanks for the feedback. I adjusted the PR as you described. Note that I also changed it from "logLevel" to log-level to get Viper to do its thing when the env var is LOG_LEVEL:

$ go run cmd/sdk-server/main.go
{"ctlConf":{"GameServerName":"","PodNamespace":"".....

$ LOG_LEVEL=HOWDY go run cmd/sdk-server/main.go
{"error":"not a valid logrus Level: \"HOWDY\"","message":"Invalid LOG_LEVEL value. Defaulting to 'info'.","severity":"warning","time":"2024-06-06T13:22:19.982728509-04:00"}
{"ctlConf":{"GameServerName":"","PodNamespace":"" .....

[agones-bot]

Build Succeeded 👏

Build Id: d7c19b02-40d8-42ff-a5e0-de7979746ad4

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.42.0-dev-9cbf6d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.42.0-dev-9cbf6d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.42.0-dev-9cbf6d1-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.42.0-dev-9cbf6d1-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.42.0-dev-9cbf6d1-amd64
• Linux C++ SDK (build): agonessdk-1.42.0-dev-9cbf6d1-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.42.0-dev-9cbf6d1-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://9cbf6d1-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3858/head:pr_3858 && git checkout pr_3858
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-9cbf6d1-amd64

[markmandel]

Thanks! Sounds good - will take a peek next week 👍🏻

[agones-bot]

Build Succeeded 👏

Build Id: e2117b2f-d5e6-4c20-ae6a-c494b8d45828

The following development artifacts have been built, and will exist for the next 30 days:

• image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.42.0-dev-8827a56-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.42.0-dev-8827a56-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.42.0-dev-8827a56-linux-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.42.0-dev-8827a56-amd64
• image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.42.0-dev-8827a56-amd64
• Linux C++ SDK (build): agonessdk-1.42.0-dev-8827a56-amd64-linux-arch_64.tar.gz
• SDK Server: agonessdk-server-1.42.0-dev-8827a56-amd64.zip

A preview of the website (the last 30 builds are retained):

• https://8827a56-dot-preview-dot-agones-images.appspot.com/

To install this version:

• git fetch https://github.com/googleforgames/agones.git pull/3858/head:pr_3858 && git checkout pr_3858
• helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.42.0-dev-8827a56-amd64

[markmandel]

Looks great, thanks!

[Shavakan]

We also faced a similar issue recently and ended up in this PR.
@markmandel I hope I don't sound pushing, but could you kindly inform me when this fix will likely be released?