Class ElasticSearchLogger

ElasticSearch is a popular search index. It is often used to store and index execution logs by itself or as a part of ELK (ElasticSearch - Logstash - Kibana) stack.

Authentication is not supported in this version.

Configuration parameters

• level: maximum log level to capture
• source: source (context) name
• connection(s):
  • discovery_key: (optional) a key to retrieve the connection from IDiscovery
  • protocol: connection protocol: http or https
  • host: host name or IP address
  • port: port number
  • uri: resource URI or connection string with all parameters in it
• options:
  • interval: interval in milliseconds to save log messages (default: 10 seconds)
  • max_cache_size: maximum number of messages stored in this cache (default: 100)
  • index: ElasticSearch index name (default: "log")
  • date_format The date format to use when creating the index name. Eg. log-YYYYMMDD (default: "YYYYMMDD"). See Moment.js
  • daily: true to create a new index every day by adding date suffix to the index name (default: false)
  • reconnect: reconnect timeout in milliseconds (default: 60 sec)
  • timeout: invocation timeout in milliseconds (default: 30 sec)
  • max_retries: maximum number of retries (default: 3)
  • index_message: true to enable indexing for message object (default: false)

References

• *:context-info:*:*:1.0 (optional) ContextInfo to detect the context id and specify counters source
• *:discovery:*:*:1.0 (optional) IDiscovery services to resolve connection

Example

let logger = new ElasticSearchLogger();
logger.configure(ConfigParams.fromTuples(
    "connection.protocol", "http",
    "connection.host", "localhost",
    "connection.port", 9200
));

logger.open("123", (err) => {
    ...
});

logger.error("123", ex, "Error occured: %s", ex.message);
logger.debug("123", "Everything is OK.");