Establish a standard logging format through this library, with the ability to customize
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 12/100
- Issue 類型
- 功能
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
The payload names the existing dockerflow.logging.MozlogHandler and a proposed generic dockerflow.logging.DefaultHandler, selected by a DOCKERFLOW_LOGGING_FORMAT environment variable. The first step is to read the current logging handlers in the package and see how the Mozlog format is built. The issue leaves the class name ('real name tbd') and the supported format values open, so a contributor would first need a maintainer decision on the design before any code change.
由索引模型根據 Issue 內容生成。
描述
Though we want to add the ability to emit logs in the format that's most useful for engineers (see #111), we also want to promote a standard logging format to reduce the cognitive overhead of switching between projects and provide the ability to more-easily search for logs that span multiple services.
The idea would be that instead of encouraging engineers to reference a format-specific class in their logging configuration (e.g. dockerflow.logging.MozlogHandler or google.cloud.logging.handlers.StructuredLogHandler), we can establish a generic class name like:
'console': {
'class': 'dockerflow.logging.DefaultHandler', #real name tbd
},
with some sort of ability to configure the class through an environment variable, like:
os.getenv("DOCKERFLOW_LOGGING_FORMAT", "MOZLOG")
With this setup, engineers have the freedom to:
- accept the default format of
DefaultHandleras the "current logging format standard of Mozilla".- maintainers of this library can change the format of
DefaultHandlerin accordance with the current logging standard of Mozilla, and if engineers only care about aligning with Mozilla's standard logging format, they'll automatically be compliant with the standard when they update this library
- maintainers of this library can change the format of
- override the standard format to another commonly used format through environment configuration, like
export DOCKERFLOW_LOGGING_FORMAT=GCP
- still (of course) have the ability to fully customize their logging setup by referencing specific logging handlers, formatters, and filters
- 主要語言
- Python
- 星號
- 41
- 分支
- 21
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
mozilla-services/python-dockerflow 的其他 Issue
-
難度 3/5 半天 新手友好度 15/100
mozilla-services/python-dockerflow#119 · 1 則留言 ·
-
難度 2/5 1 小時以內 新手友好度 15/100
mozilla-services/python-dockerflow#117 · 1 則留言 ·
-
難度 5/5 一週以上 新手友好度 15/100
mozilla-services/python-dockerflow#116 · 1 則留言 ·
-
難度 3/5 半天 新手友好度 62/100
-
難度 3/5 1-2 天 新手友好度 35/100
查看 mozilla-services/python-dockerflow 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 82/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 70/100
onyx-dot-app/onyx#16016 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
black --check exits 0 and prints All done when a multi file run is interrupted可能已有人在做 @jiteshgulati 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 2 天內回覆
-
Non-positive worker counts wait for results without starting workers可能已有人在做 @IlyaKhalafi 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 85/100
維護者通常 1 天內回覆