Difference between revisions of "SET PROFILE"

From Recital Documentation Wiki
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{YLM to do}}
 
 
==Class==
 
Performance and Optimization
 
 
 
 
==Purpose==
 
==Purpose==
 
+
Control profiling
  
  
 
==Syntax==
 
==Syntax==
SET PROFILE ON | OFF
 
 
 
SET PROFILE TO <command>, <id> [, <description>]
 
SET PROFILE TO <command>, <id> [, <description>]
 +
 +
SET PROFILE ON | OFF
  
  
 
==See Also==
 
==See Also==
[[CLEAR PROFILE]], [[DEBUG]], [[DISPLAY PROFILE]], [[DO]], [[LIST PROFILE]], [[PROFILE]], [[SET CLUSTERING]], [[SET COMPILE]], [[SET DCACHE]], [[SET DEVELOPMENT]], [[SET ICACHE]], [[SET IOLOGGING]], [[SET IOSTATS]], [[SET LOCKTYPE]], [[SET REPLICATION]], [[SET SYSLOGGING]]
+
[[CLEAR PROFILE]], [[DEBUG]], [[DISPLAY PROFILE]], [[DO]], [[LIST PROFILE]], [[PROFILE]], [[SET COMPILE]], [[SET DCACHE]], [[SET DEVELOPMENT]], [[SET ICACHE]], [[SET IOLOGGING]], [[SET IOSTATS]], [[SET LOCKTYPE]], [[SET NETWORK]], [[SET REPLICATION]], [[SET SYSLOGGING]]
  
  
 
==Description==
 
==Description==
 +
The SET PROFILE command controls Recital's profiling functionality.  Profiling produces input/output, locking and procedure call statistics for a particular application or part of an application. This information can be used for analysis to enable application optimization and general performance tuning.  The profiling information can be output to the screen, a file or a printer using the LIST PROFILE and DISPLAY PROFILE commands.
  
 +
 +
====TO <command>, <id> [, <description>]====
 +
SET PROFILE TO <command>, <id> [, <description>] is used to start, stop or update the profiling statistics.
 +
 +
 +
{| class="wikitable"
 +
|-
 +
!Keyword||Description
 +
|-
 +
|<command>||"start" - start a new profile for this <id>
 +
"stop" - stop the profile for this <id>
 +
 +
"update" - update an existing profile for this <id>
 +
|-
 +
|<id>||a unique reference for the profile of up to 10 characters.
 +
|-
 +
|<description>||optional descriptive comment
 +
|}
 +
 +
 +
====ON | OFF====
 +
SET PROFILE ON | OFF enables or disables profiling.  When SET PROFILE is OFF, no statistics are logged.
 +
 +
 +
The PROFILE command can also be used to log statistics for a particular command or an entire program or application and will automatically list the statistics to the screen.  CLEAR PROFILE is used to reset the log.
  
  
Line 26: Line 46:
 
<code lang="recital">
 
<code lang="recital">
 
set profile on
 
set profile on
set profile to "start", "myapp"
+
set profile to "start", "myapp", "Start of update section"
 +
//...
 
</code>
 
</code>
 +
  
 
==Products==
 
==Products==
 +
Recital Server, Recital
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Commands]]
 
[[Category:Commands]]
 
[[Category:Set_Commands|PROFILE]]
 
[[Category:Set_Commands|PROFILE]]
 +
[[Category:Performance and Optimization]]
 +
[[Category:Performance and Optimization Set Commands]]

Latest revision as of 14:40, 13 January 2010

Purpose

Control profiling


Syntax

SET PROFILE TO <command>, <id> [, <description>]

SET PROFILE ON | OFF


See Also

CLEAR PROFILE, DEBUG, DISPLAY PROFILE, DO, LIST PROFILE, PROFILE, SET COMPILE, SET DCACHE, SET DEVELOPMENT, SET ICACHE, SET IOLOGGING, SET IOSTATS, SET LOCKTYPE, SET NETWORK, SET REPLICATION, SET SYSLOGGING


Description

The SET PROFILE command controls Recital's profiling functionality. Profiling produces input/output, locking and procedure call statistics for a particular application or part of an application. This information can be used for analysis to enable application optimization and general performance tuning. The profiling information can be output to the screen, a file or a printer using the LIST PROFILE and DISPLAY PROFILE commands.


TO <command>, <id> [, <description>]

SET PROFILE TO <command>, <id> [, <description>] is used to start, stop or update the profiling statistics.


Keyword Description
<command> "start" - start a new profile for this <id>

"stop" - stop the profile for this <id>

"update" - update an existing profile for this <id>

<id> a unique reference for the profile of up to 10 characters.
<description> optional descriptive comment


ON | OFF

SET PROFILE ON | OFF enables or disables profiling. When SET PROFILE is OFF, no statistics are logged.


The PROFILE command can also be used to log statistics for a particular command or an entire program or application and will automatically list the statistics to the screen. CLEAR PROFILE is used to reset the log.


Example

set profile on
set profile to "start", "myapp", "Start of update section"
//...


Products

Recital Server, Recital