Ganymede Log File Format


The Ganymede server maintains a log that is intended to be both easily parseable by humans and scannable on command by the server on behalf of clients.

The log file is a |-separated, line-oriented text file with the following form:
date|readable date|eventClassToken|adminInvid|adminName|transactionId|objectInvids|text description|email addresses
Where the fields are defined as follows:

Field Description
date A 64 bit Java date code in ASCII form.. a sequence of digits comprising the date of the event in milliseconds since Midnight, Jan 1, 1970, UTC
readable date The date of the event in a human readable form
eventClassToken A short string token serving to identify the class of event. This token will be generated by code in the Ganymede server, in reference to an object of type EventClass held in the Ganymede database. The token will consist of a string of characters not to include spaces, newlines, or vertical bars.
adminInvid A Ganymede database pointer to the adminPersona that triggered the event, if any. This invid will be of the form 1:813, where the first number is the Ganymede database object type, and the second is the adminPersona's id within the adminPersona objectBase.
adminName The human-readable name of the administrator who triggered the event, or nothing if it was a system event.
transactionID If this event is part of a transaction, this field will be a string of the form name:date where name is the human-readable name of the administrator who committed the transaction, and date is a long integer representing the time of the transaction. The date code is of the same form as the date field discussed above.
objectInvids A string of comma separated invids enumerating objects involved in the event. Invids are encoded in the same form as the adminInvid field discussed above.
text description A verbose description of the event, possibly including a description of the before and after state of an object changed in a transaction.
email addresses If this event was mailed out to users in addition to being recorded in the log, this field will contain a comma separated list of email addresses that the event was mailed to.

General Notes on Log File Format