CA API Gateway 9.1

9.4 9.1

Add Audit Detail Assertion

The Add Audit Detail assertion lets you define a custom message that can enhance the context of an audit message. These messages are then recorded either in the audit records or a Gateway log, depending on how the assertion is configured. The custom message will also appear the "Associated Logs" tab in the Event Details Pane of the Gateway Audit Events window if audit details are directed to the audit log.
gateway83
The 
Add Audit Detail 
assertion lets you define a custom message that can enhance the context of an audit message. These messages are then recorded either in the audit records or a Gateway log, depending on how the assertion is configured. The custom message will also appear the "Associated Logs" tab in the Event Details Pane of the Gateway Audit Events window if audit details are directed to the audit log.
For more information about defining logs, see Manage Log/Audit Sinks.
To learn more about how this assertion interacts with the Audit Messages in Policy assertion and with pertinent cluster properties, see About Message Auditing.
Using the Assertion
  1. Do one of the following:
    • To add the assertion to the Policy Development window, see Add an Assertion.
    • To change the configuration of an existing assertion, proceed to step 2 below.
  2. When adding the assertion, the Audit Detail Properties automatically appear; when modifying the assertion, right-click 
    Add Audit Details... 
    in the policy window and select 
    Audit Detail Properties
     or double-click the assertion in the policy window. The assertion properties are displayed. 
  3. Configure the properties as follows:
    Setting
    Description
    Message
    Type a message in the box. This message will be displayed when the audit appears in the Gateway Audit Events window.
    Include context variables within the message to reveal additional information about the audit condition, if necessary.
    Audit
    Select this option to direct the audit detail message to the Audit log sink.
    Audit logs are the log sinks with the category "Audits". For more information, see Manage Log Sinks.
    Log
    Select this option to direct the audit detail message to the Gateway log sink. This is useful for situations where (for example) the logged information is too large to be comfortably stored in the audit database for extended periods of time. For example, storing trace information from a policy debug tracing.
    Gateway logs are the log sinks with the category "Gateway Log". For more information, see Manage Log Sinks.
    Custom logger name
    Select this check box if you want the logged information to be identified by a custom logger name, rather than the default logger name
    com.l7tech.server.policy.assertion.ServerAuditDetailAssertion
    .
    If you choose to use a custom logger name, enter a suffix to be added to the custom logger name, to ensure uniqueness. You may reference context variables.
    If a specified context variable cannot be resolved during run time, the default logger name shown above is used.
    Level
    Select a severity level for your message from the drop-down list. This level, along with the level set in the Audit Messages in Policy assertion, determines whether your message appears in the Gateway Audit Events window.
     
  4. Click [
    OK
    ]
     
    when done.

Content feedback and comments