Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Document prod logging to stderr and the optional 5xx error mail (template #162)

Đã đóng
  • Có gì không ổn?
#233 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
kubernetes, php
Lĩnh vực
documentation, observability

Hướng nghiên cứu

The facts come from the upstream template change 8bfb0d4 and its prod/monolog.yaml and tests/Unit/Monolog/ProdLogRedactionTest.php, so read those first to confirm the behaviour. The edits go in content/6.deployment/7.troubleshooting.md (logs on stderr, redaction, kubectl logs) and content/6.deployment/4.variables.md (CWA_API_ERROR_MAIL_TO). Done when both pages describe the new behaviour and the variable is listed with the other CWA_API_* settings. Coordinate with docs#232 before merging.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Template change in components-web-app 8bfb0d4's parent (Unreleased; the next release after 2.0.0-alpha.33).

  • Logs: prod writes Google-structured JSON to stderr, not var/log/prod.log. Read them with kubectl logs or the cluster's log explorer (GKE: Cloud Logging, where severity, channel and context are queryable fields). They're redacted: email addresses, JWTs and Authorization values, DSN credentials, bcrypt hashes, and the username and token segments of the email-link URLs. Fit for content/6.deployment/7.troubleshooting.md and the Kubernetes page.
  • Error mail: set the CI variable CWA_API_ERROR_MAIL_TO (with a working MAILER_DSN) to get one email per unique 5xx per hour. The subject is "WEBSITE_NAME API error". Empty sends none. Add it to content/6.deployment/4.variables.md with the other CWA_API_* settings.
  • Browser tests: they now fail a run that sends an error mail. Add this alongside docs#232.
  • For projects: anything new that logs a secret or an email address needs a key or pattern in prod/monolog.yaml, and tests/Unit/Monolog/ProdLogRedactionTest.php covers it.
Ngôn ngữ chính
Vue
Star
0
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của components-web-app/docs

Tất cả issue của components-web-app/docs

Issue tương tự

Thêm issue về Documentation

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.