Reintroduce PR #5974: Remove klogr dependency and move to zap by aliaqel-stripe · Pull Request #6578 · kedacore/keda

aliaqel-stripe · 2025-02-28T22:02:16Z

Reintroducing #5794

This PR reintroduces the above PR to refactor metrics-server to use zap instead of klogr. This not only removes the deprecated dependency but it also enables for JSON logging, a frequently requested feature in the metrics server.

To provide backward compatibility with existing tests and charts, I added handling for the three klogr flags KEDA exposes in helm charts. I translate the verbosity flag to the zap equivalent, but I treat the other flags as no-ops.

I also updated the dev container protoc version so that it does not overwrite the protoc version used to generate proto.

Additionally, I have

Updated documentation: Update docs to outline how to set zap log settings in KEDA keda-docs#1543
Updated Helm: Update helm charts to support zap logging in metrics server charts#741

I ran locally and validated logs to console work:

2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	Starting metrics server
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	KEDA Version: main
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	Git Commit: 5c08467753257d76d62a1eccffd70327a8284f9f
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	Go Version: go1.23.8
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	Go OS/Arch: linux/arm64
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	Running on Kubernetes 1.30	{"version": "v1.30.3"}
2025-04-21T02:46:41.710Z	INFO	keda_metrics_adapter	maxprocs: Updating GOMAXPROCS=1: determined from CPU quota
2025-04-21T02:46:41.711Z	INFO	keda_metrics_adapter	Connecting Metrics Service gRPC client to the server	{"address": "..."}
2025-04-21T02:46:41.717Z	INFO	keda_metrics_adapter.provider	starting
2025-04-21T02:46:41.717Z	INFO	keda_metrics_adapter	starting adapter...
2025-04-21T02:46:41.735Z	INFO	keda_metrics_adapter.provider	Waiting for establishing a gRPC connection to KEDA Metrics Server
2025-04-21T02:46:41.735Z	INFO	keda_metrics_adapter	starting /metrics server endpoint
...
2025-04-21T02:46:42.235Z	INFO	keda_metrics_adapter.provider	Connection to KEDA Metrics Service gRPC server has been successfully established	{"server": "..."}

and then validated I can log in json:

{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Starting metrics server"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"KEDA Version: main"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Git Commit: 670eb91693c139a90df21320b92144952196eb31"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Go Version: go1.23.8"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Go OS/Arch: linux/arm64"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Running on Kubernetes 1.30","version":"v1.30.3"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"maxprocs: Updating GOMAXPROCS=1: determined from CPU quota"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"Connecting Metrics Service gRPC client to the server","address":"..."}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter.provider","msg":"starting"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"starting adapter..."}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter.provider","msg":"Waiting for establishing a gRPC connection to KEDA Metrics Server"}
{"level":"info","ts":"2025-04-21T00:31:40Z","logger":"keda_metrics_adapter","msg":"starting /metrics server endpoint"}
I0421 00:31:41.217266      15 secure_serving.go:213] Serving securely on [::]:6443
I0421 00:31:41.217321      15 requestheader_controller.go:172] Starting RequestHeaderAuthRequestController
I0421 00:31:41.217331      15 shared_informer.go:313] Waiting for caches to sync for RequestHeaderAuthRequestController
I0421 00:31:41.217363      15 dynamic_serving_content.go:135] "Starting controller" name="serving-cert::/certs/tls.crt::/certs/tls.key"
I0421 00:31:41.217471      15 tlsconfig.go:243] "Starting DynamicServingCertificateController"
...
...
{"level":"info","ts":"2025-04-21T00:31:41Z","logger":"keda_metrics_adapter.provider","msg":"Connection to KEDA Metrics Service gRPC server has been successfully established","server":"..."}

Checklist

I have verified that my change is according to the deprecations & breaking changes policy
Changelog has been updated and is aligned with our changelog requirements
A PR is opened to update our Helm chart (repo) (if applicable, ie. when deployment manifests are modified)
A PR is opened to update the documentation on (repo) (if applicable)
Commits are signed with Developer Certificate of Origin (DCO - learn more)

Fixes #5732 , #4049

Relates to #741, #1543

semgrep-app · 2025-02-28T22:03:33Z

Semgrep found 1 no-sudo-in-dockerfile finding:

.devcontainer/Dockerfile
- L20-81 - Triage

Avoid using sudo in Dockerfiles. Running processes as a non-root user can help reduce the potential impact of configuration errors and security vulnerabilities.

zroubalik

In general, this is great.

My concern is backwards compatibilty, we are changing the way to setup this. I wonder if there's a way how to bypass this, maybe internally convert the "old" params to the new one?

lucasfcnunes · 2025-03-27T13:00:20Z

In general, this is great.

My concern is backwards compatibilty, we are changing the way to setup this. I wonder if there's a way how to bypass this, maybe internally convert the "old" params to the new one?

Yep. That's how it needs to be.

aliaqel-stripe · 2025-04-21T01:21:27Z

@zroubalik @lucasfcnunes I added handling for the legacy klogr flags KEDA exposes through Helm and converted them to zap options to the extent that it made sense. Tested them locally on our setup without modifying flags (i.e use the existing klogr flags) and verified logging works and the metrics-server starts up.

zroubalik · 2025-04-24T16:04:15Z