Codetracing Methods

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

  • codetracingDisable
  • codetracingEnable
  • codetracingIsEnabled
  • codetracingCreate
  • codetracingDelete
  • codetracingList
  • codetracingDownloadTraceFile
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

<b>The codetracingCreate Method</b>

codetracingCreate(string $url) : \ZendService\ZendServerAPI\DataTypes\CodeTracing
Create a new code-tracing entry.

This method will generate a codetrace of the given URL.
The URL needs to be a fully encoded and has to start with
the protocoll.

Parameters

$url

string

the url to trace

Returns

\ZendService\ZendServerAPI\DataTypes\CodeTracing

<b>The codetracingDelete Method</b>

codetracingDelete(integer $id) : \ZendService\ZendServerAPI\DataTypes\CodeTracing
Delete a code-tracing file entry.

Parameters

$id

integer

Trace file ID

Returns

\ZendService\ZendServerAPI\DataTypes\CodeTracing

<b>The codetracingDisable Method</b>

codetracingDisable(boolean $restartNow) : \ZendService\ZendServerAPI\DataTypes\CodeTracingStatus
Disable the code-tracing directive two directives necessary
for creating tracing dumps, this action does not disable the code-tracing component.

This method will force the Zend Server to disable the
developerMode. This mode causes the Zend Server to create a
dump on every request. Do not use it in production!

Parameters

$restartNow

boolean

Restart after method call

Returns

<b>The codetracingDownloadTraceFile Method</b>

codetracingDownloadTraceFile(string $traceFile, string $fileName, string $exportDirectory) : \ZendService\ZendServerAPI\DataTypes\CodeTracing
Download the amf file specified by the codetracing identifier.

Parameters

$traceFile

string

Trace file identifier

$fileName

string

Filename to save tracefile to

$exportDirectory

string

Directory to export files to

Returns

\ZendService\ZendServerAPI\DataTypes\CodeTracing

<b>The codetracingEnable Method</b>

codetracingEnable(boolean $restartNow) : \ZendService\ZendServerAPI\DataTypes\CodeTracingStatus
Enable code-tracing component and two directives necessary
for creating tracing dumps

This method will force the Zend Server to enable the
developerMode. This mode causes the Zend Server to create a
dump on every request. Do not use it in production!

Parameters

$restartNow

boolean

Restart after method call

Returns

<b>The codetracingIsEnabled Method</b>

codetracingIsEnabled() : \ZendService\ZendServerAPI\DataTypes\CodeTracingStatus
Check if the directives zend_codetracing.always_dump and
zend_codetracing.trace_enabled are set, and if the code-tracing
component is active.

This method returns true if developerMode is enabled.
The developerMode will cause the Zend Server to create a trace
on every request. Do not use it in production

Returns

<b>The codetracingList Method</b>

codetracingList(array $applicationIds, int $limit, int $offset, string $orderBy, string $direction) : \ZendService\ZendServerAPI\DataTypes\CodeTracing
Retrieve a list of code-tracing files available for download using codetracingDownloadTraceFile.

Parameters

$applicationIds

array

List of application IDs

$limit

int

Row limit to retrieve

$offset

int

Page offset to be displayed

$orderBy

string

Column to sort the result by (Id,Date,Url,CreatedBy,FileSize)

$direction

string

Direction to sort, default to Desc

Returns

\ZendService\ZendServerAPI\DataTypes\CodeTracing

Disables the logging

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

Enables the logging

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

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

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

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