Logs:Get Logs

Search (SHIFT+S)



Get Logs

GET /logs/

Get log data from the specified virtual machines that are filtered, merged, and sorted based on the passed request parameters and streams the log messages back to the client as JSON formatted strings.


Query Parameters

node_idThe ids of the virtual machines for which log data is collected. Allowed values: standalone, control nodes: vipr1,vipr2 etc data services nodes: dataservice-10-111-111-222 (node-ip-address)
node_nameThe custom names of the vipr nodes for which log data is collected. Allowed values: Current values of node_x_name properties
log_nameThe names of the log files to process.
severityThe minimum severity level for a logged message. Allowed values:0-9. Default value: 7
startThe start datetime of the desired time window. Value is inclusive. Allowed values: "yyyy-MM-dd_HH:mm:ss" formatted date or datetime in ms. Default: Set to yesterday same time
endThe end datetime of the desired time window. Value is inclusive. Allowed values: "yyyy-MM-dd_HH:mm:ss" formatted date or datetime in ms.
msg_regexA regular expression to which the log message conforms.
maxcountMaximum number of log messages to retrieve. This may return more than max count, if there are more messages with same timestamp as of the latest message. Value should be greater than 0.
dryrunif true, the API will do a dry run for log collection. Instead of collecting logs from nodes, dry run will check the nodes' availability for collecting logs. Entity body of the response will return an error message string indicating which node(s) not available for collecting logs. If log collection is ok for all specified nodes, no error message is included in response. Default value of this parameter is false.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR
  • SECURITY_ADMIN

Response Body

A reference to the StreamingOutput to which the log data is written.

Notes: