AUDTERM (JANUS DEFINE parameter): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 6: | Line 6: | ||
This parameter is used to control whether the server thread sends "non-compiler terminal output" to the audit trail. Compiler terminal output is always sent to the audit trail. Any terminal output sent to the audit trail is sent as RK lines. | This parameter is used to control whether the server thread sends "non-compiler terminal output" to the audit trail. Compiler terminal output is always sent to the audit trail. Any terminal output sent to the audit trail is sent as RK lines. | ||
<var>AUDTERM</var> specifies that terminal output '''is sent''' to the audit trail; NOAUDTERM, which is the default port setting, specifies that (non-compiler) terminal output '''is not sent''' to the audit trail. | <var>AUDTERM</var> specifies that terminal output '''is sent''' to the audit trail; <var>[[NOAUDTERM (JANUS DEFINE parameter)|NOAUDTERM]]</var>, which is the default port setting, specifies that (non-compiler) terminal output '''is not sent''' to the audit trail. | ||
Note that some "print output" can be "captured" on a Sirius $list, a Janus Socket, or a USE output stream, and thus it would not be sent as terminal output -- to the audit trail or anywhere else. For further description of terminal output, see :hdref refid=outpcli.. see :hdref refid=prtcap.. see the ''Janus Web Server Reference Manual'' or ''Janus Sockets Reference Manual''. | Note that some "print output" can be "captured" on a Sirius $list, a Janus Socket, or a USE output stream, and thus it would not be sent as terminal output -- to the audit trail or anywhere else. For further description of terminal output, see :hdref refid=outpcli.. see :hdref refid=prtcap.. see the ''Janus Web Server Reference Manual'' or ''Janus Sockets Reference Manual''. | ||
| Line 14: | Line 14: | ||
<li>Even with <var>AUDTERM</var> set on a WEB port, terminal output is not sent to the audit trail if $Web_On is explicitly or implicitly set. | <li>Even with <var>AUDTERM</var> set on a WEB port, terminal output is not sent to the audit trail if $Web_On is explicitly or implicitly set. | ||
<li>The setting of <var>AUDTERM</var> (or NOAUDTERM) applies to all URLs on a WEB port unless explicitly overridden by a NOAUDTERM (or <var>AUDTERM</var>) parameter on a JANUS WEB ON rule. | <li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) applies to all URLs on a WEB port unless explicitly overridden by a <var>NOAUDTERM</var> (or <var>AUDTERM</var>) parameter on a JANUS WEB ON rule. | ||
</ul> | </ul> | ||
| Line 21: | Line 21: | ||
<ul> | <ul> | ||
<li>The setting of <var>AUDTERM</var> (or NOAUDTERM) for a socket can be changed using the $SOCK_SET function or the Socket object method Set. | <li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) for a socket can be changed using the $SOCK_SET function or the Socket object method Set. | ||
</ul> | </ul> | ||
Starting with Version 6.0, this parameter applies to all Janus "server" port types, and the default setting is NOAUDTERM. Prior to this, the parameter only applied to WEB ports, and the default setting was <var>AUDTERM</var>. | Starting with Version 6.0, this parameter applies to all Janus "server" port types, and the default setting is <var>NOAUDTERM</var>. Prior to this, the parameter only applied to WEB ports, and the default setting was <var>AUDTERM</var>. | ||
This introduces a small incompatibility. Starting with Version 6.0, compared to earlier versions, any WEB port connection without an explicit <var>AUDTERM</var> or NOAUDTERM will probably generate fewer audit trail lines, as will any SDS or OPENSERV port. This should be a benefit, since most of this output is either uninteresting or already logged to the audit trail as ER, AD or MS lines. Logging these messages as RK lines as well is just a waste of journal space and I/O and makes application diagnosis and debugging from the audit trail more difficult because of the extra noise data. For WEB, OPENSERV, or SRVSOCK applications that wish to explicitly audit information, the User Language AUDIT statement should be used, not the PRINT statement. | This introduces a small incompatibility. Starting with Version 6.0, compared to earlier versions, any WEB port connection without an explicit <var>AUDTERM</var> or <var>NOAUDTERM</var> will probably generate fewer audit trail lines, as will any SDS or OPENSERV port. This should be a benefit, since most of this output is either uninteresting or already logged to the audit trail as ER, AD or MS lines. Logging these messages as RK lines as well is just a waste of journal space and I/O and makes application diagnosis and debugging from the audit trail more difficult because of the extra noise data. For WEB, OPENSERV, or SRVSOCK applications that wish to explicitly audit information, the User Language AUDIT statement should be used, not the PRINT statement. | ||
Valid for WEBSERV, SDS, OPENSERV, or SRVSOCK port types. | Valid for WEBSERV, SDS, OPENSERV, or SRVSOCK port types. | ||
Revision as of 19:55, 27 February 2012
<section begin="desc" />Send terminal output to audit trail.<section end="desc" />
AUDTERM is a parameter on JANUS DEFINE, which defines and sets characteristics of a Janus port. See the List of JANUS DEFINE parameters.
This parameter is used to control whether the server thread sends "non-compiler terminal output" to the audit trail. Compiler terminal output is always sent to the audit trail. Any terminal output sent to the audit trail is sent as RK lines.
AUDTERM specifies that terminal output is sent to the audit trail; NOAUDTERM, which is the default port setting, specifies that (non-compiler) terminal output is not sent to the audit trail.
Note that some "print output" can be "captured" on a Sirius $list, a Janus Socket, or a USE output stream, and thus it would not be sent as terminal output -- to the audit trail or anywhere else. For further description of terminal output, see :hdref refid=outpcli.. see :hdref refid=prtcap.. see the Janus Web Server Reference Manual or Janus Sockets Reference Manual.
On a WEB port:
- Even with AUDTERM set on a WEB port, terminal output is not sent to the audit trail if $Web_On is explicitly or implicitly set.
- The setting of AUDTERM (or NOAUDTERM) applies to all URLs on a WEB port unless explicitly overridden by a NOAUDTERM (or AUDTERM) parameter on a JANUS WEB ON rule.
On a SRVSOCK port:
- The setting of AUDTERM (or NOAUDTERM) for a socket can be changed using the $SOCK_SET function or the Socket object method Set.
Starting with Version 6.0, this parameter applies to all Janus "server" port types, and the default setting is NOAUDTERM. Prior to this, the parameter only applied to WEB ports, and the default setting was AUDTERM.
This introduces a small incompatibility. Starting with Version 6.0, compared to earlier versions, any WEB port connection without an explicit AUDTERM or NOAUDTERM will probably generate fewer audit trail lines, as will any SDS or OPENSERV port. This should be a benefit, since most of this output is either uninteresting or already logged to the audit trail as ER, AD or MS lines. Logging these messages as RK lines as well is just a waste of journal space and I/O and makes application diagnosis and debugging from the audit trail more difficult because of the extra noise data. For WEB, OPENSERV, or SRVSOCK applications that wish to explicitly audit information, the User Language AUDIT statement should be used, not the PRINT statement.
Valid for WEBSERV, SDS, OPENSERV, or SRVSOCK port types.
Not valid for CLSOCK or DEBUGGERCLIENT port types.
References
See: List of Janus commands | List of JANUS DEFINE parameters.