Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.45 KB

ES_README.md

File metadata and controls

35 lines (23 loc) · 1.45 KB
Raw

Usage

Appender configuration

As configuration is now done by plain JsonObject its very simple to use and inject configuration eg by yaml, see as an example:

configurations:
  - identifier: accesslog-plain
    logPattern: "%D cs-uri"
    appenders:
      - appenderClassName : com.romanpierson.vertx.web.accesslogger.appender.elasticsearch.impl.ElasticSearchAppender
        config:
          instanceIdentifier: accesslog
          fieldNames:
            - duration
            - uri

Conventions

By default all log elements configured will be sent to the indexer to be interpreted as message to be indexed. However the timestamp is passed to the indexer as meta data as the indexer potentially requires that raw value eg to determinate the target index name.

The instance identifier tells the indexer verticle to what ES instance the data should be indexed. All the detailed configuration of this is done directly on the indexer verticle itself (so the appender does not have to know about this).

Timestamp

The timestamp value is automatically added - there is no need to add this on the logPattern.

The real fieldname used in the indexer for the ES timestamp field is configured in the indexer verticle itself.

Field Names Definition

As for each field to be indexed a specific name needs to be used this has to be explicitly set by configuration property fieldNames. Be aware that you need to put a name for all fields of your logpattern.