Set the debug log level for LSF daemon log files (POST)

Edit online

Description

URL

scheme://host:port/platform/ws/lsflogs/debug

Description

Temporarily sets the message log level for LSF daemons to include debugging messages in log files.

If you only specify the daemon name without any additional options, the default log level used is LOG_DEBUG, no additional classes are logged(LC_NONE), and the message log level is set to include debugging messages for the daemon running on the management host.

The message log level you set will only be in effect from the time you set it until you turn it off or the daemon stops running, whichever is sooner. If the daemon is restarted, its message log level is reset back to the value of the parameter LSF_LOG_MASK defined in the LSF configuration file lsf.conf.

HTTP Method

POST

Parameters

 Name Description
 

daemon

Required.

Specify the LSF daemon for which to set the log level.

Valid values:

  • LIM
  • RES
  • SBD
  • MBD
  • SCHD
 

loglevel

Optional.

Specify the level of detail to include in debugging messages. The higher the number, the more detail that is logged. Higher levels include all lower levels. For example, LOG_DEBUG3 includes LOG_DEBUG2, LOG_DEBUG1, and LOG_DEBUG levels.

Possible values:

  • LOG_DEBUG3
  • LOG_DEBUG2
  • LOG_DEBUG1
  • LOG_DEBUG
 

classnames

Optional.

Specify the software classes for which to log debug messages. Separate multiple class names with a comma(,).

Valid values:

  • LC_AFS: Log AFS messages
  • LC_AUTH: Log authentication messages
  • LC_CHKPNT: Log checkpointing messages
  • LC_COMM: Log communication messages
  • LC_CONF: Print out all parameters in lsf.conf (and ego.conf)
  • LC_DCE: Log messages pertaining to DCE support
  • LC_EXEC: Log significant steps for job execution
  • LC_FILE: Log file transfer messages
  • LC_HANG: Mark where a program might hang
  • LC_LICENC: Log license management messages
  • LC_MULTI: Log messages pertaining to MultiCluster
  • LC_PIM : Log PIM messages
  • LC_SIGNAL: Log messages pertaining to signals
  • LC_TRACE: Log significant program walk steps
  • LC_XDR: Log everything transferred by XDR
  • LC_NONE: No additional classes are logged
  hostname

Optional.

Sets debug messages for the daemon running on the specified host. Specify a valid host name in the cluster. To get a list of hosts in the cluster, use the API: /platform/ws/hosts

Request

Request-Method

POST

Request-URI

 /platform/ws/lsflogs/debug

Request-Header

 Name Value

Accept

application/xml or application/json

Message-body

loglevel =%s ; classnames=%s; hostname=%s; daemon=%s

Response

Response-Code

  • 303 See Other: Debug message level successfully set. Get the URI for details.
  • 403 Forbidden: Access restricted by role-based access control permissions.
  • 404 Not Found: The specified LSF host does not exist.
  • 400 Bad request: Invalid client parameters.
  • 500 Internal Server Error: Exception occurred.

Response-Header

 Name Value

Content-Type

application/xml or application/json
Location (Only when response code is 303)

A URI to the LSF daemon log file for which the debug message level was set.

Message-body

 Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/error/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: Set the LIM daemon log level to debug on the management host


 # Request
POST /platform/ws/lsflogs/debug HTTP/1.1
Host: www.example.org
Authorization: Basic d2VsaXU6bGV0bWVpbg==
# Response
303  See Other
Location: http://www.example.org/platform/ws/lsflogs/lim.log.hostname

Related APIs

  • Get a list of hosts: /platform/ws/hosts