Search the VMware Knowledge Base (KB)
View by Article ID

Enabling Centralized Logging in VMware vCloud Director (2004564)

  • 15 Ratings

Details

In addition to the audit logs that are maintained in the vCloud Director database (and optionally forwarded to a syslog server) each vCloud Director cell creates several diagnostic log files. This article describes how to set an additional logger in the vCloud Director log4j.properties file. This logger sends all diagnostic log output to a central syslog server.

For more information, see the Viewing the vCloud Director Logs section in the vCloud Director Administrator's Guide.

Solution

Prerequisites
  • Verify that your syslog host runs a version of syslog that supports listening for remote connections.  Most modern versions of syslog support use of the -r option to enable listening for remote connections. In addition, the open source program syslog-ng has this capability.
  • Verify that the appropriate firewall ports are open on  both the vCloud Director host for outbound UDP traffic as well as on the syslog  host for inbound UDP access.
Enabling Centralized Logging in vCloud Director

These steps add a new Syslogappender that transmits log messages that are INFO-level or above. You must repeat this procedure for each cell in your vCloud Director server group.
  1. Log in to the cell using the console or SSH.
  2. Change directory to $VCLOUD_HOME/etc.
  3. Make a backup of the default logging configuration.

    cp log4j.properties log4j.properties.default

  4. Open the log4j.properties file using a text editor and add these entries:

    log4j.appender.vcloud.system.syslog=org.apache.log4j.net.SyslogAppender
    log4j.appender.vcloud.system.syslog.syslogHost=syslog-host-fqdn:port

    #Modify this line to add the vCloud Director syslog appenders:
    #log4j.appender.vcloud.system.syslog.facility=LOCAL1
    log4j.appender.vcloud.system.syslog.facility=LOCAL1, log4j.rootLogger=ERROR, vcloud.system.debug, vcloud.system.info, vcloud.system.syslog

    #Specify the logger pattern.
    #Use this line if the cell is running vCloud Director 5.1 or earlier:
    #log4j.appender.vcloud.system.syslog.layout=com.vmware.vcloud.logging.CustomPatternLayout
    #
    # Use this line if the cell is running vCloud Director 5.5 or later.
    #log4j.appender.vcloud.system.syslog.layout=com.vmware.vcloud.logging.layout.CustomPatternLayout
    #The remaining lines are identical for all vCloud Director versions

    log4j.appender.vcloud.system.syslog.layout.ConversionPattern=%d{ISO8601} | %-8.8p | %-25.50t | %-30.50c{1} | %m | %x%n
    log4j.appender.vcloud.system.syslog.threshold=INFO

    Where syslog-host-fqdn is the fully-qualified domain name of your syslog host and port is an optional port number. If port number is not mentioned, logs go to port 514 on the specified host.
  5. Save the file.
  6. Restart the cell:

    service vmware-vcd restart

After the cell starts, diagnostic log output from the cell appears on the central syslog server.

Repeat this procedure for each cell in your vCloud Director server group.

Limitations
  • SyslogAppender only supports UDP. Use of TCP or other more advanced syslog features requires modifications of the cell's runtime configuration, which is not supported.
  • The Jetty request log is configured by Jetty, so there is no way to centrally log the access and error information using Log4j.
  • When you upgrade the cell to a new release of vCloud Director, changes to log4j.properties revert to the default, so you must re-enter these customizations after the upgrade.

Tags

vcloud-director-logging

This Article Replaces

2004519

Request a Product Feature

To request a new product feature or to provide feedback on a VMware product, please visit the Request a Product Feature page.

Feedback

  • 15 Ratings

Did this article help you?
This article resolved my issue.
This article did not resolve my issue.
This article helped but additional information was required to resolve my issue.

What can we do to improve this information? (4000 or fewer characters)




Please enter the Captcha code before clicking Submit.
  • 15 Ratings
Actions
KB: