System.Diagnostics.Meter API documentation

[tommcdon]

Summary

System.Diagnostics.Meter API documentation

Partially addresses #dotnet/runtime/issues/58654

[ghost]

Tagging subscribers to this area: @tommcdon, @krwq
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Summary

System.Diagnostics.Meter API documentation

Partially addresses #dotnet/runtime/issues/58654

Author:	tommcdon
Assignees:	-
Labels:	area-System.Diagnostics
Milestone:	-

[carlossanlop]

Some suggestions for you to consider.

[carlossanlop]

LGTM.
Not sure why the CI is complaining that it can't find the M:System.Diagnostics.Metrics.ObservableCounter\1.Observe`. Your changes didn't even touch those crefs. I'm inclined to think they are false positives.

[opbld33]

Docs Build status updates of commit 40a4ec8:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Diagnostics.Metrics/Meter.xml	⚠️Warning	View	Details
xml/System.Diagnostics.Metrics/Counter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Histogram`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Instrument`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Measurement`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeterListener.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableCounter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml	✅Succeeded	View
xml/ns-System.Diagnostics.Metrics.xml	✅Succeeded	View

xml/System.Diagnostics.Metrics/Meter.xml

• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

• Try searching the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[opbld33]

Docs Build status updates of commit 0f3077c:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Diagnostics.Metrics/Meter.xml	⚠️Warning	View	Details
xml/System.Diagnostics.Metrics/Counter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Histogram`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Instrument`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Measurement`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeterListener.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableCounter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml	✅Succeeded	View
xml/ns-System.Diagnostics.Metrics.xml	✅Succeeded	View

xml/System.Diagnostics.Metrics/Meter.xml

• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

• Try searching the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[gewarren]

LGTM.
Not sure why the CI is complaining that it can't find the M:System.Diagnostics.Metrics.ObservableCounter\1.Observe`. Your changes didn't even touch those crefs. I'm inclined to think they are false positives.

This was fixed in main by #7089.

[gewarren]

I left some suggestions.

[opbld31]

Docs Build status updates of commit 2fc0840:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Diagnostics.Metrics/Meter.xml	⚠️Warning	View	Details
xml/System.Diagnostics.Metrics/Counter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Histogram`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Instrument`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Measurement`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeterListener.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableCounter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml	✅Succeeded	View
xml/ns-System.Diagnostics.Metrics.xml	✅Succeeded	View

xml/System.Diagnostics.Metrics/Meter.xml

• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

• Try searching the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[opbld31]

Docs Build status updates of commit 2b8205e:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
xml/System.Diagnostics.Metrics/Meter.xml	⚠️Warning	View	Details
xml/System.Diagnostics.Metrics/Counter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Histogram`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Instrument`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeasurementCallback`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/Measurement`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/MeterListener.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableCounter`1.xml	✅Succeeded	View
xml/System.Diagnostics.Metrics/ObservableInstrument`1.xml	✅Succeeded	View
xml/ns-System.Diagnostics.Metrics.xml	✅Succeeded	View

xml/System.Diagnostics.Metrics/Meter.xml

• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.
• Line 0, Column 0: [Warning-xref-not-found] Cross reference not found: 'System.Diagnostics.Metrics.ObservableCounter`1.Observe'.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

• Try searching the docs.microsoft.com contributor guides
• Post your question in the Docs support channel

[carlossanlop]

@gewarren the crefs causing the warnings look good to me, but they are not being resolved in the Preview. Do you see what's wrong with them?

[gewarren]

@gewarren the crefs causing the warnings look good to me, but they are not being resolved in the Preview. Do you see what's wrong with them?

It's fixed in main. The problem is that Observe is an override method in a public sealed class, and protected members of public sealed classes aren't shown in the API docs. So the cross reference causes a warning. I fixed it by just code fencing it instead of making it a cref.