hirosystems / hirosystems/stacks-devnet-api

Improve logging

Đang mở
#83 0 bình luận 0 reaction 2 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

enhancement
Ngôn ngữ chính
Rust
Star
2
Fork
0
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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"}

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.