Monitor Methods

The following is a list of methods available for the Monitoring feature:

  • monitorGetRequestSummary
  • monitorDownloadTraceFile(codetracingDownloadTraceFile)
  • monitorStartDebug(studioStartDebug)
  • monitorGetIssuesListByPredefinedFilter
  • monitorGetIssuesDetails
  • monitorGetEventGroupDetails
  • monitorExportIssueByEventsGroup
  • monitorChangeIssueStatus
license New BSD License
link for the canonical source repository
author Ingo Walz
category Zend
package Zend_Service
subpackage ZendServerAPI

 Methods

Base constructor for all API-method implementations

__construct(string $name) 
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::__construct()

Parameters

$name

string

Name of the config

Check if connection is possible or not

canConnect() : bool
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::canConnect()

Returns

bool

Disables the logging

disableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::disableLogging()

Enables the logging

enableLogging() : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::enableLogging()

<pre>Get the global directory setting for all methods that export files in this class</pre>

getExportDirectory() : string

Returns

string

Get the plugin manager

getPluginManager() : \Zend\ServiceManager\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getPluginManager()

Returns

\Zend\ServiceManager\PluginManager

Returns the current request

getRequest() : \ZendService\ZendServerAPI\Request
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::getRequest()

Returns

<b>The monitorChangeIssueStatus Method</b>

monitorChangeIssueStatus(string $issueId, string $newStatus) : \ZendService\ZendServerAPI\DataTypes\IssueDetails
Modify an Issue's status code based on an Issue's
Id and a status code.

Parameters

$issueId

string

The issue ID

$newStatus

string

The new status, Open | Closed | Ignored

Returns

<b>The monitorDownloadTraceFile Method</b>

monitorDownloadTraceFile(string $traceFile, string $exportDirectory, string $fileName) : \SplFileInfo
Download a trace file. Alias for Codetracing::downloadTraceFile

Parameters

$traceFile

string

Trace file identifier. Note that a codetracing identifier is provided as part of the monitorGetRequestSummary xml response

$exportDirectory

string

The directory where to export the tracefile to. Default is getcwd()

$fileName

string

The filename where to save the exported issue to. Default is the given name from Zend Server

Returns

<b>The monitorExportIssueByEventsGroup Method</b>

monitorExportIssueByEventsGroup(string $issueId, string $eventsGroupId, string $fileName, string $exportDirectory) : \SplFileInfo
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.

Parameters

$issueId

string

The issue identifier

$eventsGroupId

string

The issue event group identifier

$fileName

string

The filename where to save the exported issue to. Default is the given name from Zend Server

$exportDirectory

string

The directory where to export the issue. Default is getcwd()

Returns

<b>The monitorGetEventGroupDetails Method</b>

monitorGetEventGroupDetails(string $issueId, int $eventsGroupId) : \ZendService\ZendServerAPI\DataTypes\EventsGroupDetails
Retrieves the details for the given issue ID.
The issue ID can be found dynamically with monitorGetIssuesListByPredefinedFilter and
one of the standard filters. If you run that action without the eventsGroupId parameter
it will perform a monitorGetIssueDetails call before and pick the first id

Parameters

$issueId

string

Issue identifier, provided in the issue element

$eventsGroupId

int

Event group identifier, provided in the issue element

Returns

<b>The monitorGetIssuesDetails Method</b>

monitorGetIssueDetails(string $issueId) : \ZendService\ZendServerAPI\DataTypes\IssueDetails
Retrieves the details for the given issue ID.
The issue ID can be found dynamically with monitorGetIssuesListByPredefinedFilter and
one of the standard filters.

Parameters

$issueId

string

The Issue id.

Returns

<b>The monitorGetIssuesListByPredefinedFilter Method</b>

monitorGetIssuesListByPredefinedFilter(string $filterId, int | null $limit, int | null $offset, string | null $order, string | null $direction) : \ZendService\ZendServerAPI\DataTypes\IssueList
Retrieve a list of monitor issues according to a preset filter identifier.
The filter identifier is shared with the UI's predefined filters.
This WebAPI method may also accept ordering details and paging limits.
The response is a list of issue elements with their general details and event-groups identifiers.

Parameters

$filterId

string

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

intnull

The number of rows to retrieve. Default lists all events up to an arbitrary limit set by the system

$offset

intnull

A paging offset to begin the issues list from. Default is 0

$order

stringnull

Column identifier for sorting the result set (id, repeats, date, eventType, fullUrl, severity, status). Default is date

$direction

stringnull

Sorting direction: Ascending or Descending. Default is Descending

Returns

<b>The monitorGetRequestSummary Method</b>

monitorGetRequestSummary(string $requestUid) : \SplFileInfo
This method is not implemented - the functionality was not testable

Retrieve information about a particular request's events and code tracing.
The requestUid identifier is provided in a cookie that is set in the response
to the particular request.
This API action is designed to be used with the new Zend Studio browser toolbar.

Parameters

$requestUid

string

Request identifier, obtained from response cookie

Returns

Set the client.

setClient(\Zend\Http\Client $client) : void
Inherited

Most likly for testing

inherited_from \ZendService\ZendServerAPI\BaseAPI::setClient()

Parameters

$client

\Zend\Http\Client

Set the config file.

setConfigFile(string $configFile) : void
Inherited

Proxy to the pluginmanager for initialization

inherited_from \ZendService\ZendServerAPI\BaseAPI::setConfigFile()

Parameters

$configFile

string

<pre>Set the global setting for the export directory.

setExportDirectory(string $exportDirectory) : void

All files will be saved here unless something else passed to the methods

Parameters

$exportDirectory

string

The directory where to save the files to.Can be set globally here

Set the request for the current context

setRequest(\ZendService\ZendServerAPI\Request $request) : void
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::setRequest()

Parameters

Get the first event groups identifier by an given issue id.

getFirstEventGroupsIdByIssueId(int $issueId) : int
Inherited

This will perform an monitorGetIssuesDetails action.

inherited_from \ZendService\ZendServerAPI\BaseAPI::getFirstEventGroupsIdByIssueId()

Parameters

$issueId

int

Returns

int

 Properties

 

$exportDirectory : string
 

$name : string
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$name
 

$pluginManager : \ZendService\ZendServerAPI\PluginManager
Inherited
inherited_from \ZendService\ZendServerAPI\BaseAPI::$$pluginManager