[New article]: Detailed docs for Microsoft.Extensions.Telemetry

オープン
#48,910 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
csharp
領域
documentation

調査の方向性

docs/core/extensions、Microsoft.Extensions.Telemetry および Microsoft.Extensions.Telemetry.Abstractions のソースディレクトリ、ならびに参照されている Telemetry Logging sample から始めます。リンクされている記事を読んで、[LogProperties] と [TagProvider] についての背景を確認します。これらの型、アノテーション、効果的な使用方法、代表的なサンプルを網羅した明確な公式ドキュメントを公開すれば完了です。

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

説明

:watch: Not Triaged
Proposed topic or title

Logging extensions

Location in table of contents.

docs/core/extensions

Reason for the article

Currently, there are no docs with details about using the Microsoft.Extensions.Telemetry library effectively.

https://andrewlock.net/behind-logproperties-and-the-new-telemetry-logging-source-generator/ is linked to from the official docs (here https://learn.microsoft.com/en-us/aspnet/core/fundamentals/logging/)
and https://andrewlock.net/customising-the-new-telemetry-logging-source-generator/ covers more of the new source-generator.

By having these docs on the official https://learn.microsoft.com/ website, we'll be able to leverage AI further to use these best practices via the Microsoft Learn MCP

there are some docs on https://github.com/dotnet/extensions/tree/main/src/Libraries/Microsoft.Extensions.Telemetry & https://github.com/dotnet/extensions/tree/main/src/Libraries/Microsoft.Extensions.Telemetry.Abstractions

specifically missing docs about the types and annotations:

Relevant searches

https://github.com/search?q=org%3Adotnet%20%22%5BLogProperties%22&type=code

there are some great samples - https://github.com/dotnet/extensions-samples/tree/aaae284846366e5c122b2760c4060712b862c060/src/Telemetry/Logging


Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

主要言語
言語のデータがありません
スター
4.8k
フォーク
6.1k
平均マージ
22時間 46分
マージ済み PR(30日)
296

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

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

dotnet/docs のほかの issue

dotnet/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

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

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