tracesrv.script

Software Testing Automation Framework (STAF)的开发代码

:h4.Examples
:ul.
:li.:hp2.Goal&colon.:ehp2. Disable the service access denied and error trace points
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE TRACEPOINTS "ServiceAccessDenied Error":exph.
:li.:hp2.Goal&colon.:ehp2. Disable the service result and error trace points
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE TRACEPOINTS "ServiceResult Error":exph.
:li.:hp2.Goal&colon.:ehp2. Disable all trace points
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE ALL TRACEPOINTS:exph.
:li.:hp2.Goal&colon.:ehp2. Disable tracing for remote requests
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE TRACEPOINT RemoteRequests:exph.
:li.:hp2.Goal&colon.:ehp2. Disable tracing only for the PROCESS and QUEUE services
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE SERVICES "PROCESS QUEUE":exph.
:li.:hp2.Goal&colon.:ehp2. DISABLE tracing for all services
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE ALL SERVICES:exph.
:li.:hp2.Goal&colon.:ehp2. Disable tracing for all services and tracepoints
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE ALL:exph.
:li.:hp2.Goal&colon.:ehp2. Disable tracing for the VAR service
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE SERVICE VAR:exph.
:li.:hp2.Goal&colon.:ehp2. Disable tracing for the SERVICE service
:p.:hp2.Syntax&colon.:ehp2. :xph.DISABLE SERVICE &colon.7&colon.SERVICE:exph.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.PURGE
:i3.TRACE service
:ih1.tracing
:i2.trace service
:h3 id=tracesrvPurge.Purge
:p.:xph.PURGE:exph. removes all unregistered services from the service list
:h4.Syntax
:xmp.
PURGE
:exmp.
:h4.Security
:p.&seclvl. 5.
:h4.Return Codes
:p.All return codes from PURGE are documented in :hdref refid=retcode..
:h4.Results
:p.For :xph.PURGE:exph. the result buffer will be empty if there are no errors.
:h4.Examples
:ul.
:li.:hp2.Goal&colon.:ehp2. Remove extra services from the trace list
:p.:hp2.Syntax&colon.:ehp2. :xph.PURGE:exph.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.LIST
:i3.TRACE service
:ih1.tracing
:i2.trace service
:h3 id=tracesrvList.List
:p.:xph.LIST:exph. Returns a list of current settings including trace
destination and default service state, and a list of the current tracing
statuses for all tracepoints and services
:h4.Syntax
:xmp.
LIST &lbrk.SETTINGS&rbrk.
:exmp.
:h4.Security
:p.&seclvl. 2.
:h4.Return Codes
:p.All return codes from LIST are documented in :hdref refid=retcode..
:h4.Results
:p.
On successful return, the result buffer for a :xph.LIST:exph.
request will contain a marshalled
:xph.<Map&colon.STAF/Service/Trace/TraceInfo>:exph.
representing the current trace settings.
The maps are defined as follows:
:table cols='* * 3* 2*'.
:tcap.Definition of map class STAF/Service/Trace/TraceInfo
:tnote text='Description'.This map class represents the current trace settings.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.tracingTo
:c.Tracing To
:c.&stringObj.
:c.:xph.'Stdout' | 'Stderr':exph. or a file name
:row.
:c.defaultServiceState
:c.Default Service State
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.tracePoints
:c.Trace Points
:c.:xph.<Map&colon.STAF/Service/Trace/Tracepoint>:exph.
:c.
:row.
:c.services
:c.Services
:c.:xph.<Map&colon.STAF/Service/Trace/Service>:exph.
:c.
:tnote text='Notes'.
"Tracing" indicates the current trace output destination.
:etnote.
:etable.
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Trace/Tracepoint
:tnote text='Description'.This map class represents the tracepoints and their
trace states.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.INFO
:c.Info
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.WARNING
:c.Warning
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.ERROR
:c.Error
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.SERVICEREQUEST
:c.ServiceRequest
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.SERVICERESULT
:c.ServiceResult
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.SERVICEERROR
:c.ServiceError
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.SERVICEACCESSDENIED
:c.ServiceAccessDenied
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.REMOTEREQUESTS
:c.RemoteRequests
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.REGISTRATION
:c.Registration
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.DEPRECATED
:c.Deprecated
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:row.
:c.DEBUG
:c.Debug
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:etable.
:table cols='* * * 2*'.
:tcap.Definition of map class STAF/Service/Trace/Service
:tnote text='Description'.This map class represents the services and their
trace states.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.:xph.<ServiceName>:exph.
:c.:xph.<ServiceName>:exph.
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled':exph.
:tnote text='Notes'.
This map is dynamically generated at the time of the :xph.LIST:exph. request
based on the services in the trace status list at that time.  It's keys
will be the names of the internal services plus any external services that
have been registered and any other services for which tracing has been
explicitly set.
:etnote.
:etable.

