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.

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

Improve logging #83

Open
CharlieC3 opened this issue Nov 7, 2023 · 0 comments
Open

Improve logging #83

CharlieC3 opened this issue Nov 7, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@CharlieC3
Copy link
Member

The following changes to the logging would have large effects downstream in our observability tools:

  1. Format logs in JSON - This would help our internal infra categorize and sort any keys found in the JSON log.
  2. Implement a logging standard and structure. Using common keys like msg to provide the primary message of a log, and level to provide the logging level, etc would also help the downstream infrastructure.

Without these improvements, logs will be harder to search for and visualize in Grafana. Refer to the Platform API's logging structure for guidance:

{"level":"info","time":1699368500392,"pid":104,"hostname":"<internal_hostname>","reqId":"req-2q7","req":{"method":"GET","url":"/ping","hostname":"<external_hostname>,"remoteAddress":"10.1.130.44","remotePort":51265},"msg":"incoming request"}
@CharlieC3 CharlieC3 added the enhancement New feature or request label Nov 7, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in DevTools Nov 7, 2023
@andresgalante andresgalante moved this from 🆕 New to 📋 Backlog in DevTools Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 📋 Backlog
Development

No branches or pull requests

4 participants