Package com.attivio.sdk.client.audit

Interface AuditClientSummary

  • All Superinterfaces:
    java.io.Serializable
    public interface AuditClientSummary
extends java.io.Serializable
    Summary statistics for a client ingestion. These statistics represent a point in time and can be retrieved during or after a client completes. Document counts such as completion, fails, etc. include both documents fed by the client and child documents generated on the server.

    $Revision$

    • Method Detail

      • getFirstActionTime

        java.util.Date getFirstActionTime()
        Note, this time is approximate. When many nodes are simultaneously adding audit information, this number may be slightly (limited by multi-host clock drift) off. It is intended for display and status purposes only.
        Returns:
        the time of the first action associated with the client

      • getLastActionTime

        java.util.Date getLastActionTime()
        Whenever a counter is updated that affects these statistics, the time of that update is recorded. This method returns the time of the latest such update. Note, this time is approximate. When many nodes are simultaneously adding audit information, this number may be slightly (limited by multi-host clock drift) off. It is intended for display and status purposes only.
        Returns:
        the latest time associated with information in the summary detail

      • getInactiveTime

        java.util.Date getInactiveTime()
        Returns the time the client was made inactive by a call to AuditWriterApi.makeInactive(UUID). Should always return null if the client is currently active.
        Returns:
        the time the client was made inactive or null if active.

      • getClientId

        java.util.UUID getClientId()
        Returns:
        the clientId

      • getDocumentAdds

        long getDocumentAdds()
        Returns:
        the number of documents sent in by the client.

      • getChildDocumentAdds

        long getChildDocumentAdds()
        Returns:
        the number of documents added on the server due to child document generation and extraction.

      • getCompletedCount

        long getCompletedCount()
        Returns:
        the number of documents which have completed processing.

      • getOkCount

        long getOkCount()
        May include multiple counts per document.
        Returns:
        the number of OK audit records for the client.

      • getWarningCount

        long getWarningCount()
        May include multiple counts per document.
        Returns:
        the number of WARN audit records for the client.

      • getFailureCount

        long getFailureCount()
        May include multiple counts per document.
        Returns:
        the number of FAIL audit records for the client.

      • getDropCount

        long getDropCount()
        May include multiple counts per document.
        Returns:
        the number of DROP audit records for the client.

      • getNotHandledCount

        long getNotHandledCount()
        May include multiple counts per document.
        Returns:
        the number of NOT_HANDLED audit records for the client.

      • getLostCount

        long getLostCount()
        Documents and message are marked as LOST due to node crashes and system errors. LOST items will be refed automatically by the system.
        Returns:
        the number of LOST audit records for the client.

      • getRefeedCount

        long getRefeedCount()
        Documents and records are marked as REFEED when Attivio's fault tolerant mechanisms have refed a LOST document.
        Returns:
        the number of REFEED audit records for the client.

      • getFoundCount

        long getFoundCount()
        Documents or messages subsequently discovered to be incorrectly marked as LOST are rebalanced using FOUNDs
        Returns:
        number of documents

      • isComplete

        boolean isComplete()
        Since the summary represents a moment in time, this method's return value will never change. When fault-tolerance is active, LOST documents are not counted towards completion since they are expected to be refed. When fault-tolerance is off, LOST documents and messages are treated the same as DROPPED ones.
        Returns:
        true if there are no outstanding requests (documentAdds + childDocumentAdds + foundCount == completedCount + dropCount + lost) represented in this summary.

      • getFirstSequenceId

        long getFirstSequenceId()
        Returns:
        the sequence ID of the last first record which contributed to this summary.

      • getLastSequenceId

        long getLastSequenceId()
        Returns:
        the sequence ID of the last audit record which contributed to this summary.

      • getSentMessageCounts

        java.util.Map<java.lang.String,​java.lang.Long> getSentMessageCounts()
        Returns:
        a Map of message class to the count of how many have been sent

      • getCompletedMessageCounts

        java.util.Map<java.lang.String,​java.lang.Long> getCompletedMessageCounts()
        Returns:
        a Map of message class to the count of how many have completed processing

      • getDroppedMessageCounts

        java.util.Map<java.lang.String,​java.lang.Long> getDroppedMessageCounts()
        Returns:
        a Map of message class to the count of how many have been dropped

      • getLostMessageCounts

        java.util.Map<java.lang.String,​java.lang.Long> getLostMessageCounts()
        Returns:
        a Map of message class to the count of how many have been lost

      • getFoundMessageCounts

        java.util.Map<java.lang.String,​java.lang.Long> getFoundMessageCounts()
        Returns:
        a Map of message class to the count of how many have been lost