aace::logger::config::LoggerConfiguration Class Reference

Public Types
using	Level = aace::logger::LoggerEngineInterface::Level

Static Public Member Functions
static std::shared_ptr< aace::core::config::EngineConfiguration >	createConsoleSinkConfig (const std::string &id, Level level)
static std::shared_ptr< aace::core::config::EngineConfiguration >	createSyslogSinkConfig (const std::string &id, Level level)
static std::shared_ptr< aace::core::config::EngineConfiguration >	createFileSinkConfig (const std::string &id, Level level, const std::string &path, const std::string &prefix="aace", uint32_t maxSize=5242880, uint32_t maxFiles=3, bool append=true)
static std::shared_ptr< aace::core::config::EngineConfiguration >	createLoggerRuleConfig (const std::string &sink, Level level, const std::string &sourceFilter="", const std::string &tagFilter="", const std::string &messageFilter="")

Detailed Description

{
  "aace.logger":
  {
     "sinks": [<Sink>],
     "rules": [{"sink": "<SINK_ID>", "rule": <Rule>}]
  }
}

<Sink>: {
  "id": "<SINK_ID>"
  "type": "<SINK_TYPE>",
  "config": {
    <CONFIG_DATA>
  },
  "rules": [<RuleConfiguration>]
}

<Rule>: {
  "level": "<LOG_LEVEL>",
  "source": "<SOURCE_FILTER>",
  "tag": "<TAG_FILTER>",
  "message": "<MESSAGE_FILTER>"
}

Member Typedef Documentation

Level

using aace::logger::config::LoggerConfiguration::Level = aace::logger::LoggerEngineInterface::Level

Specifies the severity level of a log message

See also

aace::logger::LoggerEngineInterface::Level

Member Function Documentation

createConsoleSinkConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::logger::config::LoggerConfiguration::createConsoleSinkConfig ( const std::string &  id, Level  level  )

static

Factory method used to programmatically generate logger configuration data for a console sink. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
  "aace.logger":
  {
    "sinks": [{
      "id": "<SINK_ID>",
      "type": "aace.logger.sink.console",
      "rules": [{
        "level": <LOG_LEVEL>
      }]
    }
  }
}

Parameters

[in]	id	The id of sink object
[in]	level	The log level to be used to filter logs to this sink

createSyslogSinkConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::logger::config::LoggerConfiguration::createSyslogSinkConfig ( const std::string &  id, Level  level  )

static

Factory method used to programmatically generate logger configuration data for a syslog sink. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
  "aace.logger":
  {
    "sinks": [{
      "id": "<SINK_ID>",
      "type": "aace.logger.sink.syslog",
      "rules": [{
        "level": <LOG_LEVEL>
      }]
    }
  }
}

Parameters

[in]	id	The id of sink object
[in]	level	The log level to be used to filter logs to this sink

createFileSinkConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::logger::config::LoggerConfiguration::createFileSinkConfig ( const std::string &  id, Level  level, const std::string &  path, const std::string &  prefix = "aace", uint32_t  maxSize = 5242880, uint32_t  maxFiles = 3, bool  append = true  )

static

Factory method used to programmatically generate logger configuration data for a file sink. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
  "aace.logger":
  {
    "sinks": [{
      "id": "<SINK_ID>",
      "type": "aace.logger.sink.file",
      "config": {
        "path": "<PATH>",
        "prefix": "<PREFIX>",
        "maxSize": <MAX_SIZE>,
        "maxFiles": <MAX_FILES>,
        "append": <APPEND>
      }
      "rules": [{
        "level": <LOG_LEVEL>
      }]
    }
  }
}

Parameters

[in]	id	The id of sink object
[in]	level	The log level to be used to filter logs to this sink
[in]	path	The parent path where the log files will be written (must exist)
[in]	prefix	The prefix name given to the log file
[in]	maxSize	The maximum log file size in bytes
[in]	maxFiles	The maximum number of log files to rotate
[in]	append	true If the logs should be appended to the existing file, false if the file should be overwritten

createLoggerRuleConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::logger::config::LoggerConfiguration::createLoggerRuleConfig ( const std::string &  sink, Level  level, const std::string &  sourceFilter = "", const std::string &  tagFilter = "", const std::string &  messageFilter = ""  )

static

Factory method used to programmatically generate configuration data for a logger rule. The data generated by this method is equivalent to providing the following JSON values in a configuration file:

{
  "aace.logger":
  {
    "rules": [{
      "sink": "<SINK_ID>",
      "rule": {
        "level": <LOG_LEVEL>,
        "source": "<SOURCE_FILTER>",
        "tag": "<TAG_FILTER>",
        "message": "<MESSAGE_FILTER>"
      }
    }
  }
}

Parameters

[in]	sink	The id of sink object to which this rule is applied
[in]	level	The log level to be used as a filter for this rule
[in]	sourceFilter	The source regex to be used as a filter for this rule
[in]	tagFilter	The tag regex to be used as a filter for this rule
[in]	messageFilter	The message regex to be used as a filter for this rule