To access the Logging tab:
Select a license server, click the
button in the Toolbar or right-click and select the Configuration command,
then click the Logging tab.
The Logging tab provides options for enabling and disabling journaling and tracing on the selected license server.
The Journal feature provides a record of license activity. The information is delimited by quotation marks and commas so it can be imported into another application, such as Microsoft Excel, for further analysis or reporting.
You can record the activity by service (license) and/or by client checkout. In the following example journal entries, journaling was configured to show both service and client activity; the first two lines show the client and service data for a Checkout, and the third and fourth lines show data for a Checkin.
"2010-07-27 16:32:40.032","Client","Checked-Out","Success","127.0.0.1",60147,"SQ","/usr/share/starlicense/client_tester",19595,"0804B018",30,"None"
"2010-07-27 16:32:40.032","Service","Checked-Out","Success","SQ9999-01-01 5",5,1,0,0,30,"None"
"2010-07-27 16:32:42.023","Client","Checked-In","Success","127.0.0.1",60147,"SQ","/usr/share/starlicense/client_tester",19595,"0804B018",30,"Client initiated check-in"
"2010-07-27 16:32:42.023","Service","Checked-In","Success","SQ9999-01-01 5",5,0,1,0,30,"Client initiated check-in"
In StarLicense Manager, right-click on the server icon and select Configuration.
Select the Logging panel
Click the Enable checkbox under the Journaling option.
Select whether you want to record the activity By License and/or By Checkout.
Specify how many days to retain the journal, or enter 0 (zero) if you want to retain the journal indefinitely.
When you are ready to write the activity to the journal, disable the Journaling option by deselecting the Enable checkbox.
The journal is created with a filename of YYYY-MM-DD.jrn and stored in the StarQuest\StarLicense\Logs subdirectory of the Shared Documents folder on the local computer.
The journals are located in
C:\Users\Public\Shared Documents\StarQuest\StarLicense\Logs
The following tables describe the data that is written to the journal for both Client and Service activity.
Field |
Data |
Description |
Timestamp |
" YYYY-MM-DD HH:MM:DD[.mmm]" |
the time of the license activity. |
Record Type |
"Client" |
indicates that the journal activity is for a Client. |
Disposition |
"Checked-In", "Checked-Out" or ”Revoked” |
indicates whether the license was checked in, checked out, or revoked. |
Status |
"Success" or "Failure" |
indicates whether the license checkin or checkout was successful or failed. |
Client IP |
nnn.nnn.nnn.nnn |
the IP address of the client that is checking the license in or out. |
Client Port |
nnnn |
the number of the TCP port that the client is using for communications. |
Product ID |
PP (2-byte product ID) |
an ID, such as SQ for StarSQL, that identifies which StarQuest product is licensed. See table below. |
App name |
"xxxxxxxx" |
the name of the application that is checking the license in or out |
Process ID |
nnnn |
the Process ID of the application checking the license in or out |
Client ID |
"nnnnnnnn" |
an ID assigned to the client by the application checking the license in or out |
Grace Period |
n |
Number of seconds associated with a soft-license. A zero value indicates that soft-license policy is not in use. |
Reason |
"text" |
Reason for the disposition. |
Field |
Data |
Description |
Timestamp |
"YYYY-MM-DD HH:MM:DD[.mmm]" |
the time of the license activity.
|
Record Type |
"Service" |
indicates that the journal activity is for a Service. |
Disposition |
"Checked-In", "Checked-Out" or ”Revoked” |
indicates whether the license was checked in, checked out, or revoked. |
Status |
"Success" or "Failure" |
indicates whether the license checkin or checkout was successful or failed. |
Product ID, License expiration, and License count |
"PPyyyymmdd nnn" |
the product ID, such as SQ for StarSQL, that identifies which StarQuest product is licensed (See table below), the date the license expires (a date of 9999-01-01 indicates a permanent license) and the number of checkouts that the license allows, or 0 (zero) if the license is for unlimited use. |
License count |
nnn |
the number of checkouts that the license allows, or 0 (zero) if the license is for unlimited use. |
Checkouts |
nnn |
the number of licenses that are currently checked out. |
High water mark |
nnn |
the maximum number of licenses that have been checked out since the server was started. |
Failure |
nnn |
the number of checkout failures against the license since the server was started. |
Grace Period |
n |
number of seconds associated with a soft-license. A zero value indicates that soft-license policy is not in use. |
Reason |
"text" |
Reason for the disposition. |
Product |
Product ID |
Client Access for UNIX |
CA |
Data Replicator Manager (SQDR) |
DR |
SQDR bundled ODBC drivers |
DD |
SQDR Plus for iSeries |
A+ |
SQDR Plus for UDB (Linux & UNIX) |
U+ |
SQDR Plus for UDB (Windows) |
W+ |
SQDR Plus for SQL Server |
S+ |
SQDR Plus for Oracle |
O+ |
SQDR Plus for Informix |
I+ |
SQDR Plus (any source) |
*+ |
StarPipes |
SP |
StarSQL1 |
SQ |
StarSQL for iSeries2 |
CA |
StarSQL for UDB3 |
UX |
1.
StarSQL is comprised of StarSQL for Windows, StarSQL for UNIX, and StarSQL
for Java. Any variant of StarSQL can use the same license. StarSQL is
capable of connecting to any supported host.
2. StarSQL for iSeries supports connections only to DB2 for i.
3. StarSQL for UDB supports connections only to DB2 for Linux, UNIX &
Windows.
Connection closed |
Client initiated check-in |
License removal |
Revoked by administrator during grace period |
None |
The tracing function is available to provide detailed technical information to StarQuest support personnel. Enable the tracing option, specifying a trace mask provided by StarQuest support, only if you need to provide advanced diagnostic information to StarQuest.