Yodiwo.API.Plegma.IncidentDescriptor Class Reference

Descriptor class for Edge Node Incidents (crashes, unexpected restarts, etc) More...

Public Types
enum	eSeverity {   eSeverity.Emergency = 0, eSeverity.Alert, eSeverity.Critical, eSeverity.Error,   eSeverity.Warning, eSeverity.Notice, eSeverity.Informational, eSeverity.Debug }
	Severity levels enum More...

Public Member Functions
	IncidentDescriptor ()
	incident constructor More...
virtual string	GetStaskTrace ()
virtual string	ToMarkup (Markup.eType type)
override string	ToString ()

Public Attributes
ulong	Timestamp
	timestamp in msec since Unix Epoch. Allowed to be empty More...
string	FilePath
	optional file path of entity producing the incident More...
string	FileName
	optional file name of entity producing the incident More...
string	Method
	optional name of method/function producing the incident More...
int	LineNumber
	optional line number of code producing the incident More...
string	Platform
	optional name of platform running More...
string	Tags
	comma separated Tag cloud More...
string	Sender
	ID of sender More...
string	StackTrace
	newline-separated (although not enforced) stack trace of incident More...
List< ConfigParameter >	Parameters
	one or more name-value pairs with extra, custom, information More...
List< string >	Messages
	one or more messages describing incident More...
eSeverity	Severity
	Severity of incident (follows Unix Syslog levels), eSeverity More...
string	UserAgent
	optional User Agent string for client side errors More...

Properties
bool	IsFailure [get]
bool	IsEmergency [get]
bool	IsAlert [get]
bool	IsCritical [get]
bool	IsError [get]
bool	IsWarning [get]
bool	IsNotice [get]
bool	IsInfo [get]
bool	IsDebug [get]
virtual bool	HasStackTrace [get]

Detailed Description

Descriptor class for Edge Node Incidents (crashes, unexpected restarts, etc)

Member Enumeration Documentation

enum Yodiwo.API.Plegma.IncidentDescriptor.eSeverity

strong

Severity levels enum

Enumerator
Emergency	System is unusable
Alert	Should be corrected immediately
Critical	Critical conditions, primary function failures
Error	Error conditions, limits exceeded, improper behavior
Warning	May indicate unexpected behavior or that an error will occur if action is not taken
Notice	Signify events that are unusual, but not necessarily error conditions
Informational	Normal operational messages that require no action.
Debug	Information useful to developers for debugging the application

Constructor & Destructor Documentation

Yodiwo.API.Plegma.IncidentDescriptor.IncidentDescriptor

(

)

incident constructor

Member Data Documentation

string Yodiwo.API.Plegma.IncidentDescriptor.FileName

optional file name of entity producing the incident

string Yodiwo.API.Plegma.IncidentDescriptor.FilePath

optional file path of entity producing the incident

int Yodiwo.API.Plegma.IncidentDescriptor.LineNumber

optional line number of code producing the incident

List<string> Yodiwo.API.Plegma.IncidentDescriptor.Messages

one or more messages describing incident

string Yodiwo.API.Plegma.IncidentDescriptor.Method

optional name of method/function producing the incident

List<ConfigParameter> Yodiwo.API.Plegma.IncidentDescriptor.Parameters

one or more name-value pairs with extra, custom, information

string Yodiwo.API.Plegma.IncidentDescriptor.Platform

optional name of platform running

string Yodiwo.API.Plegma.IncidentDescriptor.Sender

ID of sender

eSeverity Yodiwo.API.Plegma.IncidentDescriptor.Severity

Severity of incident (follows Unix Syslog levels), eSeverity

string Yodiwo.API.Plegma.IncidentDescriptor.StackTrace

newline-separated (although not enforced) stack trace of incident

string Yodiwo.API.Plegma.IncidentDescriptor.Tags

comma separated Tag cloud

ulong Yodiwo.API.Plegma.IncidentDescriptor.Timestamp

timestamp in msec since Unix Epoch. Allowed to be empty

string Yodiwo.API.Plegma.IncidentDescriptor.UserAgent

optional User Agent string for client side errors

---

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

• c:/DEV/sw_3.0.x/Yodiwo/APIs/Plegma/Descriptors/IncidentDescriptor.cs