Configuring Logging on the Provider and Agent VMs

There are several services running on the Provider VM and Agent VM that are central to the operation of Data Management for VMware Tanzu. You can control the log level for these services using the Data Management for VMware Tanzu API.

Data Management for VMware Tanzu logs messages at the following levels (less to more verbose): OFF, ERROR, WARNING, INFO, DEBUG, TRACE.

By default, Data Management for VMware Tanzu logs INFO-level messages for the core services. You can use the API to increase or decrease the log level for an individual service running on the VM.

Note: Any log level changes that you make to a service running on a VM will be reset when the service is restarted.

Prerequisites

You must be able to identify the IP address of the Provider VM or the Agent VM for which you want to update the service log levels.

Configuring Logging on the Provider VM

You can dynamically update the log level of these core services running on a Provider VM:

Logging Service Name	Description
PROVIDER	Provider service
MONITORING	Monitoring service
APMS	Appliance management service
UPDATE	Update manager service

If your Data Management for VMware Tanzu installation has a single Provider node, invoke the /appliance/loggers/configure-self API endpoint:

POST https://<provider-ip-address>/appliance/loggers/configure-self

If your Data Management for VMware Tanzu installation is running in Provider High Availability mode, the /appliance/loggers/configure-all endpoint updates the service log level on all Provider nodes in the HA cluster:

POST https://<provider-ip-address>/appliance/loggers/configure-all

Both API endpoints take the same request parameters; you provide the <service-name> and <log-level> for the service whose log level you wish to update:

{
    "service": "<service-name>",
    "packageLogLevels": [
        {
            "packageName": "com.vmware.tdm",
            "logLevel": "<log-level>"
        }
    ]
}

Configuring Logging on a Agent VM

You can dynamically update the log level of these core services running on a Agent VM:

Logging Service Name	Description
ONBOARDING	Onboarding service
MGMT_PLANE	Management plane service
MONITORING	Monitoring service
UPDATE	Update manager service

Invoke the /onboarding/api/agent/loggers API endpoint to change the log level of a service:

POST https://<agent-ip-address>/onboarding/api/agent/loggers

Request parameters:

{
    "packageLogLevels": [
        {
            "packageName": "com.vmware.tdm",
            "logLevel": "<log-level>"
        }
    ],
    "service": "<service-name>"
}

Provide the <service-name> and <log-level> for the service whose log level you wish to update.