Internal documentation only
This page has been marked as draft.
Where to find the 'Description' field for Gateway Audit logs
Related to Copied
When saving changes in the Gateway Setup Editor (GSE), users are prompted to enter a comment. These comments are stored as audit records. To view them, you must have an Audit Output configured, such as a database or a flat file. If no output was configured at the time of the change, those specific comments cannot be retrieved retrospectively.
Problem Copied
The client is unable to locate or review the mandatory comments entered during the “Saving setup to gateway” process in the Gateway Setup Editor.
- User Interface: The prompt appears and accepts text, but there is no obvious “history” or “log” view within the GSE to read previous entries.
- System Backend: Without a defined Audit Output destination, the Gateway processes the change but does not persist the comment string to a searchable location.
Possible cause(s) Copied
- Root Cause 1: Missing Database Logging Configuration If the Gateway is not connected to an external database (e.g., PostgreSQL), the audit records—including the comments—have nowhere to be stored in a structured format.
- How to determine: Check if an
audit_tableexists in your database schema. If the command\d audit_table;returns no results or the table is empty, database logging is not active. - Root Cause 2: Missing Flat File Audit Output If a database is not preferred, the Gateway can write changes to a local file. If this is not explicitly set in the Gateway configuration, the comments are discarded after the session.
- How to determine: Navigate to Audit Outputs in the Gateway Setup Editor. If there are no entries for “Flat File,” then no local logging is occurring.
- Root Cause 3: Retrospective Retrieval of Lost Comments The client may expect to find comments made before a logging destination was created.
- How to determine: If logging was only recently enabled, any setup changes made prior to that timestamp are permanently lost as they were never written to disk or a database.
Possible solution(s) Copied
-
Solution Root Cause 1: Configure the Gateway to log to a supported database. Once connected, comments are stored in the
descriptionfield of theaudit_table. You can query this table directly using SQL to see the username, timestamp, and the specific comment entered during the save.
-
Solution Root Cause 2: Enable a Flat File output under the Audit Outputs section in the GSE. This will generate a text-based log on the Gateway server that records all setup changes and their associated comments in real-time.
-
Solution Root Cause 3: Ensure that an Audit Output (Database or Flat File) is established immediately upon Gateway deployment. It is important to note that enabling logging today will only capture changes moving forward; it cannot recover “lost” comments from the past.
Related article(s) Copied
- https://docs.itrsgroup.com/docs/geneos/current/administration/databases/index.html#introduction
- https://docs.itrsgroup.com/docs/geneos/current/administration/geneos_advancedfeatures_tr/index.html#Heading-audit-information
- https://docs.itrsgroup.com/docs/geneos/current/processing/data-access-and-publishing/geneos_dblogging_tr/index.html#Heading-audit_table