Skip to content

Commit bace882

Browse files
authored
[Editorial] add ToC to logging/metrics docs (#5298)
1 parent 0ee3eb1 commit bace882

File tree

3 files changed

+36
-2
lines changed

3 files changed

+36
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ If you are new here, please read the getting started docs:
3333
* [Logs](./docs/logs/README.md): [ASP.NET
3434
Core](./docs/logs/getting-started-aspnetcore/README.md) |
3535
[Console](./docs/logs/getting-started-console/README.md)
36-
* Metrics: [ASP.NET Core](./docs/metrics/getting-started-aspnetcore/README.md) |
36+
* [Metrics](./docs/metrics/README.md): [ASP.NET
37+
Core](./docs/metrics/getting-started-aspnetcore/README.md) |
3738
[Console](./docs/metrics/getting-started-console/README.md)
38-
* Traces: [ASP.NET Core](./docs/trace/getting-started-aspnetcore/README.md) |
39+
* [Traces](./docs/trace/README.md): [ASP.NET
40+
Core](./docs/trace/getting-started-aspnetcore/README.md) |
3941
[Console](./docs/trace/getting-started-console/README.md)
4042

4143
This repository includes multiple installable components, available on

docs/logs/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# OpenTelemetry .NET Logs
22

3+
<!-- markdownlint-disable MD033 -->
4+
<details>
5+
<summary>Table of Contents</summary>
6+
7+
* [Best Practices](#best-practices)
8+
* [Package Version](#package-version)
9+
* [Logging API](#logging-api)
10+
* [Logger Management](#logger-management)
11+
* [Log Correlation](#log-correlation)
12+
* [Log Enrichment](#log-enrichment)
13+
* [Log Filtering](#log-filtering)
14+
* [Log Redaction](#log-redaction)
15+
16+
</details>
17+
<!-- markdownlint-enable MD033 -->
18+
319
## Best Practices
420

521
The following tutorials have demonstrated the best practices for logging with

docs/metrics/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# OpenTelemetry .NET Metrics
22

3+
<!-- markdownlint-disable MD033 -->
4+
<details>
5+
<summary>Table of Contents</summary>
6+
7+
* [Best Practices](#best-practices)
8+
* [Package Version](#package-version)
9+
* [Metrics API](#metrics-api)
10+
* [MeterProvider Management](#meterprovider-management)
11+
* [Memory Management](#memory-management)
12+
* [Pre-Aggregation](#pre-aggregation)
13+
* [Cardinality Limits](#cardinality-limits)
14+
* [Memory Preallocation](#memory-preallocation)
15+
16+
</details>
17+
<!-- markdownlint-enable MD033 -->
18+
319
## Best Practices
420

521
The following tutorials have demonstrated the best practices for while using

0 commit comments

Comments
 (0)