Skip to content

Commit 58f67e5

Browse files
committed
Update README.md
1 parent 9a2ae0e commit 58f67e5

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Library for Stackify users to integrate Stackify in to their projects. Provides support for sending errors, logs, and custom metrics to Stackify. Also some support for querying metric data back out of Stackify for use in external projects.
44

5-
**Important Links:**
6-
- [Homepage](http://www.stackify.com)
7-
- [Documentation](http://docs.stackify.com/s/3095/m/7787)
5+
**Important links:**
6+
- [Stackify homepage](http://www.stackify.com)
7+
- [Stackify documentation site](http://docs.stackify.com/s/3095/m/7787)
88
- [NuGet packages](https://www.nuget.org/packages?q=Stackify)
99

1010
**Read me sections:**
@@ -28,6 +28,7 @@ Features
2828
- Can be plugged in to custom built or other logging frameworks
2929
- Does not depend on the Stackify monitoring agent. All data is sent directly to Stackify.
3030

31+
The packages for log4net, NLog and Elmah all depend on StackifyLib. StackifyLib also has support for custom metrics and accessing some of Stackify's API to pull data back out.
3132

3233
The following is required in your App.config or Web.config:
3334

@@ -70,6 +71,11 @@ If you log an object with the message, Stackify's log viewer makes it easy to se
7071

7172
###NLog 2.0.1.2 - v3.1+
7273

74+
**Install via NuGet package**
75+
```
76+
PM> Install-Package StackifyLib.NLog
77+
```
78+
7379
Nuget packages are compiled against 2.0.1.2 but any newer version (including v3) will work with a valid assembly binding redirect.
7480

7581
<dependentAssembly>
@@ -107,7 +113,13 @@ Options
107113
- logMethodNames - Method names will show up in the StackifyLog viewer most of the time as the class name that did the logging. For exceptions it will usually show the method name. To enable the exact method name for all logging, set this property to true. Note that it does cause a small performance hit due to walking the StackTrace.
108114

109115
###log4net v2.0+ (v1.2.11+)
110-
Note: Nuget packages are compiled against 2.0.0 (1.2.11) but any newer version will work with a valid assembly binding redirect. log4net 2.0.3 is actually 1.2.13 which makes the binding redirect look strange.
116+
117+
**Install via NuGet package**
118+
```
119+
PM> Install-Package StackifyLib.log4net
120+
```
121+
122+
Note: Nuget packages are compiled against 2.0.0 (1.2.11) but any newer version will work with a valid assembly binding redirect. log4net 2.0.3 is actually 1.2.13 which makes the binding redirect look strange.
111123

112124
<dependentAssembly>
113125
<assemblyIdentity name="log4net" publicKeyToken="669e0ddf0bb1aa2a" culture="neutral" />
@@ -161,11 +173,22 @@ log4net does not internally have methods for logging a log message along with an
161173
logger.Debug("Starting some process for client 1", dictionary); //extension method
162174

163175
###log4net v1.2.10
176+
177+
**Install via NuGet package**
178+
```
179+
PM> Install-Package StackifyLib.log4net.v1_2_10
180+
```
181+
164182
Note: If you use 1.2.10 then you must use our special nuget package for that version. There is no way to use an assembly redirect because the public key of log4net v1 and v2 are different. Everything else is the same about using log4net with Stackify.
165183

166184

167185
###Direct API
168186

187+
**Install via NuGet package**
188+
```
189+
PM> Install-Package StackifyLib
190+
```
191+
169192
If you use a custom logging framework or a framework not currently supported, you can easily send logs to Stackify with our core library and API like so:
170193

171194
StackifyLib.Logger.Queue("DEBUG", "My log message");

0 commit comments

Comments
 (0)