AUDTERM (JANUS DEFINE parameter): Difference between revisions
m (1 revision) |
mNo edit summary |
||
| Line 8: | Line 8: | ||
<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. | <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 | 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 [[Janus Web Server Application Coding | ||
Considerations#Determining which output is sent to the clientDetermining which output is sent to the client]] and [[$Sock_Capture#Print_capturing_hierarchy_and_other_considerations|"Print_capturing_hierarchy_and_other_considerations|]]. | |||
On a | On a <var>[[JANUS DEFINE#type|WEBSERV]]</var> port: | ||
<ul> | <ul> | ||
<li>Even with <var>AUDTERM</var> set on a | <li>Even with <var>AUDTERM</var> set on a <var>WEBSERV</var> 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 <var>NOAUDTERM</var>) applies to all URLs on a | <li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) applies to all URLs on a <var>WEBSERV</var> port unless explicitly overridden by a <var>NOAUDTERM</var> (or <var>AUDTERM</var>) parameter on a JANUS WEB ON rule. | ||
</ul> | </ul> | ||
| Line 23: | Line 24: | ||
<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. | <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> | ||
This parameter applies to all Janus "server" port types, and the default setting is <var>NOAUDTERM</var>. | |||
Starting with Version 6.0, compared to earlier versions, any <var>WEBSERV</var> 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 <var>WEBSERV</var>, OPENSERV, or <var>SRVSOCK</var> applications that wish to explicitly audit information, the User Language <var>Audit</var> statement should be used, not the <var>Print</var> statement. | |||
Valid for <var>[[JANUS DEFINE#type|WEBSERV]]</var>, SDS, OPENSERV, or <var>[[JANUS DEFINE#type|SRVSOCK]]</var> port types. | Valid for <var>[[JANUS DEFINE#type|WEBSERV]]</var>, SDS, OPENSERV, or <var>[[JANUS DEFINE#type|SRVSOCK]]</var> port types. | ||
Revision as of 17:15, 29 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 [[Janus Web Server Application Coding Considerations#Determining which output is sent to the clientDetermining which output is sent to the client]] and "Print_capturing_hierarchy_and_other_considerations|.
On a WEBSERV port:
- Even with AUDTERM set on a WEBSERV 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 WEBSERV 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.
This parameter applies to all Janus "server" port types, and the default setting is NOAUDTERM.
Starting with Version 6.0, compared to earlier versions, any WEBSERV 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 WEBSERV, 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.