lum3on
70efdb04ed
- Unified node supporting Create, Edit, and Remix operations - Dynamic input system based on operation type - Comprehensive error handling and credit tracking - Verbose logging for debugging and monitoring - Clean public release with documentation and examples
134 lines
4.5 KiB
Markdown
134 lines
4.5 KiB
Markdown
# Verbose Logging Example
|
|
|
|
This document demonstrates how to use the verbose logging feature in the ComfyUI Reve API node.
|
|
|
|
## Basic Usage
|
|
|
|
1. **Add the Reve API node** to your workflow from the `image/ai` category
|
|
2. **Set the operation** to your desired type (create, edit, or remix)
|
|
3. **Enable verbose logging** by setting the `verbose_logging` parameter to `True`
|
|
4. **Configure your other parameters** as needed
|
|
5. **Execute the workflow** and check the ComfyUI console for detailed logs
|
|
|
|
## Example Workflow Setup
|
|
|
|
### Create Operation with Verbose Logging
|
|
|
|
```
|
|
[Text Input] → prompt: "A beautiful sunset over mountains"
|
|
[Dropdown] → operation: "create"
|
|
[Dropdown] → aspect_ratio: "16:9"
|
|
[Checkbox] → verbose_logging: True
|
|
```
|
|
|
|
### Expected Console Output
|
|
|
|
When you run this workflow, you'll see detailed logging in the ComfyUI console:
|
|
|
|
```
|
|
2025-09-16 12:38:26,317 - nodes.reve_api_node.verbose - INFO - 🚀 Starting Reve API CREATE operation
|
|
{
|
|
"prompt_length": 35,
|
|
"operation": "create",
|
|
"version": "latest",
|
|
"aspect_ratio": "16:9",
|
|
"output_format": "png",
|
|
"has_reference_image": false,
|
|
"reference_images_count": 0
|
|
}
|
|
|
|
2025-09-16 12:38:28,842 - nodes.reve_api_node.verbose - INFO - 🔍 Reve API CREATE Operation Complete
|
|
{
|
|
"operation": "create",
|
|
"request_id": "req-abc123def456",
|
|
"credits_used": 18,
|
|
"credits_remaining": 482,
|
|
"processing_time_seconds": 2.525,
|
|
"success": true,
|
|
"request_parameters": {
|
|
"prompt_length": 35,
|
|
"version": "latest",
|
|
"aspect_ratio": "16:9",
|
|
"has_reference_image": false,
|
|
"reference_images_count": 0
|
|
}
|
|
}
|
|
|
|
2025-09-16 12:38:28,845 - nodes.reve_api_node.verbose - INFO - ✅ Reve API CREATE operation completed successfully
|
|
{
|
|
"total_processing_time_seconds": 2.528,
|
|
"api_call_time_seconds": 2.525,
|
|
"image_processing_time_seconds": 0.003
|
|
}
|
|
```
|
|
|
|
## Understanding the Log Output
|
|
|
|
### Operation Start Log
|
|
- **prompt_length**: Number of characters in your prompt
|
|
- **operation**: The type of operation being performed
|
|
- **version**: API version being used
|
|
- **aspect_ratio**: Selected aspect ratio
|
|
- **output_format**: Image format
|
|
- **has_reference_image**: Whether a reference image is provided
|
|
- **reference_images_count**: Number of reference images (for remix)
|
|
|
|
### Operation Complete Log
|
|
- **request_id**: Unique identifier for tracking this API call
|
|
- **credits_used**: Number of credits consumed by this operation
|
|
- **credits_remaining**: Your remaining credit balance
|
|
- **processing_time_seconds**: Time taken by the API to process the request
|
|
- **success**: Whether the operation completed successfully
|
|
- **request_parameters**: Summary of the parameters sent to the API
|
|
|
|
### Performance Summary Log
|
|
- **total_processing_time_seconds**: Total time from start to finish
|
|
- **api_call_time_seconds**: Time spent waiting for the API response
|
|
- **image_processing_time_seconds**: Time spent converting and processing the image
|
|
|
|
## Error Logging Example
|
|
|
|
If an error occurs, you'll see detailed error information:
|
|
|
|
```
|
|
2025-09-16 12:40:15,123 - nodes.reve_api_node.verbose - INFO - ❌ Reve API CREATE operation failed
|
|
{
|
|
"error_type": "ReveAuthenticationError",
|
|
"error_message": "Invalid API key",
|
|
"operation": "create",
|
|
"time_to_failure_seconds": 0.245
|
|
}
|
|
```
|
|
|
|
## Use Cases for Verbose Logging
|
|
|
|
### 1. Debugging API Issues
|
|
Enable verbose logging when troubleshooting API connectivity or authentication problems.
|
|
|
|
### 2. Performance Optimization
|
|
Monitor processing times to identify bottlenecks in your workflows.
|
|
|
|
### 3. Credit Management
|
|
Track credit usage across different operations to optimize costs.
|
|
|
|
### 4. Workflow Documentation
|
|
Create detailed logs of your workflow executions for documentation or auditing.
|
|
|
|
### 5. Support and Troubleshooting
|
|
Provide detailed logs when seeking support for issues.
|
|
|
|
## Best Practices
|
|
|
|
1. **Enable only when needed**: Keep verbose logging disabled for production workflows to reduce console clutter
|
|
2. **Monitor credit usage**: Use the credit tracking information to manage your API usage
|
|
3. **Performance analysis**: Use timing information to optimize your workflows
|
|
4. **Error diagnosis**: Enable verbose logging when experiencing issues for better error information
|
|
|
|
## Performance Impact
|
|
|
|
- **Disabled (default)**: No performance impact
|
|
- **Enabled**: Minimal overhead (~1-5ms per operation for logging)
|
|
- **Log processing**: Structured JSON formatting adds negligible processing time
|
|
|
|
The verbose logging feature is designed to have minimal impact on your workflow performance while providing maximum insight into the API operations.
|