Sphyrnidae.Common.Logging.LoggerInformation Class Reference

Retrieves logging information from the API request/http More...

Inheritance diagram for Sphyrnidae.Common.Logging.LoggerInformation:

Public Member Functions
	LoggerInformation (IHttpClientSettings httpSettings, IIdentityHelper identity, IRequestData requestData)

Properties
IHttpClientSettings	HttpSettings [get]
IIdentityHelper	IdentityHelper [get]
IRequestData	RequestData [get]
string	LogOrderPrefix [get]
	If provided in the HTTP header More...
string	RequestId [get]
	If provided in the HTTP header, otherwise will be a unique ID More...
char	LoggingOrder [get, set]
	Stores the order/sequence of logging statement within the current call More...
BaseIdentity	Identity [get]
	The current identity on the request More...
string	SessionId [get]
	If provided in the HTTP header More...
string	Method [get]
	API endpoint information: <verb> <route> More...
virtual Dictionary< string, string >	StaticProperties [get]
	Can override in inherited class for any custom properties More...
Properties inherited from Sphyrnidae.Common.Logging.Interfaces.ILoggerInformation
string	LogOrderPrefix [get]
	This prefix will help you so that you can order all of your log statements across multiple applications More...
string	RequestId [get]
	The ID for the request (or run-time execution) More...
char	LoggingOrder [get, set]
	The current logging order for the current application More...
BaseIdentity	Identity [get]
	The identity of the user executing the call (can be null, but certain logging properties will also be null) More...
string	SessionId [get]
	The ID associated with a group of calls More...
string	Method [get]
	The method being executed (Eg. POST /api/v1/MyRoute) More...
Dictionary< string, string >	StaticProperties [get]
	Any custom additional properties that will be saved as options to be logged More...

Detailed Description

Retrieves logging information from the API request/http

Constructor & Destructor Documentation

LoggerInformation()

Sphyrnidae.Common.Logging.LoggerInformation.LoggerInformation	(	IHttpClientSettings	httpSettings,
		IIdentityHelper	identity,
		IRequestData	requestData
	)

Property Documentation

HttpSettings

IHttpClientSettings Sphyrnidae.Common.Logging.LoggerInformation.HttpSettings

getprotected

Identity

BaseIdentity Sphyrnidae.Common.Logging.LoggerInformation.Identity

get

The current identity on the request

IdentityHelper

IIdentityHelper Sphyrnidae.Common.Logging.LoggerInformation.IdentityHelper

getprotected

LoggingOrder

char Sphyrnidae.Common.Logging.LoggerInformation.LoggingOrder

getset

Stores the order/sequence of logging statement within the current call

This class is transient, so this will forward it on to a scoped class

LogOrderPrefix

string Sphyrnidae.Common.Logging.LoggerInformation.LogOrderPrefix

get

If provided in the HTTP header

Method

string Sphyrnidae.Common.Logging.LoggerInformation.Method

get

API endpoint information: <verb> <route>

RequestData

IRequestData Sphyrnidae.Common.Logging.LoggerInformation.RequestData

getprotected

RequestId

string Sphyrnidae.Common.Logging.LoggerInformation.RequestId

get

If provided in the HTTP header, otherwise will be a unique ID

SessionId

string Sphyrnidae.Common.Logging.LoggerInformation.SessionId

get

If provided in the HTTP header

StaticProperties

virtual Dictionary<string, string> Sphyrnidae.Common.Logging.LoggerInformation.StaticProperties

get

Can override in inherited class for any custom properties

---

The documentation for this class was generated from the following file:

• C:/Users/dougb/Desktop/Sphyrnidae/New/Common/Common/Logging/LoggerInformation.cs