diagsrv.script

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

:c.To Date-Time
:c.&stringObj.
:c.&timestampFormat.
:row.
:c.elapsedTime
:c.Elapsed Time
:c.&stringObj. | &noneObj.
:c.:xph.<[H]HH&colon.MM&colon.SS>:exph.
:row.
:c.trigger
:c.Trigger
:c.&stringObj.
:c.
:row.
:c.numberOfSources
:c.Number of Sources
:c.&stringObj.
:c.
:row.
:c.sourceList
:c.Sources
:c.:xph.<List> of <Map&colon.STAF/Service/Diag/SourceCount>:exph.
:c.
:tnote text='Notes'.
:ol compact.
:li."From Date-Time" specifies the date/time that diagnostics
were first enabled or last reset, or &noneObj. if diagnostics have never
been enabled.
:li."To Date-Time" specifies the date/time that diagnostics
were disabled or, if still enabled, the current time.
:li."Elapsed Time" specifies the difference between the
"From Date-Time" and the "To Date-Time" in hours,
minutes, and seconds, or &noneObj. if diagnostics have never been enabled.
:li."Number of Sources" specifies the number of unique
sources that have recorded diagnostics for the specified trigger.
:li.See table :tref refid=diagSourceCountTable. for the map class definition of
:xph.<Map&colon.STAF/Service/Diag/SourceCount>:exph..
:eol.
:etnote.
:etable.
:p.
:li.:xph.LIST SOURCE <Source>:exph.
:p.
The result buffer for a :xph."LIST SOURCE <Source>":exph. request
will contain a marshalled
:xph.<Map&colon.STAF/Service/Diag/SourceInfo>:exph.
representing the diagnostics information for all of the unique triggers
that have been recorded for the specified source.
The maps are defined as follows:
:table cols='* * 2* *'.
:tcap.Definition of map class STAF/Service/Diag/SourceInfo
:tnote text='Description'.This map class represents the diagnostics
information for the specified source.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.fromTimestamp
:c.From Date-Time
:c.&stringObj. | &noneObj.
:c.&timestampFormat.
:row.
:c.toTimestamp
:c.To Date-Time
:c.&stringObj.
:c.&timestampFormat.
:row.
:c.elapsedTime
:c.Elapsed Time
:c.&stringObj. | &noneObj.
:c.:xph.<[H]HH&colon.MM&colon.SS>:exph.
:row.
:c.source
:c.Source
:c.&stringObj.
:c.
:row.
:c.numberOfTriggers
:c.Number of Triggers
:c.&stringObj.
:c.
:row.
:c.triggerList
:c.Triggers
:c.:xph.<List> of <Map&colon.STAF/Service/Diag/TriggerCount>:exph.
:c.
:tnote text='Notes'.
:ol compact.
:li."From Date-Time" specifies the date/time that diagnostics
were first enabled or last reset, or &noneObj. if diagnostics have never
been enabled.
:li."To Date-Time" specifies the date/time that diagnostics
were disabled or, if still enabled, the current time.
:li."Elapsed Time" specifies the difference between the
"From Date-Time" and the "To Date-Time" in hours,
minutes, and seconds, or &noneObj. if diagnostics have never been enabled.
:li."Number of Triggers" specifies the number of unique
triggers that have been recorded for the specified source.
:li.See table :tref refid=diagTriggerCountTable. for the map class definition of
:xph.<Map&colon.STAF/Service/Diag/TriggerCount>:exph..
:eol.
:etnote.
:etable.
:p.
:li.:xph.LIST SETTINGS:exph.
:p.
The result buffer for a :xph."LIST SETTINGS":exph. request
will contain a marshalled
:xph.<Map&colon.STAF/Service/Diag/Settings>:exph.
representing the current operational settings for the DIAG service.
The maps are defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Diag/Settings
:tnote text='Description'.This map class represents the current
operational settings for the DIAG service.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.diagnostics
:c.Diagnostics
:c.&stringObj.
:c.:xph.'Enabled' | 'Disabled'.:exph.
:row.
:c.lastResetTimestamp
:c.Last Reset / First Enabled
:c.&stringObj. | &noneObj.
:c.&timestampFormat.
:row.
:c.lastDisabledTimestamp
:c.Last Disabled
:c.&stringObj.
:c.&timestampFormat.
:tnote text='Notes'.
:ol compact.
:li."Diagnostics" specifies if recording diagnostics is 
currently enabled or disabled.
:li."Last Reset / First Enabled" specifies the timestamp when diagnostics
were last reset or first enabled or &noneObj. if diagnostics have never
been reset since STAF was started.
:li."Last Disabled" specifies the timestamp when diagnostics
were last disabled or last cleared via the RESET command.
It is initially set to the date/time when STAF was started.
:eol.
:etnote.
:etable.
:eul.

