Package com.kosdev.kos.core.service.log

Class LogOverride

java.lang.Object
com.kosdev.kos.core.service.log.LogOverride
public class LogOverride extends Object
Log level override definition. Log overrides are scoped to node types. That is, an override applied to a node type and all KOS nodes of that type will have the override applied. This provides some granularity in log overrides as they don't apply to the entire device.

The type property defines what the override applies to. Types are defined as colon-separated strings that match a particular type of logging. For example, java log overrides use the following types:

  • java:class: Applies the override to a particular java class or package.
  • java:group: Applies the override to a particular Log group.
Blink connections that implement the kos.logging iface can support log overrides. To override log levels for a blink connection, the type should be blink:{logType}, where the type is provided by the device as part of the iface. This allows log overrides to be specified for each distinct blink connection type.

Finally, the level is desired log level to apply and may be relative to the receiving logger implementation. In java the values should be the standard TRACE, DEBUG, INFO, WARN, FATAL values. For C or other languages, the level may be defined as needed.

When used with blink loggers, the log level is converted to a numeric value using one of the LEVEL_XXX constants. Any string that doesn't match a known level will be converted to LEVEL_INFO.

Since:
1
Version:
9

  • Field Details

  • Constructor Details

    • LogOverride

      public LogOverride()

  • Method Details

    • setLevel

      public void setLevel(String level)
      Set the level of the override. The supplied string will be converted to uppercase and mapped to one of the known levels. If there is no match, the value will be converted to INFO .
      Since:
      1

    • getLevelName

      public static String getLevelName(int val)
      Return the log level name for the specified level value.
      Since:
      9

    • getLevelName

      public static String getLevelName(String name)
      Return the normalized log level name for the specified level name.
      Since:
      9

    • getLevelVal

      public static int getLevelVal(String name)
      Return the log level value for the specified level name.
      Since:
      9

    • getLevelVal

      public static int getLevelVal(int val)
      Return the normalized log level value for the specified value.
      Since:
      9

    • getNodeType

      public String getNodeType()
      The nodeType this override should apply to.

    • getType

      public String getType()
      The type of override to apply. One of the TYPE_XXX constants in this class.

    • getName

      public String getName()
      The class / package / group name.

    • getLevel

      public String getLevel()
      The log level to use: TRACE, DEBUG, INFO, etc...

    • setNodeType

      public void setNodeType(String nodeType)
      The nodeType this override should apply to.

    • setType

      public void setType(String type)
      The type of override to apply. One of the TYPE_XXX constants in this class.

    • setName

      public void setName(String name)
      The class / package / group name.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object