LogCollectorCollectSpec

Information required to collect logs.

JSON Example

{
    "component_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "component_type": "AGENT",
    "feature_list": [
        "all",
        "blast"
    ],
    "filter_type": [
        "DEFAULT"
    ],
    "sticky_log_collection": false
}

string

component_id

Required

Represents the ID of the log collector component type for which logs are to be collected.

Represents CS id if CS logs are collected, Machine id if Agent logs are collected and

RDS server id if Agent RDS logs are collected.

string

component_type

Required

Represents the type of the log collector component.

CONNECTION_SERVER: Log component type is Connection Server.
AGENT: Log component type is agent machine from desktop pool.
AGENT_RDS: Log component type is agent RDSH server from farm.

Possible values are : CONNECTION_SERVER, AGENT, AGENT_RDS,

array of string

feature_list

Optional

List of features for which the logs need to be collected. Feature wise log collection is supported only for component_type AGENT and AGENT_RDS. If feature_list is null then by default logs are collected for all the features.

array of string

filter_type

Optional

Filter type to be used while collecting the logs bundle. Filter is set to DEFAULT if none specified.

Possible values are : DEFAULT, PRODUCT_DUMP, WINDOWS_DUMP,

boolean

sticky_log_collection

Optional

Indicates the connection server processing the LogCollectorCollectSpec becomes the download owner.

Parameter To

Collect