Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package logging
    Definition Classes
    csw
  • package client

    This is a Actor based logging library which supports writing logs to File and StdOut Console.

    Logging Service

    This is a Actor based logging library which supports writing logs to File and StdOut Console.

    Features
    • Supports component specific log levels, ex. HCD1 can choose to log at info level and HCD2 can choose to log at debug level
    • Supports dynamically changing component log levels
    • Asynchronous thread safe logging
    • Structured logging
    • Supports overriding default logging properties per component viz
    • Intercepting logs from akka/slf4j
    • Supports JSON logging
    LogActor

    LogActor is the heart of logging library. It receives messages from following classes:

    • Slf4jAppender: Intercepts Slf4j logs and forwards it to LogActor via MessageHandler
    • AkkaLogger: Intercepts Akka logs and forwards it to LogActor via MessageHandler.
    • LoggerImpl: Provides csw logging API for component writer to log messages which gets forwarded to LogActor via MessageHandler
    Logging Appenders

    This library supports two types of csw.logging.client.appenders.LogAppender:

    You can specify the appender in application.conf file as shown below:

    csw-logging {
   appenders = ["csw.logging.client.appenders.StdOutAppender$", "csw.logging.client.appenders.FileAppender$"]
 }
    Component Specific Log Levels

    For each component, ComponentLoggingState instance gets created which maintains log levels which are enabled and disabled for this particular component. Every time message gets logged by component, LoggerImpl checks in corresponding componentLoggingState whether current log level enabled or not. If enabled, then only log message gets forwarded to LogActor via MessageHandler.

    You can specify the component specific log levels in application.conf file as shown below:

    component-log-levels {
   tromboneHcd = debug
   tromboneAssembly = error
}

    ̄ Detailed documentation of Logging Service is available at: https://tmtsoftware.github.io/csw/services/logging.html

    Definition Classes
    logging
  • package appenders
    Definition Classes
    client
  • package cbor
    Definition Classes
    client
  • package commons
    Definition Classes
    client
  • package exceptions
    Definition Classes
    client
  • AppenderNotFoundException
  • BaseLogPathNotDefined
  • package internal
    Definition Classes
    client
  • package javadsl
    Definition Classes
    client
  • package scaladsl
    Definition Classes
    client
p

csw.logging.client

exceptions

package exceptions

Type Members

  1. case class AppenderNotFoundException(appender: String) extends RuntimeException with Product with Serializable

    As part of spawning the LoggingSystem, it looks for appenders (e.g.

    As part of spawning the LoggingSystem, it looks for appenders (e.g. FileAppender, StdOutAppender, etc.) and tries to instantiate it via reflection. In this process if any exception is encountered then AppenderNotFoundException is thrown.

    appender

    the name of appender that failed to instantiate

  2. case class BaseLogPathNotDefined(basePathHolder: String) extends RuntimeException with Product with Serializable

    This exception is thrown when TMT_LOG_HOME is not set as environment variable

    This exception is thrown when TMT_LOG_HOME is not set as environment variable

    basePathHolder

    name of environment variable where log files would be stored i.e. TMT_LOG_PATH

Ungrouped