AUDTERM (JANUS DEFINE parameter): Difference between revisions
mNo edit summary |
m (minor formatting) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<span class="pageSubtitle">Send terminal output to audit trail</span> | |||
<span class="pageSubtitle" | |||
<var>AUDTERM</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port. | <var>AUDTERM</var> is a parameter on <var>[[JANUS DEFINE]]</var>, which defines and sets characteristics of a Janus port. | ||
| Line 8: | Line 7: | ||
<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 | Note that some "print output" can be "captured" on a Sirius [[$lists|$list]], a Janus [[Janus Sockets|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 client|Determining which output is sent to the client]] and [[$Sock_Capture#Print capturing hierarchy and other considerations|Print capturing hierarchy and other considerations]]. | ||
On a <var>[[JANUS DEFINE#type|WEBSERV]]</var> port: | On a <var>[[JANUS DEFINE#type|WEBSERV]]</var> port: | ||
<ul> | <ul> | ||
<li>Even with <var>AUDTERM</var> set on a <var>WEBSERV</var> port, terminal output is not sent to the audit trail if <var>[[$Web_On]]</var> is explicitly or implicitly set. </li> | |||
<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 <var>[[JANUS WEB ON]]</var> rule. </li> | |||
<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 <var>[[JANUS WEB ON]]</var> rule. | |||
</ul> | </ul> | ||
On a <var>[[JANUS DEFINE#type|SRVSOCK]]</var> port: | On a <var>[[JANUS DEFINE#type|SRVSOCK]]</var> port: | ||
<ul> | <ul> | ||
<li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) for a socket can be changed using the <var>[[$Sock_Set]]</var> function or the Socket object method Set. </li> | |||
<li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) for a socket can be changed using the $ | |||
</ul> | </ul> | ||
This parameter applies to all Janus "server" port types, and the default setting is <var>NOAUDTERM</var>. | This parameter applies to all Janus "server" port types, and the default setting is <var>NOAUDTERM</var>. | ||
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 <var>[[JANUS DEFINE#type|SDS]]</var> or <var>[[JANUS DEFINE#type|OPENSERV]]</var> 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>, <var>OPENSERV</var>, or <var>SRVSOCK</var> applications that want to explicitly audit information, the <var class="product">SOUL</var> <var>Audit</var> statement should be used, not the <var>Print</var> statement. | |||
Valid for <var>WEBSERV</var>, <var> | Valid for <var>WEBSERV</var>, <var>SDS</var>, <var>OPENSERV</var>, or <var>SRVSOCK</var> port types. | ||
Not valid for <var>[[JANUS DEFINE#type|CLSOCK]]</var> or <var>[[JANUS DEFINE#type|DEBUGGERCLIENT]]</var> port types. | Not valid for <var>[[JANUS DEFINE#type|CLSOCK]]</var> or <var>[[JANUS DEFINE#type|DEBUGGERCLIENT]]</var> port types. | ||
| Line 35: | Line 33: | ||
<li>[[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]] | <li>[[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]] | ||
</ul> | </ul> | ||
[[Category:JANUS DEFINE parameters|AUDTERM]] | [[Category:JANUS DEFINE parameters|AUDTERM]] | ||
Latest revision as of 18:22, 8 June 2016
Send terminal output to audit trail
AUDTERM is a parameter on JANUS DEFINE, which defines and sets characteristics of a Janus port.
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 Determining 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.
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 want to explicitly audit information, the SOUL 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.