✨ Switch zap log for global hub agent #1184

yanmxa · 2024-10-25T03:40:25Z

Summary

Related issue(s)

Fixes # #1178, https://issues.redhat.com/browse/ACM-13421

Configure the LogLevel at runtime!
Integrate the log format with the third part library - cloudevents, and controller-runtime
The underlayer is based on Zap Logger and SugarLogger, we also provide the zapr if you use the logr interface.
The manifestwork only updates the configmap, the agent deployment will not be updated. Let the operator read the config and propagate it to the configmap in the manifest
Format

2024-10-29T03:43:41.290Z        INFO    utils/utils.go:28       Go OS/Arch: linux/amd64
2024-10-29T03:43:41.290Z        INFO    utils/utils.go:29       Go Version: go1.22.5
2024-10-29T03:43:41.290Z        INFO    utils/utils.go:30       Git Commit: b46e471c
2024-10-29T03:43:41.313Z        INFO    controller-runtime.metrics      server/server.go:208    Starting metrics server
I1029 03:43:41.313460       1 leaderelection.go:254] attempting to acquire leader lease multicluster-global-hub-agent/multicluster-global-hub-agent-lock...
2024-10-29T03:43:41.313Z        INFO    controller-runtime.metrics      server/server.go:247    Serving metrics server  {"bindAddress": "0.0.0.0:8384", "secure": false}
I1029 03:43:41.317722       1 leaderelection.go:268] successfully acquired lease multicluster-global-hub-agent/multicluster-global-hub-agent-lock
2024-10-29T03:43:41.318Z        INFO    controller/controller.go:175    Starting EventSource    {"controller": "secret", "controllerGroup": "", "controllerKind": "Secret", "source": "kind source: *v1.Secret"}
2024-10-29T03:43:41.318Z        INFO    controller/controller.go:183    Starting Controller     {"controller": "secret", "controllerGroup": "", "controllerKind": "Secret"}
2024-10-29T03:43:41.521Z        INFO    controller/controller.go:217    Starting workers        {"controller": "secret", "controllerGroup": "", "controllerKind": "Secret", "worker count": 1}
2024-10-29T03:43:41.521Z        INFO    kafka-consumer  consumer/generic_consumer.go:84 transport consumer with cloudevents-kafka receiver
2024-10-29T03:43:41.525Z        INFO    cloudevents     [email protected]/protocol.go:166   Subscribing to topics: [gh-spec]
2024-10-29T03:43:41.526Z        INFO    cmd/main.go:240 add the init controller to manager

We can see the cloudevents, controller runtime is the same as the format we set. But the lease still uses the klog, which we won't update in this PR. Visit here for more detail about that: kubernetes-sigs/controller-runtime#2656, kubernetes/enhancements#3077

Tests

Unit/function tests have been added and incorporated into make unit-tests.
Integration tests have been added and incorporated into make integration-test.
E2E tests have been added and incorporated into make e2e-test-all.
List other manual tests you have done.

Signed-off-by: myan <[email protected]>

yanmxa · 2024-10-28T09:47:37Z

the environment isn't ready, re run it

/test e2e-test

openshift-ci · 2024-10-28T09:47:41Z

@yanmxa: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test gofmt
/test images
/test sonarcloud
/test test-e2e
/test test-integration
/test test-unit

Use /test all to run all jobs.

In response to this:

the environment isn't ready, re run it

/test e2e-test

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-sigs/prow repository.

yanmxa · 2024-10-28T13:55:03Z

/test test-e2e

yanmxa · 2024-10-28T14:41:55Z

/override ci/prow/sonarcloud

openshift-ci · 2024-10-28T14:42:06Z

@yanmxa: Overrode contexts on behalf of yanmxa: ci/prow/sonarcloud

In response to this:

/override ci/prow/sonarcloud

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-sigs/prow repository.

yanmxa · 2024-10-28T16:01:18Z

setup error

/test test-e2e

yanmxa · 2024-10-29T00:49:37Z

database isn't ready

/test test-e2e

yanmxa · 2024-10-29T01:53:04Z

the kafka cluster is not created

/test test-e2e

Signed-off-by: myan <[email protected]>

sonarqubecloud · 2024-10-29T03:29:40Z

Quality Gate failed

Failed conditions
61.8% Coverage on New Code (required ≥ 70%)

See analysis details on SonarCloud

yanmxa · 2024-10-29T03:45:48Z

/override ci/prow/sonarcloud

openshift-ci · 2024-10-29T03:45:54Z

@yanmxa: Overrode contexts on behalf of yanmxa: ci/prow/sonarcloud

In response to this:

/override ci/prow/sonarcloud

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-sigs/prow repository.

yanmxa · 2024-10-29T04:24:48Z

/cc @clyang82 @ldpliu

clyang82 · 2024-10-29T08:09:55Z

