Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SffLogLog4j ConfiguredResultComments
sff.log=disabled,silentYESNo Logs
  1. If sff.log is marked disabled; No logs are generated. Silent or loud does not matter.
  2. Please note that few message may be printed while the service is getting initialized.
sff.log=enabled,silentYES; sff.log.level="INFO"Only INFO Level log statements as specified in log4j appender

Absolutely no log file at all 

sff.log=enabled,loudYES; sff.log.level="INFO"INFO, ERROR and WARN statements are printed in logNote that sff.log.level is passed into rootLogger value of Log4j configurationAdmin
sff.log=enabled,loudYES; sff.log.level="DEBUG"INFO, ERROR, WARN, DEBUG statements are printed in log

sff.log=enabled,loud

sff.log.trace=enabled

YES; sff.log.level="TRACE"Trace will be enabled; Trace allows you to view Protocol level details for exampleThis is how trace can be enabled.

Logging Cost

  1. Note that Log statements that has Template Processing (TP) in message will be evaluated independent of the level. 
  2. Note the only TP will be processed but Strings will NOT be generated if level is not enabled.
  3. There is a potential to optimize not to perform TP based on level as well. (Enhancement)

...

  • sff.log.broadcast.<log level name> which defines one or more facet IDs used for log broadcasting. That is:
    •  <sff.log.broadcast.error>[:MyErrorsFacet:]</sff.log.broadcast.error> - This one will broadcast log error messages to [randomized] [:MyErrorsFacet:] fid 
    • <sff.log.broadcast.all>wstest</sff.log.broadcast.all> - This one will log messages to wstest fid.
      You can specify more than one fid as comma-separated list.
    • Known Log levels are
      1. text
      2. trace
      3. debug
      4. info
      5. warn
      6. error
      7. fatal
      8. all
  • sff.log.broadcast.protocol. Default value is “ws,wss”. This is the list of protocols which will be used to select broadcast pipelines. That is, it will *not* broadcast on HTTP connections, for example. When broadcast is enabled, startup will log the list of protocols so you know it was enabled. Obviously, it will *not* print the list of facet IDs used for broadcast.

  • sff.log.broadcast.message. This is log message definition. It may come in different forms:

    • <sff.log.broadcast.message>json<sff.log.broadcast.message> This simplest form allows you to define log message type (e.g. xml or json). Default is xml.

  • Default message in JSON format will look like this:

    Code Block
    languagetext
    titleDefault Message
    linenumberstrue
    {
      "Log":
      {
        "Level":"WARN",
        "Source":"SffSequenceFacet",
        "Timestamp":1479334740055,
        "Message":"startSchedularForMonitorStatus:MonitorStatus 1:0 @ Wed Nov 16 14:19:00 PST 2016: Scheduled: skip past (-55 ms) event for Wed Nov 16 14:19:00 PST 2016 [0../30sec]"
      }
    }

    In XML Format:

    Code Block
    languagexml
    titleDefault Message
    linenumberstrue
    <Log>
      <Level>WARN</Level>
      <Source>SffSequenceFacet</Source>
      <Timestamp>1479334740055<Timestamp>
      <Message>startSchedularForMonitorStatus:MonitorStatus 1:0 @ Wed Nov 16 14:19:00 PST 2016: Scheduled: skip past (-55 ms) event for Wed Nov 16 14:19:00 PST 2016 [0../30sec]</Message>
    </Log>

    In CDM Format:

    Code Block
    languagexml
    titleDefault Message
    linenumberstrue
    #
    Log:
      Level: WARN
      Source: SffSequenceFacet
      Timestamp: 1479334740055
      Message: "startSchedularForMonitorStatus:MonitorStatus 1:0 @ Wed Nov 16 14:19:00 PST 2016: Scheduled: skip past (-55 ms) event for Wed Nov 16 14:19:00 PST 2016 [0../30sec]"


    Log messages are automatically added to the logger window on TQLConsole

Application Monitoring Using Broadcast Facet

...