Overview
What is its Purpose?
What is its Purpose?
Centralized Log Collection
Collects high-volume logs file-based for API Proxy traffic on Apinizer Gateway and provides continuous visibility to operations teams.
Disk Consumption Control
Controls disk consumption through RollingFileAppender parameters, guarantees separation of logs with daily/hourly cycles.
Environment-Based Separation
Environment-based log directories are defined to provide Development/Test/Production separation and speed up incident analysis.
Security and Permission Management
Since incorrect logPath permissions can cause errors, validation of access rights at OS level is critical.
Working Principle
Working Principle
Connection Initiation
When a Logback connection is requested from within an Integration Flow or Connector, the system reads the configured connection parameters.
Connection Pool Management
Logback RollingFileAppender manages concurrent write needs to the same log file by reusing file handles on worker node.
Authentication
Worker pod accesses target file system with system user account and file permissions linked to selected Environment; does not require additional Authentication layer.
Data Communication
HTTP request/response headers, bodies, and metadata are formatted with specified logPattern and written to specified logPath/logFileName combination via File I/O.
Connection Management
After operation completes, connection remains open within same worker thread and RollingFileAppender buffer is flushed to wait for new requests.
Error Management
In case of connection error, timeout, or authentication error, deployment-result dialog activates with detailed error message, user is advised to review log directory and permission checks.
Use Cases
Use Cases
API Proxy Traffic Logging
Storing API Proxy traffic logs centrally and preparing for SIEM integration.
Request/Response Tracking
Ability to retrospectively analyze detailed request/response traces in business-critical integrations.
Log Retention Policies
Maintaining disk capacity balance by applying environment-based log retention policies.
Security Reviews
Filtering and exporting specific pod or endpoint logs during security reviews.
Technical Features and Capabilities
Basic Features
Basic Features
Log Directory Management
Directory on worker node is selected with logPath field, invalid folders are actively rejected.
File Naming Patterns
logFileName and logFilenamePattern combination splits logs date/sequence-based, provides easy archiving capability.
Storage Limit Control
Disk consumption is kept under control with maxFileSize, maxHistory, and totalSizeCap values.
Environment-Based Configuration
Ability to define separate connection parameters for each environment (Development, Test, Production).
Enable/Disable Control
Activating or deactivating the Connection (enable/disable toggle). In passive state, connection cannot be used but its configuration is preserved.
Advanced Features
Advanced Features
Instant Test Support
Test Connection button triggers logPath access and pattern validation before saving.
Name Conflict Prevention
Instant uniqueness check is performed for Name field, registration is blocked in case of conflict.
Move to Global
Project-based connections are moved to global area with single click, enabling multi-project usage.
Connection Test Feature
Ability to validate connection parameters before saving with “Test Connection” button.
Export/Import Feature
Export connection configuration as ZIP file. Import to different environments (Development, Test, Production). Version control and backup capability.
Connection Monitoring
Monitoring connection health, pool status, and performance metrics.
Connection Parameters
Required Parameters
Required Parameters
Name
Description: Connection name (must be unique)
Example Value:
Notes: Cannot start with space, special characters should not be used
Example Value:
Production_LogbackNotes: Cannot start with space, special characters should not be used
Log Path (logPath)
Description: Directory where log files will be written
Example Value:
Notes: Worker pod must have write permission, absolute path recommended
Example Value:
/var/log/apinizer/Notes: Worker pod must have write permission, absolute path recommended
Log File Name (logFileName)
Description: RollingFileAppender base file name
Example Value:
Notes: Use of letters, numbers, and
Example Value:
ApinizerApiProxyTrafficNotes: Use of letters, numbers, and
_ recommendedLog Filename Pattern (logFilenamePattern)
Description: File name pattern containing date and index
Example Value:
Notes: Logback patterns supported, date format required
Example Value:
%d{yyyy-MM-dd}.%i.logNotes: Logback patterns supported, date format required
Log Pattern (logPattern)
Description: Single-line log format
Example Value:
Notes: All compatible with Logback conversion patterns
Example Value:
%d{yyyy-MM-dd HH:mm:ss.SSS}[%t]%nNotes: All compatible with Logback conversion patterns
Max File Size (maxFileSize)
Description: Upper limit of single file in MB
Example Value: 25
Notes: Positive integer, 1-1024 MB range recommended
Example Value: 25
Notes: Positive integer, 1-1024 MB range recommended
Max History (maxHistory)
Description: Number of rolling files to keep
Example Value: 30
Notes: 0 means unlimited but disk may grow
Example Value: 30
Notes: 0 means unlimited but disk may grow
Total Size Cap (totalSizeCap)
Description: Total MB limit of all rolling files
Example Value: 1024
Notes: If 0, Logback does not apply total limit; >512 MB recommended for Production
Example Value: 1024
Notes: If 0, Logback does not apply total limit; >512 MB recommended for Production
Optional Parameters
Optional Parameters
Description
Description: Purpose or scope of the connection
Default Value: ”
Recommended Value: Short description indicating function and target system
Default Value: ”
Recommended Value: Short description indicating function and target system
Environment (environmentId)
Description: Published environment selection
Default Value: null
Recommended Value: Separate value selection recommended for each environment
Default Value: null
Recommended Value: Separate value selection recommended for each environment
Log Pod Name (logPodName)
Description: Label to route logs to specific worker pod
Default Value: ”
Recommended Value: Use when need to write only to target pod in multi-node clusters
Default Value: ”
Recommended Value: Use when need to write only to target pod in multi-node clusters
Deploy To Worker (deployToWorker)
Description: Whether connection will be deployed to worker nodes
Default Value: true
Recommended Value: false if kept for test purposes only on management node
Default Value: true
Recommended Value: false if kept for test purposes only on management node
Enable Status
Description: Activeness of the connection
Default Value: true
Recommended Value: Always active in Production, can be temporarily closed while resolving issues
Default Value: true
Recommended Value: Always active in Production, can be temporarily closed while resolving issues
Timeout and Connection Pool Parameters
Connection Timeout
Description: Maximum wait time for connection establishment
Default: Not applicable
Min: - | Max: -
Unit: milliseconds
Default: Not applicable
Min: - | Max: -
Unit: milliseconds
Request Timeout
Description: Maximum wait time for request response
Default: Not applicable
Min: - | Max: -
Unit: milliseconds
Default: Not applicable
Min: - | Max: -
Unit: milliseconds
Pool Size
Description: Maximum number of connections in connection pool
Default: Not applicable
Min: - | Max: -
Unit: count
Default: Not applicable
Min: - | Max: -
Unit: count
Flush Interval
Description: Log buffer write interval to disk (Logback internal)
Default: 1000
Min: 250 | Max: 5000
Unit: milliseconds
Default: 1000
Min: 250 | Max: 5000
Unit: milliseconds
Use Cases
API Proxy Traffic Monitoring
Situation: High-volume traffic analysis required
Solution: logPath=/var/log/apinizer/proxy, maxHistory=30, totalSizeCap=2048
Expected Behavior: All calls stored with 30-day history, readable by SIEM
Solution: logPath=/var/log/apinizer/proxy, maxHistory=30, totalSizeCap=2048
Expected Behavior: All calls stored with 30-day history, readable by SIEM
Security Incident Review
Situation: Specific endpoint logs requested
Solution: logFilenamePattern=
Expected Behavior: Date-based files quickly filtered, review performed within incident period
Solution: logFilenamePattern=
%d{yyyy-MM-dd}-security.%i.logExpected Behavior: Date-based files quickly filtered, review performed within incident period
Integration Tests
Situation: Detailed log required in QA environment
Solution: environmentId=Test, maxFileSize=10
Expected Behavior: Test logs split into small files, developers easily download
Solution: environmentId=Test, maxFileSize=10
Expected Behavior: Test logs split into small files, developers easily download
Pod-Based Separation
Situation: Problem exists in specific worker pod
Solution: logPodName=gateway-worker-2
Expected Behavior: Logs taken only from relevant pod, target problem isolated
Solution: logPodName=gateway-worker-2
Expected Behavior: Logs taken only from relevant pod, target problem isolated
Regulatory Archiving
Situation: Log retention under GDPR
Solution: maxHistory=0, totalSizeCap=5120
Expected Behavior: Legal retention period provided with total quota instead of infinite cycle
Solution: maxHistory=0, totalSizeCap=5120
Expected Behavior: Legal retention period provided with total quota instead of infinite cycle
Disaster Recovery
Situation: Copying logs to backup node
Solution: logPath=/mnt/dr/logs, Enable Export All on
Expected Behavior: All logs written to shared storage in failover scenario
Solution: logPath=/mnt/dr/logs, Enable Export All on
Expected Behavior: All logs written to shared storage in failover scenario
Connection Configuration
Creating New Logback
1
Navigate to Creation Page
- Go to Connection → Logback section from left menu.
- Click [+ Create] button at top right.
2
Enter Basic Information
Enable Status (Active Status): Set active/passive status with toggle. New connections are active by default.Name Required:
Example:
Production_Logback- Enter unique name, cannot start with space.
- System automatically checks. Green checkmark: available. Red X: existing name.
- Max. 1000 characters.
- Describe the purpose of the Connection.
3
Environment Selection
- Select environment from dropdown menu: Development, Test, or Production.
- Different connection parameters can be defined for each environment.
4
Logback Specific Parameters - Directory and Naming
- Enter absolute directory that worker node can write to in logPath field.
- Determine RollingFileAppender file cycle with logFileName and logFilenamePattern fields; pay attention to containing date and index.
- Unauthorized directories produce errors during deployment.
5
Logback Specific Parameters - Content and Format
- Fill logPattern field with Logback conversion patterns, add thread name or request-id if needed.
- Use logPodName field if routing to specific pod is required.
6
Timeout and Connection Pool Settings
- Logback file writing has no separate timeout; if needed, update flush interval settings at JVM level through deployment descriptor.
- Set maxFileSize, maxHistory, totalSizeCap values appropriately according to operation policies for disk quotas.
7
Security and Authentication Settings
- Ensure worker node user account has write permission on logPath.
- Use file system ACLs or Kerberos-supported share points if needed.
- In production environment, allow only authorized service accounts to access shared directories.
8
Test Connection
- Click [Test Connection] button.
- Test whether connection parameters are correct.
- Success: Green confirmation message, Failed: Error details shown.
9
Save
- Click [Save and Deploy] button at top right.
- Connection is added to list.
- Becomes available in Integration Flow and Connector steps.
- Becomes active according to environment.
Connection created successfully! You can now use it in Integration Flow and Connector steps.
Deleting Connection
Delete Operation
Select Delete from ⋮ menu at end of row or click [Delete] button on connection detail page
Delete Tips
Check Before Deleting: May be used in Integration Flow or Connector steps. If necessary, assign an alternative connection. Back up with Export before deleting
Alternative: Deactivate
Use Disable option instead of deleting. Connection becomes passive but is not deleted. Can be reactivated when needed
Exporting/Importing Connection
In this step, users can export existing connections for backup, moving to different environments, or sharing purposes, or import a previously exported connection again. This operation is used to maintain data integrity in version control, transitions between test and production environments, or inter-team sharing processes.
Export
Export
Method 1
Select ⋮ → Export from action menu. ZIP file is automatically downloaded.
Method 2
Click [Export] button on connection detail page. ZIP file is downloaded.
File Format
Format:
Example:
Date-connection-Logback-export.zipExample:
13 Nov 2025-connection-Production_Logback-export.zipZIP Contents
- Connection JSON file
- Metadata information
- Dependency information (e.g., certificates, key store)
Use Cases
- Backup
- Moving between environments (Test → Prod)
- Versioning
- Team or project-based sharing
Import
Import
Import Steps
- Click [Import Logback] button on main list.
- Select downloaded ZIP file.
- System checks: Is format valid? Is there name conflict? Are dependencies present?
- Then click [Import] button.
Import Scenarios
Scenario 1: Name Conflict → Overwrite old connection or create with new name.Scenario 2: Missing Dependencies → Create missing certificates or key stores first or exclude during import.
Connection Usage Areas
Creating and Activating Connection
Steps:
- Create the connection.
- Validate connection with Test Connection.
- Save and activate with Save and Deploy.
- Ensure connection is in Enabled state
Usage in Integration / Connector Steps
Connection is selected in steps requiring communication with message queue (queue), topic, email, FTP/SFTP, LDAP, or similar external systems. Examples: “Send Message”, “Consume Message”, “Upload File”, “Read Directory” steps. Connection selection is made from Connection field in these steps’ configuration
Scheduled Job Usage
In scheduled tasks (e.g., sending messages at certain intervals, file processing, etc.), access to external systems is provided by selecting connection. When connection changes, job execution behavior is updated accordingly
Test Usage
Connection correctness can be checked independently from Integration Flow with Connection Test feature. This test is critical in debugging process
Best Practices
Do's and Best Practices
Do's and Best Practices
Log Directory Selection
Bad: Using temp directories in Production.
Good: Opening separate
Best: Granting permission only to service account on dedicated disk or mount point.
Good: Opening separate
/var/log/apinizer directory.Best: Granting permission only to service account on dedicated disk or mount point.
File Pattern Management
Bad: Not using date in pattern.
Good: Using daily dated pattern.
Best: Ensuring SIEM compatibility with pattern containing date + index and application name.
Good: Using daily dated pattern.
Best: Ensuring SIEM compatibility with pattern containing date + index and application name.
Storage Policy
Bad: Leaving maxHistory=0 and totalSizeCap=0.
Good: Setting reasonable values according to traffic.
Best: Setting automatic cleanup rules according to disk capacity, regulation, and backup processes.
Good: Setting reasonable values according to traffic.
Best: Setting automatic cleanup rules according to disk capacity, regulation, and backup processes.
Pod-Based Routing
Bad: Writing all pods to single directory.
Good: Using logPodName for problematic pods.
Best: Setting up separate directory for each pod + central collection pipeline.
Good: Using logPodName for problematic pods.
Best: Setting up separate directory for each pod + central collection pipeline.
Environment Management
Bad: Using same connection parameters in all environments.
Good: Creating separate connection for each environment.
Best: Managing all environments in single connection using Environment option, only changing environment during transitions between environments
Good: Creating separate connection for each environment.
Best: Managing all environments in single connection using Environment option, only changing environment during transitions between environments
Connection Test
Bad: Saving and deploying connection without testing.
Good: Validating with Test Connection before saving.
Best: Testing after every parameter change, performing full integration test in test environment before going to production
Good: Validating with Test Connection before saving.
Best: Testing after every parameter change, performing full integration test in test environment before going to production
Security Best Practices
Security Best Practices
File System Access Control
Define POSIX permissions that only relevant worker service accounts can write to logPath directory, do not open root shares in Production
Shared Storage Security
Restrict network segment in shares like NFS/Samba, apply IP-based allowlist in accesses
Log Content Masking
Prevent writing personal data to logPattern, anonymize sensitive fields with privacy setting components if needed
Credential Management
Store sensitive information such as username and password using environment variable or secret manager. Do not hardcode credentials in code or configuration files. Update passwords periodically
SSL/TLS Usage
Always enable SSL/TLS in production environment. Use self-signed certificates only in development environment. Track certificate expiration dates and renew on time
Access Control
Allow only authorized users to change connection configuration. Store connection change logs. Apply change approval process for critical connections
Don'ts
Don'ts
Writing to Shared Root Directory
Why avoid: Keeping logs in root directory leads to incorrect permissions, affects other services
Alternative: Use separately mounted log directory
Alternative: Use separately mounted log directory
Incorrect Date Pattern
Why avoid: Files without dates are overwritten, log loss occurs
Alternative: Use patterns containing
Alternative: Use patterns containing
%dNot Defining Quota
Why avoid: Gateway may stop when disk is full
Alternative: Set maxFileSize, maxHistory, and totalSizeCap values according to system capacity
Alternative: Set maxFileSize, maxHistory, and totalSizeCap values according to system capacity
Using Production Connection in Test Environment
Why avoid: Test data may be written to production system, real users may be affected, security risk occurs
Alternative: Create separate connection for each environment, use environment parameter, separate connection names by adding prefix according to environment (Test_, Prod_)
Alternative: Create separate connection for each environment, use environment parameter, separate connection names by adding prefix according to environment (Test_, Prod_)
Very Low Timeout Values
Why avoid: Connection constantly times out in network delays, Integration steps fail
Alternative: Adjust timeout values according to real usage scenarios, measure network latency and set timeouts accordingly
Alternative: Adjust timeout values according to real usage scenarios, measure network latency and set timeouts accordingly
Not Using Connection Pool
Why avoid: New connection opens on every request, performance decreases, resource consumption increases, target system load increases
Alternative: Enable connection pool, adjust pool size according to traffic volume, set up pool monitoring
Alternative: Enable connection pool, adjust pool size according to traffic volume, set up pool monitoring
Performance Tips
Performance Tips
Disk IO Optimization
Recommendation: Prefer SSD-based directories, use
Impact: Write delays decrease, log recording becomes uninterrupted
noatime mount optionImpact: Write delays decrease, log recording becomes uninterrupted
Pattern Minimalism
Recommendation: Include only needed fields in logPattern, avoid expensive JSON serializations
Impact: CPU usage decreases, log throughput increases
Impact: CPU usage decreases, log throughput increases
Retention Automation
Recommendation: Match maxHistory and totalSizeCap values with real disk capacity, schedule background cleanup scripts
Impact: Disk fullness risks are eliminated, manual intervention need decreases
Impact: Disk fullness risks are eliminated, manual intervention need decreases
Connection Pool Optimization
Recommendation: Set pool size according to peak traffic (recommended: concurrent request count × 1.5), set idle connection timeouts, perform pool health check
Impact: Connection opening cost decreases by 80%, response times decrease, resource usage is optimized
Impact: Connection opening cost decreases by 80%, response times decrease, resource usage is optimized
Timeout Values Optimization
Recommendation: Measure real network latency, adjust timeout values accordingly, avoid very low or very high timeouts
Impact: Unnecessary waits are prevented, fast fail-over is provided, user experience improves
Impact: Unnecessary waits are prevented, fast fail-over is provided, user experience improves
Connection Monitoring
Recommendation: Monitor connection pool usage, track timeout rates, perform connection health check, set up alerting
Impact: Problems are proactively detected, performance bottlenecks are identified early, downtime decreases
Impact: Problems are proactively detected, performance bottlenecks are identified early, downtime decreases
Troubleshooting
Log File Not Created
Log File Not Created
1
LogPath Validation
Validate logPath value.
2
User Permissions
Check worker pod user permissions.
3
Enable Status
Turn on connection enable status.
File Size Limit Exceeded
File Size Limit Exceeded
1
Increase MaxFileSize
Increase maxFileSize according to traffic.
2
MaxHistory Limit
Set limit to maxHistory.
3
Define TotalSizeCap
Define totalSizeCap and redeploy.
Connection Timeout
Connection Timeout
1
Network Check
Check network connectivity.
2
System Health
Check target system health.
3
Timeout Settings
Increase timeout values.
4
Log Review
Review connection logs.
Authentication Failed
Authentication Failed
1
Credentials
Verify credentials.
2
User Status
Check that user is active on target system.
3
Permission Check
Check that necessary permissions are granted.
4
Certificate Check
Check SSL/TLS certificates.
Pool Exhausted
Pool Exhausted
1
Pool Size
Increase pool size.
2
Connection Check
Check that connections are properly closed.
3
Idle Timeout
Set idle connection timeouts.
4
Metric Monitoring
Monitor connection usage metrics.
Connection Test Successful But Integration Flow Errors
Connection Test Successful But Integration Flow Errors
1
Enable Toggle
Check that connection’s enable toggle is active.
2
Connection Selection
Verify that correct connection is selected in Integration Flow.
3
Connection Deploy
Redeploy connection.
4
Flow/Job Deploy
Redeploy Integration Flow or Job.
5
Log Check
Check Gateway logs.
Frequently Asked Questions (FAQ)
What minimum parameters should I enter for Logback Connection?
What minimum parameters should I enter for Logback Connection?
Name, logPath, logFileName, logFilenamePattern, logPattern, and all limit fields must be filled; others are optional but recommended.
Can I transfer logs to both file and external system simultaneously?
Can I transfer logs to both file and external system simultaneously?
Yes, while Logback Connection writes to file, REST API or Message Queue outputs can be defined with parallel Connector steps in Integration Flow.
What happens if I leave logPodName value empty?
What happens if I leave logPodName value empty?
When left empty, all worker pods rotate under same logPath; safe to leave empty if you won’t track specific pods.
If maxHistory and totalSizeCap conflict, which takes priority?
If maxHistory and totalSizeCap conflict, which takes priority?
Logback first cleans according to maxHistory value, then continues deleting oldest files if totalSizeCap overflow continues.
How can I transfer logs to external SIEM tool?
How can I transfer logs to external SIEM tool?
When rolling files complete, external agents or cron jobs can read logPath and push to SIEM; keep file pattern compatible with SIEM expectations.
Can I use the same connection in multiple Integration Flows?
Can I use the same connection in multiple Integration Flows?
Yes, the same connection can be used in multiple Integration Flow or Connector steps. This provides centralized management and guarantees configuration consistency. However, changes made to the connection will affect all usage locations, so care should be taken.
Is using connection pool mandatory?
Is using connection pool mandatory?
Connection pool usage is not mandatory but strongly recommended in high-traffic systems. Reusing existing connections instead of opening new connection on every request significantly increases performance.
Should I create different connections for Test and Production?
Should I create different connections for Test and Production?
Yes, it is recommended to create separate connection for each environment. Alternatively, you can manage all environments in a single connection using environment parameter. This approach provides easier management and less error risk.
Test Connection is successful but not working in Integration Flow, why?
Test Connection is successful but not working in Integration Flow, why?
- Connection enable toggle may be passive
- Different connection may be selected in Integration step
- Connection may not be deployed
- Integration Flow may not be redeployed yet