command:monitor

monitorCountIssuesByPredefinedFilter

monitorCountIssuesByPredefinedFilter --filterId= [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Count the number of issues according to a particular filter or customized filters’ list. This action’s filterId and filters parameter behaves the same way as monitorGetIssuesByPredefinedFilter.

  • --filterId
    The predefined filter's name. This parameter is case-sensitive.
  • --filters
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
      applicationIds: array, a list of application IDs to use for retrieving issue rows
    • severities: array, a list of severities (info, normal, severe)
    • statuses: array, a list of statuses (open, closed, reopened, ignored)
    • eventTypes: array, a list of eventTypes (zend-error, function-error, request-slow-exec, function-slow-exec, request-relative-slow-exec, java-exception, request-large-mem-usage, request-relative-large-mem-usage, request-relative-large-out-size, jq-job-exec-error, jq-job-logical-failure, jq-job-exec-delay, jq-daemon-high-concurrency, tracer-write-file-fail, zsm-node-added-successfully, zsm-node-enabled, zsm-node-disabled, zsm-node-removed-successfully, zsm-node-is-not-responding, zsm-configuration-mismatch, zsm-restart-failed, zdd-deploy-success, zdd-deploy-error, zdd-redeploy-success, zdd-redeploy-error, zdd-remove-success, zdd-remove-error, zdd-update-success, zdd-update-error, zdd-rollback-success, zdd-rollback-error, custom.
    • from: integer, a unix timestamp that defines the start date and time for filtering. All events retrieved will have occurred after this timestamp
    • to: integer, a unix timestamp that defines the last date and time for filtering. All events retrieved will have occurred before this timestamp
    • ruleNames: array, a list of rule names that are defined in the system: Function Error, Database Error, Slow Function Execution,Slow Query Execution, Slow Request Execution, High Memory Usage, Inconsistent Output Size, PHP Error, Uncaught
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetIssuesByPredefinedFilter

monitorGetIssuesByPredefinedFilter --filterId= [--limit=] [--offset=] [--order=] [--direction=] [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the library version ID that is deployed on the server or the cluster, and information about that version and its library.

  • --filterId
    The predefined filter's name. This parameter is case-sensitive.
  • --limit
    The number of rows to retrieve. Default lists all audit entries up to an arbitrary limit set by the system
  • --offset
    A paging offset to begin the list from. Default: 0
  • --order
    Column identifier for sorting the result set (audit_id, node_id, time). Default: audit_id
  • --direction
    Sorting direction: ASC or DESC. Default: DESC
  • --filters
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
    • applicationIds: array, a list of application IDs to use for retrieving issue rows.
    • severities: array, a list of severities (info, normal, severe)
    • statuses: array, a list of statuses (open, closed, reopened, ignored) - Removed in version 1.3.
    • eventTypes: array, a list of eventTypes (zend-error, function-error, request-slow-exec, function-slow-exec, request-relative-slow-exec, java-exception, request-large-mem-usage, request-relative-large-mem-usage, request-relative-large-out-size, jq-job-exec-error, jq-job-logical-failure, jq-job-exec-delay, jq-daemon-high-concurrency, tracer-write-file-fail, zsm-node-added-successfully, zsm-node-enabled, zsm-node-disabled, zsm-node-removed-successfully, zsm-node-is-not-responding, zsm-configuration-mismatch, zsm-restart-failed, zdd-deploy-success, zdd-deploy-error, zdd-redeploy-success, zdd-redeploy-error, zdd-remove-success, zdd-remove-error, zdd-update-success, zdd-update-error, zdd-rollback-success, zdd-rollback-error, custom.
    • freeText: string
    • from: string, a timestamp to use for retrieving rows
    • to: string, a timestamp to use for retrieving rows
    • ruleNames: array, a list of rule names that are defined in the system: Function Error, Database Error, Slow Function Execution, Slow Query Execution, Slow Request Execution, High Memory Usage, Inconsistent Output Size, PHP Error, Uncaught Java Exception, Custom Event, Zend Framework Exception, Job Execution Error, Job Logical Failure, Job Execution Delay, Failed Writing Code Tracing Data and other custom names
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetJobsIssuesBySeverity

monitorGetJobsIssuesBySeverity [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the events related to running job ordered by severity (from critical to warning)

  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetRequestSummary

monitorGetRequestSummary --requestUid= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the library version ID that is deployed on the server or the cluster, and information about that version and its library.

  • --requestUid
    Library version identifier. Note that a codetracing identifier is provided as part of the LibraryGetStatus xml response.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetIssuesListPredefinedFilter

monitorGetIssuesListPredefinedFilter --filterId= [--limit=] [--offset=] [--order=] [--direction=] [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Get the library version ID that is deployed on the server or the cluster, and information about that version and its library.

  • --filterId
    The predefined filter's name. This parameter is case-sensitive.
  • --limit
    The number of rows to retrieve. Default lists all audit entries up to an arbitrary limit set by the system
  • --offset
    A paging offset to begin the list from. Default: 0
  • --order
    Column identifier for sorting the result set (audit_id, node_id, time). Default: audit_id
  • --direction
    Sorting direction: ASC or DESC. Default: DESC
  • --filters
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
    • applicationIds: array, a list of application IDs to use for retrieving issue rows
    • severities: array, a list of severities (info, normal, severe)
    • statuses: array, a list of statuses (open, closed, reopened, ignored) - Removed in version 1.3.
    • eventTypes:array, a list of eventTypes (zend-error, function-error, request-slow-exec, function-slow-exec, request-relative-slow-exec, java-exception, request-large-mem-usage, request-relative-large-mem-usage, request-relative-large-out-size, jq-job-exec-error, jq-job-logical-failure, jq-job-exec-delay, jq-daemon-high-concurrency, tracer-write-file-fail, zsm-node-added-successfully, zsm-node-enabled, zsm-node-disabled, zsm-node-removed-successfully, zsm-node-is-not-responding, zsm-configuration-mismatch, zsm-restart-failed, zdd-deploy-success, zdd-deploy-error, zdd-redeploy-success, zdd-redeploy-error, zdd-remove-success, zdd-remove-error, zdd-update-success, zdd-update-error, zdd-rollback-success, zdd-rollback-error, custom.
    • freeText: string
    • from: string, a timestamp to use for retrieving rows
    • to: string, a timestamp to use for retrieving rows
    • ruleNames: array, a list of rule names that are defined in the system: Function Error, Database Error, Slow Function Execution, Slow Query Execution, Slow Request Execution, High Memory Usage, Inconsistent Output Size, PHP Error, Uncaught Java Exception, Custom Event, Zend Framework Exception, Job Execution Error, Job Logical Failure, Job Execution Delay, Failed Writing Code Tracing Data and other custom names
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetIssueDetails

monitorGetIssueDetails --issueId= [--limit=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Retrieve an issue's details according to the issueId passed as a parameter. Additional information about event groups is also displayed.

  • --issueId
    The predefined filter's id. Can be the filter's “name” or the actual identifier randomly created by the system. This parameter is case-sensitive.
  • --limit
    Limits the number of eventsGroups returned with the issue details.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorGetEventGroupDetails

monitorGetEventGroupDetails --issueId= --eventsGroupId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Retrieve an events list object identified by an events-group identifier. The events-group identifier is retrieved from an Issue element's data.

  • --issueId
    This parameter was removed due to redundancy and is no longer used in either WebAPI 1.2 or 1.3 on ZS6.x.
  • --eventsGroupId
    Events group identifier, provided in the eventsGroup element. Note that for backwards compatibility you may also submit an “eventGroupId” parameter and it will be accepted on ZS6.x
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorExportIssueByEventsGroup

monitorExportIssueByEventsGroup --eventsGroupId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Export an archive containing all of the issue's information, event groups and code tracing if available, ready for consumption by Zend Studio. The response is a binary payload.

  • --eventsGroupId
    The issue event group identifier.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorChangeIssueStatus

monitorChangeIssueStatus --issueId= --newStatus= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Modify an Issue's status code based on an Issue's Id and a status code.

  • --issueId
    The issue identifier.
  • --newStatus
    The new status to set: Open | Closed | Ignored.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

getBacktraceFile

getBacktraceFile --backtraceNum= --eventsGroupId= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Retrieve an event’s backtrace file payload. The file is returned encoded in base64 to conserve the xml structure of the response and its internal information.

  • --backtraceNum
    The backtrace step from the events group to be retrieved, used to choose which file to retrieve.
  • --eventsGroupId
    Events group identifier, provided in the eventsGroup element.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorDeleteIssuesByPredefinedFilter

monitorDeleteIssuesByPredefinedFilter --filterId= [--limit=] [--offset=] [--order=] [--direction=] [--filters=] [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Delete monitor issues based on given filtering parameters. The response returns the amount of issues that were deleted. Note though, that as this method only marks the issues for deletion, subsequent calls with the same parameters return the same size of issues deleted, rather than the expected 0.

  • --filterId
    The predefined filter's name. This parameter is case-sensitive.
  • --limit
    The number of rows to retrieve. Default lists all audit entries up to an arbitrary limit set by the system
  • --offset
    A paging offset to begin the list from. Default: 0
  • --order
    Column identifier for sorting the result set (audit_id, node_id, time). Default: audit_id
  • --direction
    Sorting direction: ASC or DESC. Default: DESC
  • --filters
    Add filter parameters in an ad-hoc manner. These filters will be added to the predefined filter that was passed. This parameter is an array with a predefined set of parameters that accept strings or arrays to hold multiple values:
    • applicationIds: array, a list of application IDs to use for retrieving issue rows.
    • severities: array, a list of severities (info, normal, severe)
    • eventTypes: array, a list of eventTypes (zend-error, function-error, request-slow-exec, function-slow-exec, request-relative-slow-exec, java-exception, request-large-mem-usage, request-relative-large-mem-usage, request-relative-large-out-size, jq-job-exec-error, jq-job-logical-failure, jq-job-exec-delay, jq-daemon-high-concurrency, tracer-write-file-fail, zsm-node-added-successfully, zsm-node-enabled, zsm-node-disabled, zsm-node-removed-successfully, zsm-node-is-not-responding, zsm-configuration-mismatch, zsm-restart-failed, zdd-deploy-success, zdd-deploy-error, zdd-redeploy-success, zdd-redeploy-error, zdd-remove-success, zdd-remove-error, zdd-update-success, zdd-update-error, zdd-rollback-success, zdd-rollback-error, custom
    • freeText: string
    • from: string, a timestamp to use for retrieving rows
    • to: string, a timestamp to use for retrieving rows
    • ruleNames: array, a list of rule names that are defined in the system: Function Error, Database Error, Slow Function Execution, Slow Query Execution, Slow Request Execution, High Memory Usage, Inconsistent Output Size, PHP Error, Uncaught Java Exception, Custom Event, Zend Framework Exception, Job Execution Error, Job Logical Failure, Job Execution Delay, Failed Writing Code Tracing Data and other custom names
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.

monitorDeleteIssues

monitorDeleteIssues --issueIds= [--target=] [--zsurl=] [--zskey=] [--zssecret=] [--zsversion=] [--http=] [--output-format=]

Delete monitor issues based on issueIds passed. Response returns the amount of issues that were deleted. Note though, that as this method only marks the issues for deletion, subsequent calls with the same parameters will return the same size of issues deleted rather than expected 0.

  • --issueIds
    Comma-separated list of issue ids.
  • --output-format
    Output format. Default is "xml", but you can use "json", or "kv" for key-value.