SirScan setup - Revision history

JAL: /* SIRSCAN subsystem definition */ add link

2017-06-06T22:11:01Z

SIRSCAN subsystem definition: add link

← Older revision		Revision as of 22:11, 6 June 2017
Line 148:		Line 148:
	==SIRSCAN subsystem definition==		==SIRSCAN subsystem definition==
	<var class="product">SirScan</var> is a full-screen utility (the <code>SIRSCAN</code> [[Application Subsystem development\|subsystem]]) that allows users in a <var class="product">Model 204</var>		<var class="product">SirScan</var> is a full-screen utility (the <code>SIRSCAN</code> [[Application Subsystem development\|subsystem]]) that allows users in a <var class="product">Model 204</var>
	Online to view the contents of the journal. As of RKTools 7.7, <var class="product">SirScan</var> functionality is also available in the RKWeb browser interface.		Online to view the contents of the journal. As of RKTools 7.7, <var class="product">SirScan</var> functionality is also available in the [[RKWeb]] browser interface.

	<var class="product">SirScan</var> permits		<var class="product">SirScan</var> permits

JAL: /* SIRSCAN subsystem definition */ mention RKWeb

2017-05-17T00:43:18Z

SIRSCAN subsystem definition: mention RKWeb

← Older revision		Revision as of 00:43, 17 May 2017
Line 147:		Line 147:

	==SIRSCAN subsystem definition==		==SIRSCAN subsystem definition==
	<var class="product">SirScan</var> is a full-screen utility (the <code>SIRSCAN</code> [[Application Subsystem development\|subsystem]]) that allows users in a <var class="product">Model 204</var>		<var class="product">SirScan</var> is a full-screen utility (the <code>SIRSCAN</code> [[Application Subsystem development\|subsystem]]) that allows users in a <var class="product">Model 204</var>
	Online to ~~browse~~ the contents of the journal.		Online to view the contents of the journal. As of RKTools 7.7, <var class="product">SirScan</var> functionality is also available in the RKWeb browser interface.

	<var class="product">SirScan</var> permits		<var class="product">SirScan</var> permits
	"ordinary" users to view journal entries generated by their own		"ordinary" users to view journal entries generated by their own
Line 156:		Line 157:
	In addition, you can request any combination of specific journal record types.		In addition, you can request any combination of specific journal record types.

	<var class="product">SirScan</var> lets you view an ordinary journal ~~dataset~~ or any member of a ring journal, including the offload data sets if they are not on tape. Even the current unflushed contents of the journal buffer(s) are included in the display, without you having to know		<var class="product">SirScan</var> lets you view an ordinary journal data set or any member of a ring journal, including the offload data sets if they are not on tape. Even the current unflushed contents of the journal buffer(s) are included in the display, without you having to know
	what journal configuration is being used.		what journal configuration is being used.

JAL: minor formatting

2015-11-03T23:31:33Z

minor formatting

Show changes

JAL: link repair

2015-10-29T18:28:31Z

link repair

← Older revision		Revision as of 18:28, 29 October 2015
Line 4:		Line 4:
	<!-- Page name: SirScan setup-->		<!-- Page name: SirScan setup-->

	As of Model 204 V7.5, the functions and facilities necessary to run <var class="product">SirScan</var> are built into the Model 204 kernel. For versions of Model 204 before 7.5, the installation of the <var class="product">[[~~Sirus~~ Mods]]</var> is required and sufficient to install and run the SIRSCAN subsystem, the <var class="product">SirScan</var> engine.		As of Model 204 V7.5, the functions and facilities necessary to run <var class="product">SirScan</var> are built into the Model 204 kernel. For versions of Model 204 before 7.5, the installation of the <var class="product">[[Sirius Mods]]</var> is required and sufficient to install and run the SIRSCAN subsystem, the <var class="product">SirScan</var> engine.

	In addition, optimal results using <var class="product">SirScan</var> require your attention to the settings of:		In addition, optimal results using <var class="product">SirScan</var> require your attention to the settings of:

