Health Monitor
The WooCommerce Health Monitor is your central dashboard for tracking the status of all synchronization activity between Brother POS and your WooCommerce store. Use it to verify that syncs are running, identify failures, and take corrective action.
Accessing the Health Monitor
- Log in to the Brother POS Admin Panel.
- Navigate to Settings and click the WooCommerce Monitor link (or go to the WooCommerce configuration page and click Monitor).
- The Health Monitor dashboard loads with real-time status information.
Dashboard Overview
The Health Monitor displays four key sections:
1. Integration Health Status
A color-coded banner at the top shows the overall health of your WooCommerce integration:
| Status | Color | Meaning |
|---|---|---|
| Healthy | Green | Integration is working normally. No recent errors. |
| Warning | Yellow | Recent sync failures detected in the last hour. Investigation recommended. |
| Error | Red | Missing credentials or critical configuration issue. Sync is not running. |
| Disabled | Gray | WooCommerce integration is not configured or not enabled. |
2. Sync Statistics
Summary statistics for your integration activity:
| Metric | Description |
|---|---|
| Total Syncs | Total number of sync operations since integration was enabled |
| Successful Syncs | Number of syncs that completed without errors |
| Failed Syncs | Number of syncs that encountered errors |
| Last Sync | Timestamp of the most recent sync operation |
| Avg Sync Time | Average duration of successful syncs (in minutes) |
3. Sync Summary
A breakdown of sync activity over two time periods:
Last 24 Hours:
- Total sync operations
- Successful operations
- Failed operations
Last 7 Days:
- Total sync operations
- Successful operations
- Failed operations
4. Recent Sync Logs
The 10 most recent sync operations are displayed with details:
| Column | Description |
|---|---|
| Type | The sync type (product_import, order_import, inventory_push, etc.) |
| Status | Completed or Failed |
| Started At | When the sync began |
| Completed At | When the sync finished (if completed) |
| Records Processed | Number of records evaluated |
| Records Failed | Number of records that encountered errors |
| Error Message | Error details (for failed syncs) |
Sync Types
The Health Monitor tracks several types of sync operations:
| Sync Type | Description | Direction |
|---|---|---|
product_import | Imports products from WooCommerce | WooCommerce -> Brother POS |
product_export | Pushes product changes to WooCommerce | Brother POS -> WooCommerce |
inventory_push | Pushes stock levels to WooCommerce | Brother POS -> WooCommerce |
order_import | Imports orders from WooCommerce | WooCommerce -> Brother POS |
auto_correction | Automatically corrects discrepancies | Both |
change_detection | Detects discrepancies between systems | Both |
Quick Actions
The Health Monitor provides two quick actions:
Test Connection
Click Test Connection to verify that Brother POS can communicate with your WooCommerce store.
- Sends a test API request to your WooCommerce REST API.
- Returns "Connection successful" with store data if the test passes.
- Returns an error message with details if the test fails.
This is useful for diagnosing connectivity issues without waiting for a scheduled sync.
Force Sync
Click Force Sync to trigger an immediate product sync.
- Runs the full product sync process (categories, then products).
- Results appear in the Recent Sync Logs section when complete.
- Does not affect the scheduled sync timer -- the next scheduled sync will still run on time.
Force a sync after making bulk changes in WooCommerce, after resolving connection issues, or when you need changes reflected in Brother POS immediately rather than waiting for the next scheduled cycle.
Reading Sync Logs
Each sync log entry tells a complete story about a sync operation. Here is how to interpret them:
Successful Sync
A healthy sync log entry looks like:
- Status: Completed
- Records Processed: 150 (total products or orders evaluated)
- Records Failed: 0
- Details: Shows breakdown -- products created, updated, skipped, categories synced, etc.
Failed Sync
A problematic sync log entry shows:
- Status: Failed
- Error Message: Description of what went wrong
- Records Processed: How far the sync got before failing
- Records Failed: How many individual records had errors
Understanding Sync Details
When you expand a sync log entry, the details object contains granular metrics:
Product Import Details
| Metric | Description |
|---|---|
products_processed | Total products evaluated |
products_created | New products added to Brother POS |
products_updated | Existing products updated |
products_failed | Products that failed to import |
variations_processed | Total variations evaluated |
variations_created | New variations created |
variations_updated | Existing variations updated |
categories_synced | Categories created or updated |
categories_failed | Categories that failed to sync |
Inventory Push Details
| Metric | Description |
|---|---|
products_processed | Total products evaluated for pushing |
products_updated | Products successfully pushed |
products_failed | Products that failed to push |
products_skipped | Products without WooCommerce mappings |
variations_updated | Variations successfully pushed |
variations_failed | Variations that failed to push |
Common Health Issues
"Missing credentials"
Cause: Store URL, Consumer Key, or Consumer Secret is not configured.
Fix: Go to Settings and click the WooCommerce Integration link, then enter all required credentials.
"WooCommerce not enabled"
Cause: The integration is configured but the enabled toggle is off.
Fix: Go to Settings and click the WooCommerce Integration link, then toggle the Enabled switch.
"Recent sync failures detected"
Cause: One or more sync operations failed in the last hour.
Fix: Check the Recent Sync Logs for error details. Common causes include:
- Network connectivity issues (temporary -- will self-resolve)
- WooCommerce API rate limits (increase polling interval)
- Product validation errors (fix product data in WooCommerce)
- Expired or revoked API keys (re-generate in WooCommerce)
Sync Timestamps
Brother POS tracks the last sync time for each sync type independently:
| Timestamp | What It Tracks |
|---|---|
last_product_sync_at | Last successful product import |
last_order_sync_at | Last successful order import |
last_inventory_push_at | Last successful inventory push |
These timestamps determine when the next sync is due. If a timestamp is older than the polling interval, the sync is overdue and will run on the next cycle.
Alerting and Notifications
The Health Monitor provides visual alerts on the dashboard. Currently, Brother POS monitors:
- Consecutive failures: If syncs fail repeatedly, the health status changes to Warning or Error.
- Stale syncs: If no sync has run in more than twice the polling interval, investigation is recommended.
- High failure rate: If more than 10% of recent syncs have failed.
Email and webhook notifications for sync failures are planned for a future release. Currently, monitoring requires checking the Health Monitor dashboard periodically.
Best Practices
- Check the Health Monitor daily. Make it part of your opening routine to verify the integration is healthy.
- Investigate warnings promptly. A "Warning" status means something failed recently. Even if it self-corrected, understanding the cause prevents future issues.
- Review failed records. A successful sync can still have individual failed records. Expand the sync details to see if any products or orders need attention.
- Keep your polling interval reasonable. Very short intervals (under 2 minutes) can trigger WooCommerce API rate limits.
- Test after changes. After updating API keys, changing your store URL, or updating the WooCommerce plugin, use the Test Connection button to verify.
What's Next?
- WooCommerce Setup -- Review or update your integration configuration.
- Product Sync -- Deep dive into how product sync works.
- Order Sync -- Understand the order import process.
- Inventory Sync -- Learn about stock level pushing.