Enable Unified Logging in Symphony Using Fluentd

This applies to: Visual Data Discovery

Identify the Symphony microservices for which you want activity logged to Fluentd. A complete list of the Symphony microservices is given in Symphony Data Discovery Microservice Name Reference, but not all microservices support unified logging. You can enable unified logging for these microservices:

  • Web microservices (zoomdata.properties)
  • Query engine (query-engine.properties)
  • Data source connectors (see Connector Properties and Property Files for a list of property files)
  • Data Writer framework (data-writer-postgresql.properties)

To enable unified logging using Fluentd for a Symphony microservice:

  1. On your Symphony server, edit the .properties file for the microservice. For example, etc/zoomdata/query-engine.properties.

  2. Define the following parameters in the .properties file:

    Property Syntax Description
    logging.unified.level = <log-level> Specify one of the following log levels for <log-level>: ERROR, WARN, INFO, DEBUG, TRACE, or OFF. If set to OFF, Fluentd unified logging is disabled.
    logging.unified.tag = <service-tag>

    Specify the unique tag for the Symphony microservice, used in grouping logs. This tag must be unique throughout Symphony.

    Supply the Symphony microservice name for <service-tag>. For example, logging.unified.tag = query-engine. This is important because the tag identifies which microservice the log message applies to.

    Valid values are query-engine, zoomdata-server, data-writer-postgresql, and edc-<connector-name> (where <connector-name> is one of the names listed in Connector Properties and Property Files).
    logging.unified.label = <service-label> Specify a more verbose label for the Symphony microservice.
    logging.unified.host = <yourFluentdServerIPaddress> Specify the IP address of the Fluentd logging server.
    logging.unified.port = <yourFluentdServerPort> Specify the port of the Fluentd logging server.

  3. Save your changes and exit the .properties file.

  4. Restart the Symphony server.

On the Fluentd server, you can then direct your logs to a data source of your choice. For information and steps, see Fluentd's documentation on Output.