Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 105 additions & 0 deletions products/paas/shopware/guides/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
nav:
title: Troubleshooting Common Issues
position: 90
---

# Troubleshooting Common Issues

This guide collects practical troubleshooting workflows for Shopware PaaS Native. It focuses on checks you can perform with the CLI, Grafana, and an application shell session.

## Prepare your CLI context

If you regularly work with the same organization, project, or environment, set a default context first:

```sh
sw-paas account context set
```

You can also preselect the default environment for the current shell session:

```sh
export SW_PAAS_ENVIRONMENT=staging
```

This avoids repeated prompts while you troubleshoot. For more details, see the [account guide](../fundamentals/account.md).

## Check timing and trace headers

If a page is slow, intermittently returns an error, or seems to be cached, inspect the current response timings first:

```sh
sw-paas app timing --query "foo=bar"
```

Adding a query parameter helps bypass cached responses, allowing you to inspect a fresh request.

The following response headers are especially useful:

| Header | Meaning |
| ------ | ------- |
| `x-envoy-upstream-service-time` | Time spent inside the Shopware PaaS Native infrastructure for the upstream request |
| `x-trace-id` | Trace identifier that you can search for in Grafana Tempo |
| `x-timer` | Fastly timing information. The `VE` value helps estimate the time between Fastly and the origin infrastructure |

You can also inspect the same headers in your browser's network tab.

## Check logs and traces in Grafana

Once you have confirmed the failing request, continue with logs and traces:

```sh
sw-paas open grafana
```

Use [logs](../monitoring/logs.md) to inspect application output and [traces](../monitoring/traces.md) to follow the request path through the system.

If you already captured an `x-trace-id`, search for that value directly in Tempo to jump to the affected request.

## My deployment finished, but the changes are not live

If an update appears to have completed but the application still serves the old state, inspect the application first:

Check warning on line 61 in products/paas/shopware/guides/troubleshooting.md

View workflow job for this annotation

GitHub Actions / LanguageTool

[LanguageTool] products/paas/shopware/guides/troubleshooting.md#L61

Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1]) Suggestions: `, but` URL: https://languagetool.org/insights/post/comma-before-and/ Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1 Category: PUNCTUATION
Raw output
products/paas/shopware/guides/troubleshooting.md:61:38: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2[1])
 Suggestions: `, but`
 URL: https://languagetool.org/insights/post/comma-before-and/ 
 Rule: https://community.languagetool.org/rule/show/COMMA_COMPOUND_SENTENCE_2?lang=en-US&subId=1
 Category: PUNCTUATION

```sh
sw-paas application get --application-id <application-id>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should also recommend the sw-paas application deployment get to see the different events that occurred during an deployment, e.g. an migration failure.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, I think sw-paas application deployment get is more relevent than sw-paas application get.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tom Bojer (@tombojer) / Renaud Hager (@renaudhager) - can you please update the most relevant command ?

```
Comment thread
TrayserCassa marked this conversation as resolved.

The `updated` timestamp is a useful indicator. If it does not change after you triggered the update, inspect the build logs:

```sh
sw-paas application build logs --application-id <application-id>
```

For the general deployment workflow, see the [applications guide](../fundamentals/applications.md).

## Scheduled tasks or queue workers are stuck

If scheduled tasks remain in `queued` state for too long, start with the worker logs in Grafana. If the logs do not explain the issue, open an application shell:

```sh
sw-paas exec --new
```

From there, run the consumers manually to surface runtime errors:

```sh
bin/console messenger:consume async low_priority failed scheduler_shopware
```

If scheduled tasks are missing after a deployment or update, register them again:

```sh
bin/console scheduled-task:register
```

If you need to inspect the database state directly, open a database tunnel as described in the [database guide](../resources/databases.md).

## What to collect before opening support

If the issue is still unresolved, collect the following information before opening a support request:

- The affected application ID
- The failing URL
- The approximate timestamp of the failing request
- The `x-trace-id`, if available
- Relevant build or deployment log excerpts
1 change: 1 addition & 0 deletions products/paas/shopware/resources/databases.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ sw-paas open service --service database --port 3306
```

Database access is provided through the CLI tunnel. Direct public database exposure is not supported.
Use the Shopware admin password when the MySQL client prompts for the database password.
Comment thread
TrayserCassa marked this conversation as resolved.

### Note

Expand Down
Loading