hirosystems / hirosystems/stacks-devnet-api

Improve logging

Open
#83 0 comments 0 reactions 2 assignees Assigned to @csgui View on GitHub
enhancement
Dominant language
Rust
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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":"","reqId":"req-2q7","req":{"method":"GET","url":"/ping","hostname":","remoteAddress":"10.1.130.44","remotePort":51265},"msg":"incoming request"}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.