Skip to content

Commit dddbd31

Browse files
authored
Merge branch 'develop' into CEXT-3774-release
2 parents c12c3fa + 322c8b7 commit dddbd31

File tree

9 files changed

+37
-13
lines changed

9 files changed

+37
-13
lines changed
-40.9 KB
Loading
139 KB
Loading
Loading
Loading

src/pages/events/module-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Adobe Commerce is capable of emitting thousands of different observer and plugin
1616

1717
You can use the Commerce Admin or the command line to find supported events and their payloads:
1818

19-
* In the Admin, select **System** > Events > **Events** to display the _Event list_ page.
19+
* In the Admin, select **System** > Events > **Events List** to display the _Events list_ page.
2020

21-
![Event list page](../_images/events/event-list.png)
21+
![Events list page](../_images/events/event-list.png)
2222

2323
The left navigation contains a list of enabled modules on your system. Click on a module name to display a list of supported events. When you select an event, the main panel of the Admin displays the event's payload.
2424

src/pages/events/troubleshooting.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ This topic describes how to resolve frequently encountered issues with Adobe I/O
1212

1313
## Events are not showing in App Builder event registration
1414

15-
If Commerce is correctly [configured](configure-commerce.md), but triggered events aren't being received, check if the events exist in the Commerce `event_data` table.
16-
The `event_data` table temporarily stores events before transforming them into Adobe I/O events. The table contains a status column that can have the following values:
15+
If Commerce is correctly [configured](configure-commerce.md), but triggered events aren't being received, check the the _Events Status_ grid, located at **System** > Events > **Events Status** in the Commerce Admin, to view the status of triggered events that are present in the Commerce `event_data` database table.
16+
17+
![Events Status grid](../_images/events/event-status-grid.png)
18+
19+
You can perform additional troubleshooting by retrieving the contents of the `event_data` table, which contains information that is not displayed in the grid.
20+
This table temporarily stores events before transforming them into Adobe I/O events. The table contains a status column that can have the following values:
1721

1822
Status ID | Status
1923
--- | ---
@@ -26,11 +30,11 @@ You can use the following SQL query to select all events from the `event_data` t
2630

2731
`SELECT * FROM event_data`
2832

29-
Use the query results to determine the next troubleshooting step.
33+
Use the SQL query results or the content of the _Events Status_ grid to determine the next troubleshooting step.
3034

31-
### The table is empty
35+
### The table or grid is empty
3236

33-
If the `event_data` table is empty, use the following procedure to diagnose the problem:
37+
If the `event_data` table or the _Events Status_ grid is empty, use the following procedure to diagnose the problem:
3438

3539
1. Run `bin/magento events:list` to ensure that you have subscribed events.
3640

@@ -48,14 +52,14 @@ If the `event_data` table is empty, use the following procedure to diagnose the
4852
ENABLE_EVENTING: true
4953
```
5054
51-
### The event status is `0`
55+
### The event status is `0` or `Waiting`
5256

53-
Events are sent by crons. If the status of an event in the `event_data` is still `0` after a long period, then the crons are not configured correctly.
57+
Events are sent by crons. If the status of an event is still `0` in the `event_data` table or `Waiting` in the _Events Status_ grid after a long period, then the crons are not configured correctly.
5458
In a Cloud environment, check the logs. Cron execution might have been killed due to lack of space in the environment or other reasons.
5559

56-
### The event status is `2`
60+
### The event status is `2` or `Failure`
5761

58-
The event status `2` indicates there was an error during transmission. Additional information can be found in the `info` column of the table or in the `system.log` file.
62+
An event status of `2` in the `event_data` table, or `Failure` in the _Events Status_ grid, indicates there was an error during transmission. Additional information can be found in the `info` column of the table or in the `system.log` file.
5963
The following CLI command can show only logs related to the event batch sending.
6064

6165
```bash

src/pages/webhooks/hooks.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ You will typically need to send authorization tokens and other connection parame
3535
</hook>
3636
```
3737

38+
The `x-adobe-commerce-request-id` is added automatically to each request and is used to track the request in the system. You can filter logs by this ID to find all logs related to a specific request.
39+
3840
This example defines two headers:
3941

4042
Name | Value

src/pages/webhooks/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The resolution of a remote call also determines whether you should implement a w
2727

2828
Use these guidelines to develop your own webhooks:
2929

30-
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events** to display the Event list page.
30+
1. Identify the Adobe Commerce event that triggers a webhook. Adobe Commerce merchants can browse the available events from the Admin by selecting **System** > Events > **Events** to display the Events list page.
3131

3232
1. Understand the default payload of the corresponding webhook by running the [`bin/magento webhooks:info` command](commands.md#display-the-payload-of-a-webhook).
3333

src/pages/webhooks/responses.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,4 +200,22 @@ An optional hook was executed with a response code other than 2xx within the sof
200200
A required hook was executed with a response code other than 2xx within the soft and hard time limits. | Add error log entry<br/>Throw an exception
201201
An optional hook is aborted due to reaching the hard timeout limit. | Add error log entry
202202
A required hook is aborted due to reaching the hard timeout limit. | Add error log entry<br/>Throw an exception
203-
The execution time of hook exceeds the soft timeout limit. | Add a notice to the error log
203+
The execution time of hook exceeds the soft timeout limit. | Add a notice to the error log
204+
205+
## Database logging
206+
207+
You can enable database logging for debugging webhooks from the Admin. You should not enable database logging in production environments, as it can affect the performance.
208+
209+
To enable database logging, navigate to **Stores** > Settings > **Configuration** > **Adobe Services** > **Webhooks** > **Database logging configuration** and set the **Enabled** option to **Yes**.
210+
211+
![Webhooks database logging configuration](../_images/webhooks/database-logging-configuration.png)
212+
213+
You can configure the minimum log level to store logs in the database and log retention time. The available log levels are `DEBUG`, `INFO`, `WARNING`, and `ERROR`.
214+
215+
The logs are cleared once per day based on the retention time.
216+
217+
When database logging is enabled, the webhook logs are stored in the `webhook_log` table. To check logs in the Admin, navigate to **System** > **Webhooks** > **Webhook Logs**.
218+
219+
![Webhooks database logging](../_images/webhooks/database-logging.png)
220+
221+
You can filter logs by multiple fields, such as webhook method, type, hook name, and request ID.

0 commit comments

Comments
 (0)