:h4.Examples
:ul.
:li.:hp2.Goal&colon.:ehp2. Display the current tracing information
:p.:hp2.Syntax&colon.:ehp2. :xph.LIST:exph. &nbsp;or&nbsp; :xph.LIST SETTINGS:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:

:xmp.
{
  Tracing To           : Stdout
  Default Service State: Enabled
  Trace Points         : {
    Info               : Disabled
    Warning            : Enabled
    Error              : Enabled
    ServiceRequest     : Disabled
    ServiceResult      : Disabled
    ServiceError       : Disabled
    ServiceAccessDenied: Disabled
    RemoteRequests     : Disabled
    Registration       : Disabled
    Deprecated         : Enabled
    Debug              : Disabled
  }
  Services             : {
    DELAY   : Enabled
    DIAG    : Disabled
    ECHO    : Enabled
    EMAIL   : Enabled
    EVENT   : Enabled
    FS      : Enabled
    HANDLE  : Enabled
    HELP    : Disabled
    LOG     : Enabled
    MONITOR : Enabled
    MISC    : Enabled
    PING    : Enabled
    PROCESS : Enabled
    QUEUE   : Enabled
    SEM     : Enabled
    SERVICE : Enabled
    SHUTDOWN: Enabled
    STAX    : Enabled
    TRACE   : Enabled
    TRUST   : Enabled
    VAR     : Enabled
  }
}
:exmp.
:eul.
.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.SET
:i3.TRACE service
:ih1.tracing
:i2.trace service
:h3 id=tracesrvSet.Set
:p. Allows you to set the destination for the tracing information, or the default tracing state for new services.
:h4.Syntax
:xmp.
SET DESTINATION TO <STDOUT | STDERR | FILE <File name> >
SET DEFAULTSERVICESTATE < Enabled | Disabled >
:exmp.
:p.:xph.DESTINATION TO:exph. indicates to set the destination for the tracing
information
:p.:xph.STDOUT:exph. indicates that trace messages should be sent to the
standard output device (Stdout)
:p.:xph.STDERR:exph. indicates that trace messages should be sent to the
standard error device (Stderr)
:p.:xph.FILE:exph. indicates that trace messages should be sent to the
indicated file.  Note that the path to the file must already exist. &varres.
:p.:xph.DEFAULTSERVICESTATE:exph. sets the default tracing state for services that have not yet
registered with STAF.  The default tracing state for services is enabled.  &varres.
:h4.Security
:p.&seclvl. 5.
:h4.Return Codes
:p.All return codes from SET are documented in :hdref refid=retcode..
:h4.Results
:p.For :xph.SET:exph. the result buffer will be empty
:h4.Examples
:ul.
:li.:hp2.Goal&colon.:ehp2. Send trace output to the standard error device
:p.:hp2.Syntax&colon.:ehp2. :xph.SET DESTINATION TO STDERR:exph.
:li.:hp2.Goal&colon.:ehp2. Send trace output to the file STAF.trc in the bin directory
under {STAF/Config/STAFRoot}
:p.:hp2.Syntax&colon:ehp2. :xph.SET DESTINATION TO FILE {STAF/Config/STAFRoot}/bin/STAF.trc:exph.
:li.:hp2.Goal&colon.:ehp2. Set default tracing state to 'Enabled' for new services;
:p.:hp2.Syntax&colon.:ehp2. :xph.SET DEFAULTSERVICESTATE Enabled:exph.
:eul.