Package org.pentaho.di.core.logging

Interface LogChannelInterface

  • All Known Implementing Classes:
    LogChannel
    public interface LogChannelInterface

    • Method Detail

      • getLogChannelId

        String getLogChannelId()
        Returns:
        the id of the logging channel

      • setLogLevel

        void setLogLevel​(LogLevel logLevel)

      • getContainerObjectId

        String getContainerObjectId()
        Returns:
        the containerObjectId

      • setContainerObjectId

        void setContainerObjectId​(String containerObjectId)
        Parameters:
        containerObjectId - the containerObjectId to set

      • getFilter

        String getFilter()

      • setFilter

        void setFilter​(String filter)

      • isBasic

        boolean isBasic()

      • isDetailed

        boolean isDetailed()

      • isDebug

        boolean isDebug()

      • isRowLevel

        boolean isRowLevel()

      • isError

        boolean isError()

      • logMinimal

        void logMinimal​(String message)

      • logMinimal

        void logMinimal​(String message,
                Object... arguments)

      • logBasic

        void logBasic​(String message)

      • logBasic

        void logBasic​(String message,
              Object... arguments)

      • logDetailed

        void logDetailed​(String message)

      • logDetailed

        void logDetailed​(String message,
                 Object... arguments)

      • logDebug

        void logDebug​(String message)

      • logDebug

        void logDebug​(String message,
              Object... arguments)

      • logRowlevel

        void logRowlevel​(String message)

      • logRowlevel

        void logRowlevel​(String message,
                 Object... arguments)

      • logError

        void logError​(String message)

      • logError

        void logError​(String message,
              Object... arguments)

      • isGatheringMetrics

        boolean isGatheringMetrics()

      • setGatheringMetrics

        void setGatheringMetrics​(boolean gatheringMetrics)

      • setForcingSeparateLogging

        void setForcingSeparateLogging​(boolean forcingSeparateLogging)
        This option will force the create of a separate logging channel even if the logging concerns identical objects with identical names.
        Parameters:
        forcingSeparateLogging - Set to true to force separate logging

      • isForcingSeparateLogging

        boolean isForcingSeparateLogging()
        Returns:
        True if the logging is forcibly separated out from even identical objects.

      • snap

        void snap​(MetricsInterface metric,
          long... value)
        Add a snapshot to the metrics system for this log channel at the time of invocation. This will process the value depending on the type of metric specified. For example, for MetricsInterface.look up the maximum value in the metrics and replace it if the new value is higher. The snapshot date will be retained in that case.
        Parameters:
        metric - The metric to use (ex. connect to a database)
        value - the value to store

      • snap

        void snap​(MetricsInterface metric,
          String subject,
          long... value)
        Add a maximum snapshot to the metrics system for this log channel at the time of invocation. This will look up the maximum value in the metrics and replace it if the new value is higher. The snapshot date will be retained in that case.
        Parameters:
        metric - The metric to use (ex. connect to a database)
        subject - The subject (ex. the name of the database)
        value - the value to store