Log Analysis for Troubleshooting

Learn how to use logs and monitoring for the Shopware 6 API Connector.

The Shopware 6 API Connector offers extensive logging and monitoring functions for error analysis and monitoring.

1. Activity Log

Overview

The Activity Log records all important actions and events:

1. Open Shopware → Activity Log
2. You see a list of all activities

Logged events

Event	Description
Item upload	Item synchronized to Shopware
Order download	Order imported from Shopware
Price upload	Price updated
Inventory upload	Inventory synchronized
Picture upload	Picture uploaded
PDF upload	Document uploaded
Error	Error during an action

Filtering and searching

You can filter the log by:

• Date – narrow down the period
• Module – only certain functional areas
• Status – success or error
• Record – a specific item, customer, etc.

API Call Log

Detailed API recording

For technical analysis:

1. Enable Allow developer log in the settings
2. Open Shopware → API Calls Log
3. You see all API calls in detail

Logged information

Information	Description
Timestamp	When the call was made
Endpoint	API URL that was called
Method	GET, POST, PUT, DELETE
Request body	Data that was sent
Response code	HTTP status code
Response body	Data that was received
Duration	Execution time

Analyzing an API call

1. Select an entry
2. Choose Show details
3. Analyze the request and response

Job Queue log

Execution history

1. Open Job Queue Entries
2. Select an entry
3. Choose Log Entries

Logged information

Information	Description
Start time	Start of the execution
End time	End of the execution
Duration	Total duration
Status	Success or error
Error message	In case of errors: details

Monitoring dashboard

Order overview

The order overview provides a quick overview:

• Number of imported orders (today/total)
• Last successful synchronization
• Open errors
• Connection status

Status indicators

Status	Meaning
🟢 Green	Everything is OK
🟡 Yellow	Warnings are present
🔴 Red	Errors have occurred

Error notifications

Email notifications

Set up automatic notifications:

1. Open Job Queue Entries
2. Enable Notify on error
3. Enter the email addresses

Notification options

Option	Description
On every error	Immediate notification
Summarized daily	Daily error report
On critical errors	Important errors only

Log retention

Automatic cleanup

Logs are deleted automatically after a defined period:

• Activity Log: 30 days
• API Call Log: 7 days (when the developer log is enabled)
• Job Queue log: 30 days

Manual cleanup

If required, you can delete logs manually:

1. Open the relevant log
2. Filter by period
3. Delete old entries

Best practices

Regular monitoring

• Check the activity logs daily
• React quickly to errors
• Document recurring problems

Developer log

The developer log records detailed data and should only be enabled when required. It can affect performance and stores sensitive data.

Log export

For support requests:

1. Filter the relevant log
2. Export the data
3. Send it to Support