JAL: typo

2015-10-22T20:37:28Z

typo

← Older revision		Revision as of 20:37, 22 October 2015
Line 4:		Line 4:
	<!-- Page name: SirScan setup-->		<!-- Page name: SirScan setup-->

	As of Model 204 V7.5~~, however~~, the functions and facilities necessary to run <var class="product">SirScan</var> are built into the Model 204 kernel. For versions of Model 204 before 7.5, the installation of the <var class="product">[[Sirus Mods]]</var> is required and sufficient to install and run the SIRSCAN subsystem, the <var class="product">SirScan</var> engine.		As of Model 204 V7.5, the functions and facilities necessary to run <var class="product">SirScan</var> are built into the Model 204 kernel. For versions of Model 204 before 7.5, the installation of the <var class="product">[[Sirus Mods]]</var> is required and sufficient to install and run the SIRSCAN subsystem, the <var class="product">SirScan</var> engine.

	In addition, optimal results using <var class="product">SirScan</var> require your attention to the settings of:		In addition, optimal results using <var class="product">SirScan</var> require your attention to the settings of:
	<ul>		<ul>
	<li>The Model 204 system parameters <var>SCANTIME</var> and <var>SCANPARM</var> </li>		<li>The Model 204 system parameters <var>SCANTIME</var> and <var>SCANPARM</var> </li>

	<li>The SIRSCAN subsystem user <var>SCLASS</var> controls </li>		<li>The SIRSCAN subsystem user <var>SCLASS</var> controls </li>
	</ul>		</ul>

JAL: /* See also */

2015-10-16T18:56:11Z

JAL: add graphic

2015-10-13T00:19:28Z

add graphic

← Older revision		Revision as of 00:19, 13 October 2015
Line 182:		Line 182:
	This setup screen is part of SIRADMIN, and can only be altered by privileged users.		This setup screen is part of SIRADMIN, and can only be altered by privileged users.

	<p class="caption">SirScan I/O and Record Caps</p>		<p class="caption" style="width:428px">SirScan I/O and Record Caps</p>
			<p class="figure">[[File:ScanSCLASS.png\|428px]]</p>

	Each of the six <var>SCLASS</var> options is assigned a limit to the physical I/O permitted for each journal scan, and the maximum number of records		Each of the six <var>SCLASS</var> options is assigned a limit to the physical I/O permitted for each journal scan, and the maximum number of records

JAL: add See also

2015-10-12T22:21:54Z

add See also

