com.dynatrace.diagnostics.pdk
Interface Incident


public interface Incident

This interface describes Incidents.

Incidents contain information about Measures and their measurements, the severity of the Incident, the description, start time etc.


Nested Class Summary
static class Incident.Severity
           
 
Field Summary
static int STATE_CLOSE_INCIDENT
          incident has been closed
static int STATE_CREATE_CLOSE_INCIDENT
          incident has been triggered per violation, ..., instantly created and closed
static int STATE_CREATE_INCIDENT
          incident has been created
 
Method Summary
 Duration getDuration()
          Returns the duration of the violation in milliseconds or a value less than 0 if the duration is not available.
 Timestamp getEndTime()
          Returns the Timestamp when the violation ended.
 IncidentRule getIncidentRule()
          Returns the IncidentRule that caused this Incident
 Key getKey()
          Return the unique incident key.
 java.lang.String getMessage()
          Returns the incident message used in client representation.
 java.util.Collection<PurePath> getPurePaths()
          Returns a Collection of Incident related PurePaths
 java.lang.String getRecordedSessionId()
          Returns the ID of the recorded Session
 java.lang.String getRecordedSessionName()
          Returns the Name of the recorded Session
 java.lang.String getServerName()
          Returns the host name and port of the originating dynaTrace Server in the format "host:port" (without quotes).
 Incident.Severity getSeverity()
          Returns the Severity of this Incident
 Timestamp getStartTime()
          Returns the Timestamp when the violation started.
 int getState()
          Returns the incident state.
 java.util.Collection<Violation> getViolations()
          Returns the collection of measures that are involved in the incident including dynamic measures.
 boolean isClosed()
          Returns if the Incident is already closed
 boolean isOpen()
          Returns if the Incident is still open
 

Field Detail

STATE_CREATE_INCIDENT

static final int STATE_CREATE_INCIDENT
incident has been created

See Also:
Constant Field Values

STATE_CLOSE_INCIDENT

static final int STATE_CLOSE_INCIDENT
incident has been closed

See Also:
Constant Field Values

STATE_CREATE_CLOSE_INCIDENT

static final int STATE_CREATE_CLOSE_INCIDENT
incident has been triggered per violation, ..., instantly created and closed

See Also:
Constant Field Values
Method Detail

getServerName

java.lang.String getServerName()
Returns the host name and port of the originating dynaTrace Server in the format "host:port" (without quotes).

Returns:
the host name and port of the server

getMessage

java.lang.String getMessage()
Returns the incident message used in client representation. Do not parse this Message, because it is subject to change!

Returns:
the incident message

getIncidentRule

IncidentRule getIncidentRule()
Returns the IncidentRule that caused this Incident

Returns:
the IncidentRule that caused this Incident

getViolations

java.util.Collection<Violation> getViolations()
Returns the collection of measures that are involved in the incident including dynamic measures. null is returned if it is an incident without measures.

Returns:
a Collection of IncidentMeasures

getRecordedSessionId

java.lang.String getRecordedSessionId()
Returns the ID of the recorded Session

Returns:
the ID of the recorded Session

getRecordedSessionName

java.lang.String getRecordedSessionName()
Returns the Name of the recorded Session

Returns:
the Name of the recorded Session

getStartTime

Timestamp getStartTime()
Returns the Timestamp when the violation started.

Returns:
start Timestamp of the violation

getEndTime

Timestamp getEndTime()
Returns the Timestamp when the violation ended. If the violation has not yet stopped, this value is unavailable.

Returns:
end Timestamp of the violation or null if not available

getDuration

Duration getDuration()
Returns the duration of the violation in milliseconds or a value less than 0 if the duration is not available.

Returns:
duration time in milliseconds, or a value less than 0 if not available
See Also:
getStartTime(), getEndTime()

isOpen

boolean isOpen()
Returns if the Incident is still open

Returns:
if the Incident is open

isClosed

boolean isClosed()
Returns if the Incident is already closed

Returns:
if the Incident is closed

getSeverity

Incident.Severity getSeverity()
Returns the Severity of this Incident

Returns:
the Severity of this Incident

getPurePaths

java.util.Collection<PurePath> getPurePaths()
Returns a Collection of Incident related PurePaths

Returns:
Collection of Incident related PurePaths

getKey

Key getKey()
Return the unique incident key.

Returns:
the incident key

getState

int getState()
Returns the incident state. Possible values are:

Returns:
the incident state


Copyright © 2004-2012 dynaTrace software GmbH