You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*Thor Generator (ThorGen) is a generator for ETW (Event Tracing for Windows) event sources which helps avoid frequent mistakes and and saves time.*
5
+
*Thor Generator (ThorGen) is a generator for ETW (Event Tracing for Windows) event sources which helps avoid frequent mistakes and saves time.*
6
6
7
-
Microsoft's Event Tracing for Windows is a powerfull tracing framwork that offers minimal overhead and structured payloads.
7
+
Microsoft's Event Tracing for Windows is a powerful tracing framework that offers minimal overhead and structured payloads.
8
8
9
9
The problem with writing event sources is often that you have to work with unsafe code and that if you get anything wrong in your event source it won't write events at all. This behaviour is a feature of ETW, applications shall not be disrupted by faulty event sources, so your event source won't log but it also won't throw exceptions that crash your application.
10
10
11
11
The other problem with writing event sources is that one has to invest a lot of time into writing repetitive code "just" to have some "logging" in an application. It is not seldom that teams do not want to invest that time and opt for a simpler string based logging solution waiving all the benefits of ETW.
12
12
13
-
The ThorGen wants to solve these problems by generating the nescesarry event source code and letting developers focus on designing their tracing events around their business logic. ThorGen makes ETW easy to use and fast to implement.
13
+
ThorGen wants to solve these problems by generating the necessary event source code and letting developers focus on designing their tracing events around their business logic. ThorGen makes ETW easy to use and fast to implement.
14
14
15
15
Event sources will be specified by writing interfaces that define the trace events and their payloads (no other DSL needed, no context switch). The event source generator will inspect those interfaces and generate the necessary event source code.
16
16
17
17
The event source templates can be amended to fit your needs and your aesthetic point of view concerning the generated code.
18
18
19
-
At the moment we offer two built-in templates to generate event sources in c#.
19
+
At the moment, we offer two built-in templates to generate event sources in c#.
20
20
21
21
## Get Thor Generator
22
22
@@ -30,13 +30,13 @@ We provide a nuget package that will integrate ThorGen with your project rather
30
30
Install-Package Thor.Generator
31
31
```
32
32
33
-
2. With classic .net projects we will inject ThorGen into your project file and run ThorGen for this project before every build. With the new MSBuild projects used for .net core our package will be located in the global package cache. You can then either integrate our MSBuild task into your projects or use the esgen console from your build scripts.
33
+
2. With classic .net projects we will inject ThorGen into your project file and run ThorGen for this project before every build. With the new MSBuild projects used for .net core our package will be located in the global package cache. You can then either integrate our MSBuild task into your projects or use the ThorGen console from your build scripts.
34
34
35
35
We have a walk through for both scenarious [here](https://github.com/ChilliCream/thor-generator-docs/blob/master/README.md).
36
36
37
37
### Windows
38
38
39
-
If you opt to install esgen on windows you can use chocolatey.
39
+
If you opt to install ThorGen on windows you can use chocolatey.
40
40
41
41
```powershell
42
42
choco install Thor.Generator
@@ -77,7 +77,7 @@ If you are using the msbuild integration of ThorGen just compile your project; o
77
77
thorgen
78
78
```
79
79
80
-
Or run ```thorgen -r``` if you want esgen to search recursively for any solution.
80
+
Or run ```thorgen -r``` if you want ThorGen to search recursively for any solution.
81
81
82
82
For a more detailed help that shows all the scenarious visit our [documentation](https://github.com/ChilliCream/thor-generator-docs/blob/master/README.md).
0 commit comments