← Older revision		Revision as of 22:21, 12 October 2015
Line 202:		Line 202:
	<var>ADMIN_HI</var> to view journal entries for any user.		<var>ADMIN_HI</var> to view journal entries for any user.

	==~~SirScan topics==~~		==See also==
	~~The <var class="product">SirScan</var> documentation consists of the pages listed below.~~
	~~This list is also available as a "~~See also~~" link from each of the pages.~~

	~~For information about product changes and Model 204 feature~~
	~~support per <var class~~=~~"product">SirScan</var> version, see~~
	~~the [[M204wiki main page#Sirius Mods release notes\|release notes]].~~

	~~For information about product error messages, see [[:Category:Sirius Mods messages\|Sirius Mods messages]].~~

	{{Template: SirScan topic list}}		{{Template: SirScan topic list}}

	[[Category: SirScan]]		[[Category: SirScan]]
	[[Category:Sirius Software products]]		[[Category:Sirius Software products]]

Admin: 1 revision: SirScan doc from m204stage

2015-10-12T22:12:46Z

1 revision: SirScan doc from m204stage

← Older revision	Revision as of 22:12, 12 October 2015
(No difference)

JAL: misc formatting

2015-10-12T22:06:25Z

misc formatting

New page

As of Model 204 V7.5, however, the functions and facilities necessary to run <var class="product">SirScan</var> are built into the Model 204 kernel. For versions of Model 204 before 7.5, the installation of the <var class="product">[[Sirus Mods]]</var> is required and sufficient to install and run the SIRSCAN subsystem, the <var class="product">SirScan</var> engine.

In addition, optimal results using <var class="product">SirScan</var> require your attention to the settings of:
<ul>
<li>The Model 204 system parameters <var>SCANTIME</var> and <var>SCANPARM</var> </li>
<li>The SIRSCAN subsystem user <var>SCLASS</var> controls </li>
</ul>

<div id="sysprms"></div>
==Setting SirScan system parameters==


The "background" subsection below describes some native limitations in selecting and formatting journal entries that are remedied by functionality controlled by two User 0 parameters.

===Background===
The Model 204 journal records contain only a user
number and do not contain other potentially useful identifying information,
such as user ID, terminal ID, or IP address.
So when <var class="product">SirScan</var> scan specifications in the SIRSCAN subsystem are
based on things like userid, IP address, or port name, there is often no way
to determine whether a single journal entry is associated with the
requested attributes or not.

In very early versions of the product, selection criteria based on userid
would only work for currently logged on threads, and then only for journal
entries from the current session.
This is because, for logged in users, <var class="product">SirScan</var> can determine user number
and login time.
From these two pieces of information, it can be sure that all journal entries
for the thread associated with a requested userid, and with a date/time stamp
after the login time of the user, are associated with that user.

Outside of being very limiting — it was impossible to select journal
information based on userid for non-logged in users — <var class="product">SirScan</var> could also
produce anomalous behavior in [[SirScan browsing of the journal#autoref|auto-refresh mode]].
Because <var class="product">SirScan</var> only collects data from the previous end of the interval
when in auto-refresh mode, if a userid that was present and selected in a previous
interval logged off before the data is refreshed for the new interval, none
of the journal records for that user would appear between the end of the
previous interval and the end of the current.
Outside of the annoyance of not seeing the expected data, this could cause
confusion among <var class="product">SirScan</var> end-users, because a user's journal entries might
seem to suddenly stop without a logoff record or any other hint as to why.

In later versions, <var class="product">SirScan</var> made more of an effort to use information in the journal to associate journal
records with userids or other attributes not actually on the journal records.
For example, if <var class="product">SirScan</var> sees a M204.0352 message for a login, it knows that from that time on, all journal records for that thread number are associated
with the userid on the M204.0352 message, until the end of the interval or
a M204.0352 logout message is reached for that thread.

In a similar way, <var class="product">SirScan</var> could use the MSIR.0114 message, which indicates
a Janus port and client IP address for any Janus server request, to associate
a thread number with an IP address and port name.
Unfortunately, while this approach makes it possible to use non-thread-number
and non-thread-type based selection criteria for sessions that are no longer
active, it also makes <var class="product">SirScan</var>'s behavior even more anomalous and confusing:
whether or not a journal record is selected might depend on whether or not
<var class="product">SirScan</var> happened to see an identifying message in the journal for that thread. For example, if user MOE was logged on from 8:37 to 11:43, and a request for MOE's records is made for the interval 8:38 to 9:30, none of MOE's records are seen.
But if the selected interval was 8:37 to 9:30, they are all seen.

To fix the anomalous behaviors, <var class="product">SirScan</var> now uses
"heartbeat" messages: RK type audit messages that contain
identifying information about a thread such as userid, terminal ID, and IP address and port number for Janus server threads.
The heartbeat messages are controlled by the <var>SCANTIME</var> system parameter. And the <var>SCANPARM</var> parameter ensures <var class="product">SirScan</var>'s detection of the login of <var class="product">[[Janus Web Server]]</var> threads.

<div id="scantim"></div>
===Using the SCANTIME system parameter===


<var class="product">SirScan</var> heartbeat messages are controlled by the <var>[[SCANTIME parameter|SCANTIME]]</var> system parameter,
which must be set with the User 0 parameters in the CCAIN stream.
This parameter indicates the maximum number of seconds between journal
messages for a thread before a heartbeat message is issued.
If a message is about to be sent to the journal for a thread, and it has
been more than <var>SCANTIME</var> seconds since the last heartbeat message, then
the heartbeat message is first sent to the journal.
This means that if a journal message is found for a thread, the userid
and other identifying information can <b>always</b> be found by
looking backwards in the journal no more than <var>SCANTIME</var> seconds.

The default value for <var>SCANTIME</var> is 0, which means that heartbeat messages
are not logged.
If <var>SCANTIME</var> is set to a positive value up to its maximum value of 3600,
the <var class="product">SirScan</var> heartbeat messages will be logged to the journal.

If <var>SCANTIME</var> is set to a non-zero value, the SIRSCAN subsystem
detects this and, on the scan specification screen, gives users the
option of reading an extra <var>SCANTIME</var> seconds on every interval collected
from the journal.
The extra <var>SCANTIME</var> seconds read are before the start of the requested
interval.
While the data from the extra <var>SCANTIME</var> seconds worth of journal entries
is not formatted, it is scanned for the heartbeat messages, and any
information in those messages is saved for each thread.
In this way, all messages for all threads after the start of the requested
interval can be deterministically associated with a userid, terminal ID,
and IP address and Janus port for Janus server requests.

The cost of getting this deterministic behavior is the overhead of
scanning an extra <var>SCANTIME</var> seconds worth of journal.
If scanning is being done in auto-refresh mode, each refresh (attempt to
move past the current bottom) will cause an extra <var>SCANTIME</var> seconds to
be scanned.
This means that the setting of <var>SCANTIME</var> involves a trade-off between
the number of heartbeat messages logged to the journal and the overhead
of scanning an extra <var>SCANTIME</var> seconds of journal on every <var class="product">SirScan</var>
browse request.
The bigger the value of <var>SCANTIME</var>, the fewer heartbeat messages will
be logged, but the more journal records would need to be scanned on each
<var class="product">SirScan</var> browse request.
A small value of <var>SCANTIME</var> will, of course, have the opposite effect.

Since journal messages tend to be bunched (when a thread gets
one audit message logged it is likely to get several around the same
time), there is probably not a significantly higher cost to a relatively
small <var>SCANTIME</var>, like 10 or even 5, than to a much larger one, like 60.
On the other hand, the amount of extra work performed by <var class="product">SirScan</var> associated
with the extra <var>SCANTIME</var> second scan for each browse request will be roughly
proportional to the size of <var>SCANTIME</var>.
All this would suggest using a fairly small <var>SCANTIME</var>: a value of 10 might
be a good starting point.

If you are setting <var>SCANTIME</var> for the first time in an Online, it is prudent
to anticipate a 3% increase in journal usage, though the actual increase
will almost undoubtedly be much less than that (probably less than
even 1%).
<blockquote class="note"><b>Note:</b> The heartbeat message can even be useful outside of <var class="product">SirScan</var>. Since the heartbeat messages are regular RK type messages, they can be viewed with AUDIT204 as well as <var class="product">SirScan</var>.
<p>
This means that if one is using AUDIT204 for a previous run's journal,
and one wants to find entries for a particular userid in a particular
time interval, one can simply request from AUDIT204 all records for all
users in the desired interval plus <var>SCANTIME</var> seconds before.
By doing so, one can be certain that any messages formatted by AUDIT204
will be preceded by a message identifying the user associated with that
message. </p>
</blockquote>

<div id="scanprm"></div>
===Using the SCANPARM system parameter===


The second <var class="product">SirScan</var>-related User 0 parameter is <var>[[SCANPARM parameter|SCANPARM]]</var>.
This parameter is a collection of bits that indicate certain <var class="product">SirScan</var> behavior.

The <var>SCANPARM</var> bits are:
<table class="thJustBold">
<tr><th>X'01'</th>
<td>Allow non-system-manager users to browse journal entries for public requests on <var class="product">[[Janus Web Server]]</var> threads. Public requests are those that are not protected from access by userid.</td></tr>

<tr><th>X'02'</th>
<td>Issue a redundant <code>MSIR.0361 Processing request <i>method</i> <i>URL</i></code> message after login. Normally, MSIR.0361 is issued on web threads before login, since the method and URL are known before the userid and password, if a login is even required for the request.
<p>
Unless the X'02' <var>SCANPARM</var> bit is set, users browsing journal entries for <var class="product">Janus Web Server</var> threads based on userid do not see the MSIR.0361 message
(since it occurs before the login), so they have a difficult time ascertaining the method and URL being processed in a particular request.</p></td></tr>
</table>
The default for the <var>SCANPARM</var> parameter is X'00'.

==SIRSCAN subsystem definition==
<var class="product">SirScan</var> is a full-screen utility (the SIRSCAN [[Application Subsystem development|subsystem]]) that allows users in a <var class="product">Model 204</var>
Online to browse the contents of the journal.
<var class="product">SirScan</var> permits
"ordinary" users to view journal entries generated by their own
Online session, and it allows users in the <var>ADMIN</var> [[Application Subsystem development#User class|subsystem user class (SCLASS)]] to browse journal entries for any set of users.

The data displayed in <var class="product">SirScan</var> may be filtered by
date, time, <var>IODEV</var>, User (thread) number and UserID.
In addition, you can request any combination of specific journal record types.

<var class="product">SirScan</var> lets you view an ordinary journal dataset or any member of a ring journal, including the offload data sets if they are not on tape. Even the current unflushed contents of the journal
buffer(s) are included in the display, without you having to know
what journal configuration is being used.

===Updating the SirScan SCLASS maximums in SIRADMIN===
The SIRSCAN application subsystem (APSY) is distributed with a setup
screen that allows the subsystem manager to limit the amount of disk
I/O generated by users of <var class="product">SirScan</var> from each of the six subsystem user classes.
This setup screen is part of SIRADMIN, and can only be altered by privileged users.

<p class="caption">SirScan I/O and Record Caps</p>

Each of the six <var>SCLASS</var> options is assigned a limit to the physical I/O permitted for each journal scan, and the maximum number of records
<var class="product">SirScan</var> will format for the user.
The I/O settings prevent excessive
amounts of disk activity during journal scans, and the record maximum
prevents excessive use of CCATEMP.
If the subsystem is semi-public,
the default <var>SCLASS</var> value is treated the same as <var>USER_LO</var> for these limits.

A user's <var class="product">Model 204</var> privileges while in <var class="product">SirScan</var> are based on the user's <var>SCLASS</var>.
If they include System Administrator privileges, the user can
view any journal entries; otherwise the user can view entries only for
his or her own logon session.

You can change the <var>SCLASS</var> privileges with the subsystem management facility. The default <var>SCLASS</var> definitions
allow users in <var>USER_LO</var>, <var>USER_MED</var>, and <var>USER_HI</var> to view information only
for their own logon session, and allow users in <var>ADMIN_LO</var>, <var>ADMIN_MED</var>, and
<var>ADMIN_HI</var> to view journal entries for any user.

==SirScan topics==
The <var class="product">SirScan</var> documentation consists of the pages listed below.
This list is also available as a "See also" link from each of the pages.

For information about product changes and Model 204 feature
support per <var class="product">SirScan</var> version, see
the [[M204wiki main page#Sirius Mods release notes|release notes]].

For information about product error messages, see [[:Category:Sirius Mods messages|Sirius Mods messages]].

{{Template: SirScan topic list}}

[[Category: SirScan]]
[[Category:Sirius Software products]]

← Older revision		Revision as of 18:56, 16 October 2015
Line 207:		Line 207:

	[[Category: SirScan]]		[[Category: SirScan]]
	~~[[Category:Sirius Software products]]~~