...pkg/controllers/agent/manifests/templates/agent/multicluster-global-hub-agent-configmap.yaml

+  enableLocalPolicies: "{{ .EnableLocalPolicies }}"
+  logLevel: {{.LogLevel}}


where is LogLevel from? I do not see any changes in agent controller to set this value.

The LogLevel is from the operator

The agent updates the LogLevel here: https://github.com/stolostron/multicluster-global-hub/pull/1184/files#diff-1f7a85f8429524557f22db6d08a8d0e48634c4073149d0eee6cc9a821d0e7d77R71-R75

clyang82

Need to have a document about how to change the log level in the runtime environment

yanmxa · 2024-10-29T09:24:33Z

Need to have a document about how to change the log level in the runtime environment

Add the document in this pr: #1188

clyang82 · 2024-10-29T09:29:36Z

/lgtm

openshift-ci · 2024-10-29T09:29:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: clyang82, yanmxa

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~~ [clyang82,yanmxa]

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

openshift-ci bot added dco-signoff: yes approved labels Oct 25, 2024

switch zap log for global hub agent

16571ae

Signed-off-by: myan <[email protected]>

yanmxa force-pushed the br_agent_log branch from b885fff to 16571ae Compare October 25, 2024 03:41

fix the error

e816616

Signed-off-by: myan <[email protected]>

yanmxa force-pushed the br_agent_log branch from 271990e to e816616 Compare October 25, 2024 03:48

yanmxa added 9 commits October 25, 2024 07:57

fix the info

31d1cd1

Signed-off-by: myan <[email protected]>

adjust agent log

fc8fe8e

Signed-off-by: myan <[email protected]>

change the transport

86cf6da

Signed-off-by: myan <[email protected]>

fix the standalone

9525404

Signed-off-by: myan <[email protected]>

add the e2e log

73cf78b

Signed-off-by: myan <[email protected]>

add the controller runtime log with current zap logger

2096539

Signed-off-by: myan <[email protected]>

format code

4efc157

Signed-off-by: myan <[email protected]>

romove the zap parameter from standalone agent

5371638

Signed-off-by: myan <[email protected]>

remove the unnecessary code

b46e471

Signed-off-by: myan <[email protected]>

remove the log print

97c3eec

Signed-off-by: myan <[email protected]>

openshift-ci bot requested review from clyang82 and ldpliu October 29, 2024 04:24

clyang82 reviewed Oct 29, 2024

View reviewed changes

yanmxa mentioned this pull request Oct 29, 2024

📖 Add the document to adjust the log level #1188

Merged

4 tasks

openshift-ci bot assigned clyang82 Oct 29, 2024

openshift-ci bot added the lgtm label Oct 29, 2024

openshift-merge-bot bot merged commit 93d0563 into stolostron:main Oct 29, 2024
14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ Switch zap log for global hub agent #1184

✨ Switch zap log for global hub agent #1184

yanmxa commented Oct 25, 2024 •

edited

Loading

yanmxa commented Oct 28, 2024

openshift-ci bot commented Oct 28, 2024

yanmxa commented Oct 28, 2024

yanmxa commented Oct 28, 2024

openshift-ci bot commented Oct 28, 2024

yanmxa commented Oct 28, 2024

yanmxa commented Oct 29, 2024

yanmxa commented Oct 29, 2024

sonarqubecloud bot commented Oct 29, 2024

yanmxa commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

yanmxa commented Oct 29, 2024

clyang82 Oct 29, 2024

yanmxa Oct 29, 2024

clyang82 left a comment

yanmxa commented Oct 29, 2024

clyang82 commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

		enableLocalPolicies: "{{ .EnableLocalPolicies }}"
		logLevel: {{.LogLevel}}

✨ Switch zap log for global hub agent #1184

✨ Switch zap log for global hub agent #1184

Conversation

yanmxa commented Oct 25, 2024 • edited Loading

Summary

Related issue(s)

Tests

yanmxa commented Oct 28, 2024

openshift-ci bot commented Oct 28, 2024

yanmxa commented Oct 28, 2024

yanmxa commented Oct 28, 2024

openshift-ci bot commented Oct 28, 2024

yanmxa commented Oct 28, 2024

yanmxa commented Oct 29, 2024

yanmxa commented Oct 29, 2024

sonarqubecloud bot commented Oct 29, 2024

Quality Gate failed

yanmxa commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

yanmxa commented Oct 29, 2024

clyang82 Oct 29, 2024

Choose a reason for hiding this comment

yanmxa Oct 29, 2024

Choose a reason for hiding this comment

clyang82 left a comment

Choose a reason for hiding this comment

yanmxa commented Oct 29, 2024

clyang82 commented Oct 29, 2024

openshift-ci bot commented Oct 29, 2024

yanmxa commented Oct 25, 2024 •

edited

Loading