humacli logging on stderr per default

オープン
  • 何か問題がありますか？
#809 コメント 5 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
静か
技術スタック
go
領域
cli

調査の方向性

humacli/humacli.go の 301 行目付近にある Shutdown hook から始め、デフォルトの停止メッセージが os.Stderr にどのように書き込まれているかを確認します。issue の議論を踏まえ、ライブラリがその出力を削除すべきか、ロギングインターフェース経由にすべきかを判断します。構造化ロギングのユーザーが不要なデフォルトの stderr メッセージを受け取らず、シャットダウンが引き続き正常に完了すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

question

Currently the humacli Shutdown hook logs on os.Stderr per default: https://github.com/danielgtaylor/huma/blob/6bfeebae55ed05e1e909041c5e3692dc168cd066/humacli/humacli.go#L301

This kind of breaks our logging setup where we use structured JSON logging. I don't really see a benefit in letting the library log this, clients can easily do this themselves:

		hooks.OnStop(func() {
			logger.Info("Stopping server")

			ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
			defer cancel()

			if err := server.Shutdown(ctx); err != nil {
				logger.Error("Error shutting down server", slog.String("error", err.Error()))
			}
		})

Would you be open to an MR for removing the fmt.Fprintln, or replacing it with a logging interface? I'd be happy to provide a PR.

主要言語
Go
スター
4.5k
フォーク
299
平均マージ
3日 6時間
マージ済み PR（30日）
19

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

danielgtaylor/huma のほかの issue

danielgtaylor/huma の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。