Document prod logging to stderr and the optional 5xx error mail (template #162)
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 半天
- 新手友好度
- 55/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- kubernetes, php
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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 withkubectl logsor 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 forcontent/6.deployment/7.troubleshooting.mdand the Kubernetes page. - Error mail: set the CI variable
CWA_API_ERROR_MAIL_TO(with a workingMAILER_DSN) to get one email per unique 5xx per hour. The subject is "WEBSITE_NAMEAPI error". Empty sends none. Add it tocontent/6.deployment/4.variables.mdwith the otherCWA_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, andtests/Unit/Monolog/ProdLogRedactionTest.phpcovers it.
- 主要语言
- TypeScript
- 星标
- 0
- 派生
- 0
- 平均合并
- 1 小时 20 分钟
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
components-web-app/docs 的其他 Issue
-
documentation
难度 4/5 3-5 天 新手友好度 43/100
components-web-app/docs#285 ·
-
documentation
难度 4/5 1-2 天 新手友好度 35/100
components-web-app/docs#284 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 52/100
components-web-app/docs#283 ·
-
documentation
难度 5/5 一周以上 新手友好度 25/100
components-web-app/docs#282 ·
-
documentation
难度 4/5 3-5 天 新手友好度 35/100
components-web-app/docs#281 ·
查看 components-web-app/docs 的全部 Issue
相似的 Issue
-
area: repo priority: P2 type: bug
难度 2/5 1-3 小时 新手友好度 76/100
appandflow/stim#4107 · 1 条评论 ·
维护者通常 1 天内回复
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
难度 1/5 1-3 小时 新手友好度 60/100
lingdojo/kana-dojo#32859 · 1 条评论 · 5 个 reaction ·
维护者通常 1 天内回复
-
code-quality refactoring
难度 2/5 1-3 小时 新手友好度 78/100
github/gh-aw-firewall#10364 ·
维护者通常 1 天内回复
-
Merge the duplicate kaffir_corn record into sorghum可能已有人在做 @Crypto-Shroom 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 65/100
Crypto-Shroom/Bird-Feed-Calculator#322 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
drizzle-team/drizzle-orm#6552 ·
维护者通常 2 天内回复