mirror of
https://github.com/VSadov/Satori.git
synced 2025-06-08 11:37:04 +09:00
9900dfb4b2
* Move files into hierarchy * fix more links * Fix botr and features links * Remove bad apostrophe * spelling * Apply suggestions from code review Co-Authored-By: Youssef Victor <31348972+Youssef1313@users.noreply.github.com> * Update docs/coding-guidelines/package-projects.md Co-Authored-By: Jan Kotas <jkotas@microsoft.com> Co-authored-by: Youssef Victor <31348972+Youssef1313@users.noreply.github.com> Co-authored-by: Jan Kotas <jkotas@microsoft.com>
19 lines
1.6 KiB
Markdown
19 lines
1.6 KiB
Markdown
# CoreClr Event Logging Design
|
||
|
||
## Introduction
|
||
|
||
Event Logging is a mechanism by which CoreClr can provide a variety of information on it's state. This Logging works by inserting explicit logging calls by the developer within the VM . The Event Logging mechanism is largely based on [ETW- Event Tracing For Windows](https://msdn.microsoft.com/en-us/library/windows/desktop/bb968803(v=vs.85).aspx)
|
||
|
||
# Adding Events to the Runtime
|
||
|
||
- Edit the [Event manifest](../../src/coreclr/src/vm/ClrEtwAll.man) to add a new event. For guidelines on adding new events, take a look at the existing events in the manifest and this guide for [ETW Manifests](https://msdn.microsoft.com/en-us/library/dd996930%28v=vs.85%29.aspx?f=255&MSPPError=-2147217396).
|
||
- The build system should automatically generate the required artifacts for the added events.
|
||
- Add entries in the [exclusion list](../../src/coreclr/src/vm/ClrEtwAllMeta.lst) if necessary
|
||
- The Event Logging Mechanism provides the following two functions, which can be used within the VM:
|
||
- **FireEtw**EventName, this is used to trigger the event
|
||
- **EventEnabled**EventName, this is used to see if any consumer has subscribed to this event
|
||
|
||
|
||
# Adding New Logging System
|
||
|
||
Though the the Event logging system was designed for ETW, the build system provides a mechanism, basically an [adapter script- genEventing.py](../../src/coreclr/src/scripts/genEventing.py) so that other Logging System can be added and used by CoreClr. An Example of such an extension for [LTTng logging system](https://lttng.org/) can be found in [genLttngProvider.py](../../src/coreclr/src/scripts/genLttngProvider.py )
|