Document prod logging to stderr and the optional 5xx error mail (template #162)
まだ誰も着手していません。
評価
- 難易度
- 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.
- 主要言語
- Vue
- スター
- 0
- フォーク
- 0
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
components-web-app/docs のほかの issue
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
components-web-app/docs#234 ·
-
Document opening the add page data form with defaults (?parentPage, ?parentPageData, ?template)オープンdocumentation
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
components-web-app/docs#230 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
components-web-app/docs#228 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
components-web-app/docs#227 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
components-web-app/docs#235 ·
components-web-app/docs の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
NetAppDocs/ontap#2151 ·
-
documentation
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
nf-core/metaboigniter#132 ·
メンテナーはふだん 1 日以内に返信
-
documentation hacktoberfest priority: low skill: good first issue status: ready for dev
難易度 2/5 半日 初心者へのやさしさ 85/100
hyperledger-labs/fabric-smart-client#2142 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
netbox status: needs owner type: documentation
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
netbox-community/netbox#23412 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信