telemetry/logging: share the slog setup every service builds by hand
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- go
調査の方向性
Start with the existing telemetry/logging package and the dependent work in #359, then compare the logging implementations named in the issue: openndx-core internal/logging, nsw-srilanka internal/bootstrap/logging.go, and agency backend/internal/logging. Review openndx-core#708 for its logging rules and tests. Done means a shared setup covers the listed configuration, trace IDs, optional OTLP export with level filtering, common service attributes, and the default logger and correlation ID wiring; several design decisions and consumer migrations remain.
索引モデルが issue の本文から書いたものです。
説明
Current Limitation
Every OpenNSW service builds its slog setup by hand. All of them build the same chain: base handler → trace ID decorator → (optional) OTLP export → slog.SetDefault → httputil.CorrelationIDFunc. Each one does it a little differently:
openndx-core internal/logging |
nsw-srilanka internal/bootstrap/logging.go |
agency backend/internal/logging |
|
|---|---|---|---|
| Level from config | logging.level |
server.logLevel |
Not configurable |
| Format | json or text, configurable |
text only |
json only |
service / environment / version on every line |
Yes | No | No |
Trace ID decorator (trace/logging) |
No | Yes | Yes |
httputil.CorrelationIDFunc wired |
No | Yes | Yes |
OTLP log export (otelslog + slog.NewMultiHandler) |
No | Yes | No |
Level filter in front of otelslog |
— | Yes | — |
AddSource at debug |
No | Yes | No |
So:
- A combined log stream can't be filtered by service, because only one of the three adds
service, and its value isn't tied to the OTelservice.name. - Fixes stay where they were found. nsw-srilanka found that
otelslogreports every level as enabled, so behindslog.NewMultiHandlerthe multi-handler'sEnabledis true for DEBUG even when the configured level is INFO. DEBUG records were exported and debug-gated payload logging turned on. ItslevelFilterfixes this. Any other service that adds OTLP log export will hit the same bug. - Config keys and defaults differ (
logging.levelvsserver.logLevel,jsonvstext), so operators configure each service differently.
Suggested Improvement
Add the logging setup to telemetry/logging, beside the trace_id / span_id decorator from #359.
package logging // github.com/OpenNSW/core/telemetry/logging
// Config is the logging section of a service's config file.
type Config struct {
// Level is debug, info, warn or error. Default info.
Level string `yaml:"level"`
// Format is json or text. Default json.
Format string `yaml:"format"`
}
// DefaultConfig returns the values used for keys the config file leaves out.
func DefaultConfig() Config
// Validate reports an unknown level or format.
func (c Config) Validate() error
// Setup builds the logger, sets it as slog's default and returns it. cfg must be valid.
func Setup(cfg Config, p *telemetry.Provider) *slog.Logger
// NewHandler adds trace_id and span_id from the span in ctx (#359).
func NewHandler(next slog.Handler) slog.Handler
Setup builds:
slog.JSONHandlerorslog.TextHandleron stdout, atcfg.Level, withAddSourceat debugNewHandleraround it, fortrace_id/span_id- When
pexports logs over OTLP:p.SlogHandler()behind a level filter andNewHandler, fanned out withslog.NewMultiHandler service,environmentandversionattributes, taken from the same values as theProvider's resource (service.name,deployment.environment,service.version), so the log field and the OTel attribute can't driftslog.SetDefault, andhttputil.CorrelationIDFunc = telemetry.TraceID
Each main then has:
p, err := telemetry.Start(ctx, cfg.Telemetry)
// ...
logging.Setup(cfg.Logging, p)
Service-specific behavior stays in the service, such as nsw-srilanka's warning that audit records are suppressed above info.
Consumers to migrate
- openndx/openndx-core:
internal/logging(openndx/openndx-core#708) is deleted, andcmd/<service>/main.gocallslogging.Setup. - OpenNSW/nsw-srilanka:
internal/bootstrap/logging.go, includinglevelFilter.server.logLeveleither moves to aloggingsection or is mapped intologging.Configby its config code. - OpenNSW/agency:
backend/internal/logging.
Decisions to settle in review
- Default format:
json(openndx-core, agency) ortext(nsw-srilanka). Suggestjsonfor production, since log pipelines parse it. - Config key:
logging.level/logging.formatas one section, or leave each service to map its own keys intoConfig. - Is
Setupusable without telemetry? For example withp == nilit writes stdout only and adds no trace IDs. Or does every service starttelemetryfirst?
Version
github.com/OpenNSW/core/trace v0.2.0
Additional Context
- Depends on #359 for
telemetry.Provider,telemetry.TraceIDandtelemetry/logging.NewHandler. - openndx/openndx-core#708 has a description of openndx's logging rules (one setup, one global logger,
...Contextcalls, common fields). Itsinternal/loggingpackage is the starting point forConfig,Validateand the common fields.
- 主要言語
- Go
- スター
- 6
- フォーク
- 8
- 平均マージ
- 21時間 36分
- マージ済み PR(30日)
- 42
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
OpenNSW/core のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信
-
payment: test fixtures hardcode real gateway names (govpay/lankapay) instead of generic placeholdersオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
nsw-sl cleanup Type/Improvement
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
メンテナーはふだん 1 日以内に返信
-
remote: let the host inject a logger, and log with one consistent policy対応中かも @mushrafmim が 5 日前に担当しました。 オープンType/Improvement
難易度 4/5 3〜5日 初心者へのやさしさ 22/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
agent-research-finding chore
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
jordansmall/spindrift#7370 ·
メンテナーはふだん 1 日以内に返信
-
☢️ Bug v3
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
The repo's gates check is clean and runs need no swaps対応中かも @turbot-agent-fleet が今日担当しました。 オープンagent:ready
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
turbot/tailpipe#677 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
needs-kind needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
crossplane-contrib/provider-keycloak#806 ·
メンテナーはふだん 1 日以内に返信