:h4.Examples

:ul.
:li.:hp2.Goal::ehp2.&nbsp; Show me all the trigger/source combinations that
have been recorded (sorted in descending order by count, the
default).
:p.:hp2.Syntax::ehp2.&nbsp; :xph.LIST:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp.
{
  From Date-Time             : 20040926-12:15:04
  To Date-Time               : 20040926-12:20:05
  Elapsed Time               : 00:05:01
  Number of Triggers         : 3
  Number of Sources          : 2
  Trigger/Source Combinations: [
    {
      Trigger: MYSERVICE QUERY
      Source : MyApp;machine1.austin.ibm.com;77
      Count  : 10
    }
    { 
      Trigger: MYSERVICE QUERY
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 7
    }
    {
      Trigger: SAMPLE1 QUERY
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 4
    }
    {
      Trigger: MYSERVICE LIST
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 1
    }
  ]
}
:exmp.
:p.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Show me all the triggers and sources that have been
recorded sorted in ascending order by trigger.
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST SORTBYTRIGGER:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp.
{
  From Date-Time             : 20040926-12:15:04
  To Date-Time               : 20040926-12:21:09
  Elapsed Time               : 00:06:05
  Number of Triggers         : 3
  Number of Sources          : 2
  Trigger/Source Combinations: [
    {
      Trigger: MYSERVICE LIST
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 1
    }
    {
      Trigger: MYSERVICE QUERY
      Source : MyApp;machine1.austin.ibm.com;77
      Count  : 10
    }
    {
      Trigger: MYSERVICE QUERY
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 7
    }
    {
      Trigger: SAMPLE1 QUERY
      Source : myApp2;machine1.austin.ibm.com;97
      Count  : 4
    }
  ]
}
:exmp.
:p.
:li.:hp2.Goal&colon.:ehp2.&nbsp;  Show me all the triggers that have been recorded,
sorted by trigger in ascending order.
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST TRIGGERS SORTBYTRIGGER:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp.
{
  From Date-Time    : 20040926-12:15:04
  To Timestamp      : 20040926-12:28:20
  Elapsed Time      : 00:13:16
  Number of Triggers: 3
  Triggers          : [
    {
      Trigger: MYSERVICE LIST
      Count  : 1
    }
    {
      Trigger: MYSERVICE QUERY
      Count  : 17
    }
    {
      Trigger: SAMPLE1 QUERY
      Count  : 4
    }
  ]
}
:exmp.
:p.
:li.:hp2.Goal&colon.:ehp2.&nbsp;  Show me all the sources that have been recorded
(sorted by count in descending order, the default).
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST SOURCES:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp.
{
  From Date-Time   : 20040926-12:15:04
  To Date-Time     : 20040926-12:32:53
  Elapsed Time     : 00:17:49
  Number of Sources: 2
  Sources          : [
    {
      Source: MyApp;machine1.austin.ibm.com;77
      Count : 10
    }
    {
      Source: MyApp2;machine1.austin.ibm.com;97
      Count : 12
    }
  ]
}
:exmp.
:p.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Show me all of the sources for trigger
:xph."MYSERVICE QUERY":exph., sorted by source in ascending order.
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST TRIGGER "MYSERVICE QUERY" SORTBYSOURCE:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp.
{
  From Date-Time   : 20040926-12:15:04
  To Date-Time     : 20040926-12:36:18
  Elapsed Time     : 00:21:14
  Trigger          : MYSERVICE QUERY
  Number of Sources: 2
  Sources          : [
    {
      Source: MyApp;machine1.austin.ibm.com;77
      Count : 10
    }
    {
      Source: MyApp2;machine1.austin.ibm.com;97
      Count : 7
    }
  ]
}      
:exmp.
:p.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Show me all of the triggers for source
:xph."MyApp2;machine1.austin.ibm.com;97":exph. (sorted by count in 
descending order, the default).
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST SOURCE "MyApp2;machine1.austin.ibm.com;97":exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in verbose format, could look like:
:xmp. 
{
  From Date-Time    : 20040926-12:15:04
  To Date-Time      : 20040926-12:40:08
  Elapsed Time      : 00:25:04
  Source            : MyApp2;machine1.austin.ibm.com;97
  Number of Triggers: 3
  Triggers          : [
    {
      Trigger: MYSERVICE QUERY
      Count  : 7
    }
    {
      Trigger: SAMPLE1 QUERY
      Count  : 4
    }
    {
      Trigger: MYSERVICE LIST
      Count  : 1
    }
  ]
}
:exmp.
:p. 
:li.:hp2.Goal&colon.:ehp2.&nbsp; Show me the current operational settings.
:p.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.LIST SETTINGS:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the
command line, the result, in default format, could look like:
:xmp.
Diagnostics               : Enabled
Last Reset / First Enabled: 20040926-12:15:04
Last Disabled             : 20040926-12:14:53
:exmp.
:eul.
.*
:ih1.service commands
:ih2.RESET
:i3.Diagnostics (DIAG) service
:h3 id=diagReset.RESET
:p.RESET allows you to clear all data from the diagnostics map.
:h4.Syntax
:xmp.
RESET FORCE
:exmp.
:p.:xph.FORCE:exph. is a confirmation that you want to clear all data.
:h4.Security
:p.&seclvl. 4.
:h4.Return Codes
:p.All return codes from RESET are documented in :hdref refid=retcode..
:h4.Results
:p.The result buffer will contain no data on a successful return from a
RESET command.
:h4.Examples
:sl compact.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Remove all information in the diagnostics map.
:li.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.RESET FORCE:exph.
:esl.
.*
:ih1.service commands
:ih2.ENABLE
:i3.Diagnostics (DIAG) service
:h3 id=diagEnable.ENABLE
:p.ENABLE allows you to enable recording diagnostics.
:note.You may also enable diagnostics when STAF starts by setting
operational parameter :xph.ENABLEDIAGS:exph. in the STAF configuration
file.
:h4.Syntax
:xmp.
ENABLE
:exmp.
:h4.Security
:p.&seclvl. 4.
:h4.Return Codes
:p.All return codes from ENABLE are documented in :hdref refid=retcode..
:h4.Results
:p.The result buffer will contain no data on a successful return from a
ENABLE command.
:h4.Examples
:sl compact.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Enable recording diagnostics.
:li.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.ENABLE:exph.
:esl.
.*
:ih1.service commands
:ih2.DISABLE
:i3.Diagnostics (DIAG) service
:h3 id=diagDisable.DISABLE
:p.DISABLE allows you to disable recording diagnostics.
:h4.Syntax
:xmp.
DISABLE
:exmp.
:h4.Security
:p.&seclvl. 4.
:h4.Return Codes
:p.All return codes from DISABLE are documented in :hdref refid=retcode..
:h4.Results
:p.The result buffer will contain no data on a successful return from a
DISABLE command.
:h4.Examples
:sl compact.
:li.:hp2.Goal&colon.:ehp2.&nbsp; Disable recording diagnostics.
:li.:hp2.Syntax&colon.:ehp2.&nbsp; :xph.DISABLE:exph.
:esl.