DreamFactory Logging Features Explained

DreamFactory simplifies API management with powerful logging tools that boost security, track performance, and ensure compliance. Here's what you need to know:

• Automated Logging: Tracks API requests, responses, and system events.
• Security Monitoring: Logs authentication attempts, API key usage, and access control actions, reducing security risks by 99%.
• Log Levels: Customize logs for errors, warnings, routine info, or debugging.
• Retention Management: Automate log cleanup and align with compliance needs like GDPR or HIPAA.
• Archiving & Backup: Securely store logs in industry-standard formats with encryption and backup protocols.
• Monitoring Tools: Real-time dashboards, alerts, and audit trails for API performance and security insights.
• External Integration: Export logs for use with SIEM systems or analytics tools.

With DreamFactory, you can set up production-ready APIs with detailed logging in just 5 minutes, saving time and costs while maintaining robust security and performance.

12 Logging BEST Practices in 12 minutes

Main Logging Features

DreamFactory keeps track of API interactions to ensure secure operations and improve system performance.

Log Data Collection

Every API interaction is automatically logged by DreamFactory, creating a detailed audit trail. These logs include:

• Requests: HTTP methods, endpoints, headers, and payloads
• Responses: Status codes, response times, and returned data
• User Details: API key IDs, credentials, and IP addresses
• System Events: Database connections, schema updates, and service statuses

"DreamFactory streamlines everything and makes it easy to concentrate on building your front end application. I had found something that just click, click, click... connect, and you are good to go."

• Edo Williams, Lead Software Engineer at Intel

Security Event Logging

DreamFactory also tracks critical security events like authentication attempts, API key usage, role-based access control (RBAC) changes, and OAuth/SAML activities. These logs help identify unauthorized access attempts and ensure security policies are being followed. In fact, DreamFactory's security logging has led to a 99% reduction in common security risks ^[1].

Log Level Settings

Administrators can adjust log settings to capture the right level of detail while maintaining system performance:

• ERROR: Logs critical issues that need immediate attention
• WARNING: Highlights events that may require investigation
• INFO: Tracks routine operations and API usage metrics
• DEBUG: Provides technical details for development and troubleshooting

"DreamFactory is far easier to use than our previous API management provider, and significantly less expensive."

• Adam Dunn, Sr. Director of Global Identity Development & Engineering at McKesson

Up next: how to manage log retention for optimal system performance.

Log Retention Management

Managing log retention effectively helps maintain system performance and ensures compliance with regulations. Here's how to configure and automate log retention for better system efficiency.

Setting Retention Rules

Retention rules can be configured based on the type and importance of logs. Administrators can align these rules with compliance requirements like GDPR or HIPAA. Once set, automated processes handle the cleanup, making the system more efficient.

Automatic Log Cleanup

DreamFactory's logging system includes a built-in automated cleanup feature. This feature removes outdated logs automatically, following the retention rules you've set. It helps keep storage manageable and maintains system performance.

Retention Guidelines

Different types of logs require different retention periods, depending on their purpose. For example, security event logs, API transaction logs, and system alert logs may each have unique retention needs to address compliance, performance analysis, or troubleshooting.

To manage log retention effectively:

• Regularly review and update retention policies
• Archive important logs before deleting them
• Keep a record of any changes to retention policies
• Monitor storage usage to prevent capacity issues

Following these steps ensures efficient log management, even in large-scale enterprise systems.

Log Storage and Archives

DreamFactory simplifies log archiving, ensuring secure, long-term storage while meeting compliance needs. This system helps organizations keep historical data intact without affecting performance. It also supports secure file formats and dependable backup methods.

Archive Process

Logs are automatically moved from active storage to archives based on retention policies. This process keeps the system running smoothly while ensuring older logs are preserved for audits or compliance purposes.

File Formats and Security

Archived logs are stored in formats widely recognized across industries, making them easy to access and use. Encryption and strict access controls are applied to protect the data, maintaining both its integrity and its confidentiality.

Backup and Recovery

DreamFactory creates regular backups of archived logs and uses verification protocols to ensure these backups are both secure and accessible when needed. This guarantees that log data is always recoverable.

Log Monitoring Tools

DreamFactory offers tools that provide real-time insights into API performance and security, building on its robust log collection and storage capabilities.

Monitoring Dashboard

The dashboard delivers live metrics, including:

• API call volume
• Response times
• Error rates
• Resource usage

Admins can set up alerts for specific thresholds, ensuring they can address potential issues as they arise.

Audit Trail Logs

The audit trail system keeps a detailed record of system events and user actions, tracking:

• Authentication attempts (both successful and failed)
• API access patterns and resource usage
• Configuration changes and system updates
• User session activities and durations

Each log entry is detailed with timestamps, user IDs, IP addresses, and specific actions.

External Tool Integration

DreamFactory supports exporting logs in standardized formats, making them compatible with SIEM systems, log aggregators, business intelligence tools, and custom monitoring platforms.

This flexibility allows organizations to combine DreamFactory logs with other system data for in-depth analysis and reporting. Built-in filtering tools help teams focus on specific events or time frames, making troubleshooting faster and more efficient.

Summary and Tips

Here’s a quick look at DreamFactory's logging features and how to make the most of them:

Main Points

DreamFactory's logging system is designed to simplify API management and strengthen security. It offers a range of benefits, including automated security controls and detailed audit trails, which can cut down common security risks by up to 99% ^[1].

Key features include:

• Real-time monitoring of API activity
• Detailed event tracking with precise timestamps
• Flexible storage options for various archive formats
• Automated log retention to manage storage efficiently

These tools work together to ensure smooth API operations while keeping security at the forefront.

Setup Guidelines

To get the most out of DreamFactory's logging, follow these steps:

Configure Log Levels
Tailor log levels to your environment:

• Development: Use detailed debugging logs.
• Production: Focus on warnings and errors.
• Security Auditing: Track authentication and access attempts.

Set Retention Rules
Match retention policies to compliance needs while keeping storage costs in check. Enable automatic cleanup for outdated logs.

Enable Monitoring
Use monitoring tools to set alert thresholds, activate real-time dashboards, and integrate external analytics tools.

You can have a production-ready API with logging set up in about 5 minutes ^[1], making it a quick and effective choice for teams aiming to improve API management and security.