Managing Database Growth

Manages that data logged in Apinizer may not be meaningful after a certain period and may lead to database growth. Provides scripts and methods for regularly cleaning MongoDB collections.

Cleaning apinizer_log Collection

Cleaning software log records generated during API Proxy message flows

Cleaning audit_event Collection

Cleaning the collection where changes made by users on the system are recorded

Cleaning history_acl Collection

Cleaning the collection where API Proxy and API Proxy Group access permissions are recorded

Cleaning alert_history Collection

Cleaning the collection where alert operations are recorded

Cleaning log_tokentraffic Collection

Cleaning message records for incoming and outgoing token requests

Cleaning anomaly_detector_result Collection

Cleaning records kept for anomaly detection in API traffic

Cleaning uptime_monitor_result Collection

Cleaning log records for Uptime Monitoring operation results

Cleaning taskflow_execution_log Collection

Cleaning log records for actions in Integration Task Flow steps

Cleaning report_configuration_result Collection

Cleaning software log records generated during report definition execution

Cleaning Trace Log Collections

Cleaning detailed API traffic records generated when Trace is enabled

Cleaning user_token_blackList Collection

Cleaning records kept when users log in multiple times

Cleaning notification_user Collection

Cleaning records where user notifications are kept

Cleaning tcp_connectivity_test_history Collection

Cleaning TCP connectivity test result records

Cleaning persistent_audit_event Collection

Cleaning API Manager login attempt records

Cleaning portal_login_logs Collection

Cleaning API Portal login attempt records

Database Collection Names

The following table shows the MongoDB collections used in Apinizer and the data they contain:

Page Name	Collection Name in Database	Description
Application Logs	apinizer_log	Records for software logs generated during the execution of the flow for incoming and outgoing messages to API Proxy
Audit Records	audit_event	Collection where changes made by users on the system are recorded. Operations performed are recorded with parameters such as date, operation type, user, object ID, object name, and audit object type
ACL Audit Records	history_acl	Collection where user information (credential) records are kept for granting or revoking access permissions to API Proxy or API Proxy Group. Information such as operation date, operation type, reason, which user it applies to, which API Proxy/API Proxy Group and method it applies to is kept in this collection
Alert	alert_history	Information such as operation time, message information in the action, and which object triggered it for alerts created using actions under certain conditions on Apinizer
Token Requests	log_tokentraffic	Records for relevant parts of incoming and outgoing messages for token requests
Anomaly Detector	anomaly_detector_result	Records kept to find anomalies in API traffic
Uptime Monitor	uptime_monitor_result	Log records for Uptime Monitoring operation results
Task Flow	taskflow_execution_log	Records for logs generated during the execution of actions in Integration Task Flow steps
Report Generator	report_configuration_result	Records for software logs generated during report definition execution
Trace	log_apiproxytraffic	Collection that records information about API traffic when Trace is enabled in API Proxy traffic. Contains basic traffic information about an API’s usage and details about which proxy it was processed through
Trace	log_apiproxytraffic_policy_execution	Structure containing information about policy application processes when Trace is enabled in API Proxy traffic. Represents information about the state before and after policy(ies) are applied
Trace	log_apiproxytraffic_routing	Structure representing events such as routing, retry, and failover when Trace is enabled in API Proxy traffic. Keeps information about which routes an API request passed through, how retry or failover processes worked in case of any error
-	user_token_blackList	Collection where each login operation is kept as a separate record when users log in multiple times
Notifications	notification_user	Collection where user notifications are kept
TCP Connectivity Test History	tcp_connectivity_test_history	Collection where TCP connectivity test results are stored
API Manager Login Logs	persistent_audit_event	Collection where API Manager login attempt records are stored
API Portal Login Logs	portal_login_logs	Collection where API Portal login attempt records are stored

Some collections contain critical data. Especially cleaning audit_event, history_acl, persistent_audit_event, and portal_login_logs collections is not recommended. Automatic purge via Purge Jobs has been removed for audit and login log collections. Before interfering with these collections, backup should be taken and careful evaluation should be made.