NOAUDTERM (JANUS DEFINE parameter): Difference between revisions
mNo edit summary |
m (show "JANUS DEFINE parameter" in title) |
||
| (21 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<span class="pageSubtitle">Suppress non-compiler terminal output from audit</span> | |||
<span class="pageSubtitle" | |||
NOAUDTERM is a parameter on [[JANUS DEFINE]], which defines and sets characteristics of a Janus port | <var>NOAUDTERM</var> is a parameter on <var>[[JANUS DEFINE]]</var>, 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. | 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. | ||
NOAUDTERM, which is the default port setting, specifies that (non-compiler) terminal output '''is not sent''' to the audit trail; <var>[[AUDTERM (JANUS DEFINE parameter)|AUDTERM]]</var> specifies that terminal output '''is sent''' to the audit trail. | <var>NOAUDTERM</var>, which is the default port setting, specifies that (non-compiler) terminal output '''is not sent''' to the audit trail; <var>[[AUDTERM (JANUS DEFINE parameter)|AUDTERM]]</var> specifies that terminal output '''is 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 $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. | ||
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 <var>[[$Web_On]]</var> is explicitly or implicitly set. | ||
<li>The setting of <var>AUDTERM</var> (or NOAUDTERM) 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 <var>[[JANUS WEB ON]]</var> rule. | ||
</ul> | </ul> | ||
On a SRVSOCK port: | On a <var>[[JANUS DEFINE#type|SRVSOCK]]</var> port: | ||
<ul> | <ul> | ||
<li>The setting of <var>AUDTERM</var> (or NOAUDTERM) for a socket can be changed using the $Sock_Set function. | <li>The setting of <var>AUDTERM</var> (or <var>NOAUDTERM</var>) for a socket can be changed using the <var>[[$Sock_Set]]</var> function. | ||
</ul> | </ul> | ||
This parameter applies to all Janus "server" port types, and the default setting is NOAUDTERM. | 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 that does not specify either <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 terminal 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 wish to explicitly audit information, the <var class="product">User Language</var> <var>Audit</var> statement should be used, not the <var>Print</var> statement. | |||
Valid for WEBSERV, SDS, OPENSERV, or SRVSOCK port types. | Valid for <var>WEBSERV</var>, <var>SDS</var>, <var>OPENSERV</var>, or <var>SRVSOCK</var> port types. | ||
Not valid for CLSOCK or DEBUGGERCLIENT port types. | Not valid for <var>CLSOCK</var> or <var>[[JANUS DEFINE#type|DEBUGGERCLIENT]]</var> port types. | ||
== | ==See also== | ||
<ul> | |||
<li>[[List of Janus commands]] | |||
<li>[[JANUS DEFINE#parmlist|List of JANUS DEFINE parameters]] | |||
</ul> | |||
[[Category:JANUS DEFINE parameters|NOAUDTERM]] | [[Category:JANUS DEFINE parameters|NOAUDTERM]] | ||
Latest revision as of 15:47, 23 April 2015
Suppress non-compiler terminal output from audit
NOAUDTERM 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.
NOAUDTERM, which is the default port setting, specifies that (non-compiler) terminal output is not sent to the audit trail; AUDTERM specifies that terminal output is 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.
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.
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 that does not specify either 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 terminal 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.