 | LogActivity Structure |
Namespace: Neon.Diagnostics
Assembly: Neon.Common (in Neon.Common.dll) Version: 2.3.2
SyntaxThe LogActivity type exposes the following members.
Properties
Methods| Name | Description | |
|---|---|---|
  | Create |
Creates a log activity with a new globally unique ID.
|
| Critical(Object) |
Logs a critical message.
|
| Critical(Object, Exception) |
Logs a critical message along with exception information.
|
| Debug(Object) |
Logs a debug message.
|
| Debug(Object, Exception) |
Logs a debug message along with exception information.
|
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
| Error(Object) |
Logs an error message.
|
| Error(Object, Exception) |
Logs an error message along with exception information.
|
| From |
Creates a log activity with the ID specified.
|
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Info(Object) |
Logs an info message.
|
| Info(Object, Exception) |
Logs an info message along with exception information.
|
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
| Warn(Object) |
Logs a warn message.
|
| Warn(Object, Exception) |
Logs a warn message along with exception information.
|
Fields| Name | Description | |
|---|---|---|
 | HttpHeader |
Names the HTTP header used to hold the activity ID used to correlate
operation requests with a higher-level activity.
|
RemarksThis structure is intended to help operators and developers correlate lower-level operations with higher level activities that may span multiple systems and services.
The essential idea is to associate a globally unique ID with a high-level activity and then include this ID along with events logged by the various systems and services that participate in the activity. Ultimately, the logged events with the activity IDs will make it to Elasticsearch or some other log database where activaty events potentially spanning many systems can be correlated and analyzed.
An activity ID is simply a globally unique ID string. IDs generated by this class are a currently stringified Guid but IDs may take other forms so, don't depend on this.
In general, activity IDs are passed from service to service via the HTTP X-Request-ID request header (defined by HttpHeader).
To use this type, call the static Create(INeonLogger) method to create a new activity or From(String, INeonLogger) to associate an instance with an existing activity. Then use the various logging methods to emit log events what will include the activity ID.
See Also