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

未关闭
#48,910 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
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 分钟
30 天内合并 PR
296

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

dotnet/docs 的其他 Issue

查看 dotnet/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。