Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Suggestion]: Improve the format of the messages logged #395

Open
1 task done
cmoulliard opened this issue Oct 4, 2024 · 2 comments · May be fixed by #423
Open
1 task done

[Suggestion]: Improve the format of the messages logged #395

cmoulliard opened this issue Oct 4, 2024 · 2 comments · May be fixed by #423
Labels
enhancement New feature or request

Comments

@cmoulliard
Copy link
Contributor

Have you searched for this feature request?

  • I searched but did not find similar requests

Problem Statement

Suggestion

Improve the format of the messages logged which are really long to make them shorter as they :

  • Contain many words. Idea: Add a CR after x chars, etc
  • Include many repetitions:
Example:
Oct  4 10:49:04 INFO Checking if we should shutdown controller=localbuild controllerGroup=idpbuilder.cnoe.io controllerKind=Localbuild name=localdev name=localdev reconcileID=d1f7bb40-15fd-496a-9424-c6ebc8319bcc
Oct  4 10:49:04 INFO installing bootstrap apps to ArgoCD controller=localbuild controllerGroup=idpbuilder.cnoe.io controllerKind=Localbuild name=localdev name=localdev reconcileID=d1f7bb40-15fd-496a-9424-c6ebc8319bcc

Screenshot 2024-10-03 at 18 10 27

Note: In java, we log the messages as such and that improves the readability

__  ____  __  _____   ___  __ ____  ______ 
 --/ __ \/ / / / _ | / _ \/ //_/ / / / __/ 
 -/ /_/ / /_/ / __ |/ , _/ ,< / /_/ /\ \   
--\___\_\____/_/ |_/_/|_/_/|_|\____/___/   
2024-10-04 10:55:19,450 INFO  [io.quarkus] (main) code-with-quarkus 1.0.0-SNAPSHOT on JVM (powered by Quarkus 999-SNAPSHOT) started in 0.477s. Listening on: http://0.0.0.0:8080
2024-10-04 10:55:19,454 INFO  [io.quarkus] (main) Profile prod activated. 
2024-10-04 10:55:19,454 INFO  [io.quarkus] (main) Installed features: [argocd, cdi, kubernetes, rest, smallrye-context-propagation, vertx]
...

Possible Solution

n/a

Alternatives Considered

No response
@cmoulliard cmoulliard added the enhancement New feature or request label Oct 4, 2024
@cmoulliard cmoulliard mentioned this issue Oct 4, 2024
Closed
4 tasks
@nabuskey
Copy link
Collaborator

nabuskey commented Oct 4, 2024

Agreed. I'd like to improve the readability more. Implementation wise, it shouldn't be too difficult because we already have custom logger implemented. Just need format changes.

@cmoulliard
Copy link
Contributor Author

I also notice that some messages are not logged as (I think so) still use Logger.V (see tls.go)

cmoulliard added a commit to ch007m/fork-idpbuilder that referenced this issue Oct 4, 2024
@cmoulliard
Change logger.V(1) to logger.info to log some missing messages. cnoe-…
3942362 
…io#395

Signed-off-by: cmoulliard <[email protected]>
@cmoulliard cmoulliard mentioned this issue Oct 4, 2024
Closed
@nabuskey nabuskey moved this to Backlog in idpbuilder Oct 15, 2024
nimakaviani added a commit to nimakaviani/idpbuilder that referenced this issue Oct 21, 2024
@nimakaviani
modify log format for readability
cd967e5 
fixes cnoe-io#395

Signed-off-by: Nima Kaviani <[email protected]>
@nimakaviani nimakaviani linked a pull request Oct 21, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
idpbuilder
Status: Backlog
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

modify log format for readability nimakaviani/idpbuilder
2 participants
@cmoulliard @nabuskey