Add remarks about EventSource.GetGuid #5209
Conversation
…EventSource.Guid property
|
I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label. |
|
Docs Build status updates of commit 3f6d621:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Diagnostics.Tracing/EventSource.xml | View | Details |
xml/System.Diagnostics.Tracing/EventSource.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.Tracing.EventSource.GetGuid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.Tracing.EventSource.GetGuid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.Tracing.EventSource.GetGuid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.Tracing.EventSource.GetGuid'.
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 in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
|
Docs Build status updates of commit 6ea0afb: ✅ Validation status: passed
For more details, please refer to the build report. 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. For any questions, please:
|
|
Docs Build status updates of commit c41ee8d:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| xml/System.Diagnostics.Tracing/EventSource.xml | View | Details |
xml/System.Diagnostics.Tracing/EventSource.xml
- Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.EventSource.Guid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.EventSource.Guid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.EventSource.Guid'. - Line 0, Column 0: [Warning-xref-not-found]
Cross reference not found: 'System.Diagnostics.EventSource.Guid'.
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 in the Docs contributor and Admin Guide
- See the frequently asked questions
- Post your question in the Docs support channel
|
Docs Build status updates of commit b981b14: ✅ Validation status: passed
For more details, please refer to the build report. 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. For any questions, please:
|
|
Docs Build status updates of commit dfb6c97: ✅ Validation status: passed
For more details, please refer to the build report. 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. For any questions, please:
|
| Specifying `settings` when the <xref:System.Diagnostics.Tracing.EventSource> is constructed enables you to specify whether the event is written in a manifest-based or a self-describing format. In addition, you can specify that an exception should be raised when an error occurs during the event-writing process. | ||
| When using this constructor, ensure that the `eventSourceName` argument matches the ETW name defined by the <xref:System.Diagnostics.Tracing.EventSourceAttribute> attribute on that type. Otherwise, the GUIDs returned by the <xref:System.Diagnostics.Tracing.EventSource.Guid> property and the <xref:System.Diagnostics.Tracing.EventSource.GetGuid(System.Type)> method will be different. |
There was a problem hiding this comment.
This constructor doesn't have an eventSourceName parameter, so this will have to be reworded a bit.
Co-authored-by: Genevieve Warren <[email protected]>
|
Docs Build status updates of commit 02e4375: 🕙 Pending: waiting for processors (21 builds ahead of you) |
Co-authored-by: Genevieve Warren <[email protected]>
|
Docs Build status updates of commit 5dd2b8e: 🕙 Pending: waiting for processors (20 builds ahead of you) |
|
Docs Build status updates of commit f57c4ea: 🕙 Pending: waiting for processors (18 builds ahead of you) |
|
Docs Build status updates of commit 02e4375: ✅ Validation status: passed
For more details, please refer to the build report. 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. For any questions, please:
|
|
Docs Build status updates of commit 5dd2b8e: ✅ Validation status: passed
For more details, please refer to the build report. 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. For any questions, please:
|
10 participants
Summary
EventSource.GetGuid(Type)can return a different value fromEventSource.Guid- this PR adds remarks in the constructor that can cause this to happen.Fixes dotnet/runtime#1360.
Part of dotnet/diagnostics#515.