|
1 | 1 | --- |
2 | | -title: How to enable subscription logging |
| 2 | +title: Use subscription logging to troubleshoot notifications |
3 | 3 | titleSuffix: Azure DevOps |
4 | | -description: How to use subscription logging to troubleshoot Azure DevOps Services notifications |
| 4 | +description: Enable subscription logging and access diagnostic logs to troubleshoot notification issues in Azure DevOps. |
5 | 5 | ms.subservice: azure-devops-notifications |
6 | 6 | ms.reviewer: wismythe |
7 | 7 | ms.author: chcomley |
8 | 8 | author: chcomley |
9 | | -ms.topic: conceptual |
10 | | -ms.date: 01/22/2020 |
| 9 | +ms.topic: how-to |
| 10 | +ms.date: 07/02/2025 |
11 | 11 | monikerRange: '<= azure-devops' |
| 12 | +#customer intent: As a project member, I want to enable subscription logging and access diagnostic logs so that I can troubleshoot notification delivery issues in Azure DevOps. |
12 | 13 | --- |
13 | 14 |
|
14 | | - |
15 | | -# How to enable subscription logging for troubleshooting |
| 15 | +# Use subscription logging to troubleshoot notifications |
16 | 16 |
|
17 | 17 | [!INCLUDE [version-lt-eq-azure-devops](../../includes/version-lt-eq-azure-devops.md)] |
18 | 18 |
|
19 | 19 | [!INCLUDE [note-smtp-server](includes/note-smtp-server.md)] |
20 | 20 |
|
21 | | - For certain activities, when you select **Team members by role**, you can choose to have the user that initiated the activity receive a notification. This notification is controlled by the **Skip initiator** checkbox. By default, this box is checked, meaning the user that starts the change isn't notified about it. |
22 | | - |
23 | | -Subscription logging is a valuable tool for troubleshooting. It provides diagnostic information from the notifications pipeline and is disabled by default. Once enabled, up to 25 logs, or one hour's worth of logs, are collected for the subscription. |
| 21 | +Subscription logging helps you troubleshoot notification issues by providing diagnostic information from the notifications pipeline. This feature is disabled by default. When enabled, Azure DevOps collects up to 25 logs or one hour's worth of diagnostic data for the subscription, whichever limit is reached first. |
24 | 22 |
|
25 | 23 | ## Prerequisites |
26 | 24 |
|
27 | 25 | [!INCLUDE [prerequisites-project-member-only](../../includes/prerequisites-project-member-only.md)] |
28 | 26 |
|
29 | 27 | ## Enable subscription logging |
30 | 28 |
|
31 | | -To enable subscription logging, complete the following steps: |
| 29 | +1. Go to the notifications page with diagnostics enabled by entering this URL in your browser: |
| 30 | + |
| 31 | + `https://dev.azure.com/{Your_Organization}/_notifications?diagnostics=true` |
32 | 32 |
|
33 | | -1. Enable diagnostics for your organization by entering the following URL in your browser: |
| 33 | + Replace `{Your_Organization}` with your organization name (for example, `https://dev.azure.com/contoso/_notifications?diagnostics=true`). |
34 | 34 |
|
35 | | - `https://dev.azure.com/{organization}/_notifications?diagnostics=true` |
| 35 | +2. On the notifications page, locate the subscription you want to debug and select its context menu (three dots). |
36 | 36 |
|
37 | | -2. The option _Enable Diagnostics_ appears in the subscription context menu. |
| 37 | +3. Select **Enable Diagnostics** from the menu to start collecting logs for that subscription. |
38 | 38 |
|
39 | 39 | > [!div class="mx-imgBorder"] |
40 | 40 | > |
41 | 41 |
|
42 | | -## View subscription diagnostic logs for event matching |
43 | | - |
44 | | -Get all subscription event processing logs by entering the following URL in your browser: |
45 | | - |
46 | | -`https://dev.azure.com/{organization}/_apis/notification/DiagnosticLogs/{event ID}/entries?startTime={date}&endTime={date}` |
47 | | - |
48 | | -* _organization_ is your organization (for example, dev.azure.com/fabrikam-fiber) |
49 | | -* _date_ is a date time specification (for example, **2018-06-29** or **2018-06-29 02:00**) |
50 | | -* _event ID_ is **915f48f2-1b64-40d9-a43f-fe2528b4f296** for work item events, or |
51 | | -* _event ID_ is **9a688110-9e33-4cdc-affd-75d16303e7f1** for Git events, or |
52 | | -* _event ID_ is **a4804dcf-4bb6-4109-b61c-e59c2e8a9ff7** for any other event type |
| 42 | +## View subscription diagnostic logs |
53 | 43 |
|
54 | | -The result is JSON-formatted logging information. |
| 44 | +Access subscription diagnostic logs directly using API calls. Enter the following URL in your browser: |
55 | 45 |
|
56 | | -## View subscription diagnostic logs for notification delivery |
| 46 | +`https://dev.azure.com/{Your_Organization}/_apis/notification/DiagnosticLogs/{eventID}/entries?startTime={date}&endTime={date}` |
57 | 47 |
|
58 | | -Retrieve all notification delivery logs in a given time frame by entering the URL in your browser. |
| 48 | +**Parameters:** |
| 49 | +* `{Your_Organization}` - Your organization name (for example, `contoso`) |
| 50 | +* `{date}` - Date and time in format `YYYY-MM-DD` or `YYYY-MM-DD HH:MM` (for example, `2025-07-02` or `2025-07-02 14:30`) |
| 51 | +* `{eventID}` - Use the appropriate event ID based on the type of logs you need: |
59 | 52 |
|
60 | | -`https://dev.azure.com/{organization}/_apis/notification/DiagnosticLogs/{event ID}/entries?startTime={date}&endTime={date}` |
| 53 | +**Event matching logs:** |
| 54 | +* `915f48f2-1b64-40d9-a43f-fe2528b4f296` for work item events |
| 55 | +* `9a688110-9e33-4cdc-affd-75d16303e7f1` for Git events |
| 56 | +* `a4804dcf-4bb6-4109-b61c-e59c2e8a9ff7` for other event types |
61 | 57 |
|
62 | | -* _organization_ is your organization (for example, dev.azure.com/fabrikam-fiber) |
63 | | -* _date_ is a date time specification (for example, **2018-06-29** or **2018-06-29 02:00**) |
64 | | -* _event ID_ is **631f49b3-46e1-42ec-8fff-081bd176c18a** for work item events, or |
65 | | -* _event ID_ is **8833fc71-42ca-441b-ab12-25314877772d** for Git events, or |
66 | | -* _event ID_ is **a96d6177-beef-477a-a2ee-2c31433214d0** for any other event type |
| 58 | +**Notification delivery logs:** |
| 59 | +* `631f49b3-46e1-42ec-8fff-081bd176c18a` for work item events |
| 60 | +* `8833fc71-42ca-441b-ab12-25314877772d` for Git events |
| 61 | +* `a96d6177-beef-477a-a2ee-2c31433214d0` for other event types |
67 | 62 |
|
68 | | -The result is JSON-formatted logging information. |
| 63 | +Returns JSON-formatted diagnostic information. |
69 | 64 |
|
70 | 65 | ## Related articles |
71 | 66 |
|
|
0 commit comments