Skip to content

Commit 284373a

Browse files
committed
Add TCM config rerefence
1 parent d3b523f commit 284373a

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

doc/reference/tooling/tcm/tcm_audit_log.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,6 @@ To search for an event, use the search bar on the top of the page. Note that the
126126
search is case-sensitive. For example, to find events with the ``ALARM`` severity,
127127
enter ``ALARM``, not ``alarm``.
128128

129-
If audit log is written to a syslog, use other tools to read it.
130-
131129
.. _tcm_audit_log_structure:
132130

133131
Structure of audit log events
@@ -151,7 +149,7 @@ All entries of the |tcm| audit log include the mandatory fields listed in the ta
151149
- Event severity: ``VERBOSE``, ``INFO``, ``WARNING``, or ``ALARM``
152150
- INFO
153151
* - ``type``
154-
- Audit event type. Possible values are listed in :ref:`Event types <tcm_audit_log_events_types>`.
152+
- Audit :ref:`event type <tcm_audit_log_event_types>`
155153
- user.update
156154
* - ``description``
157155
- Human-readable event description
@@ -180,12 +178,12 @@ All entries of the |tcm| audit log include the mandatory fields listed in the ta
180178
* - ``err``
181179
- Human-readable error description for events with ``nok`` result
182180
- failed to login
183-
184-
Additionally, there are fields that are written for specific types, for example:
185-
186-
- ``clusterId`` is added to cluster-related events.
187-
- ``username`` for users' actions on their accounts and sessions.
188-
- ``payload`` for events that include sending data on the server.
181+
* - ``fields``
182+
- Additional fields for specific event types in the key-value format
183+
- Key examples:
184+
- ``clusterId`` in cluster-related events.
185+
- ``username`` in ``current.*`` or ``auth.*`` events
186+
- ``payload`` in events that include sending data to the server
189187

190188
This is an example of an audit log entry on a successful login attempt:
191189

0 commit comments

Comments
 (0)