Skip to content

Commit 9093a49

Browse files
committed
Adding diagnostic events documentation
1 parent 0d3d730 commit 9093a49

File tree

4 files changed

+102
-0
lines changed

4 files changed

+102
-0
lines changed

articles/azure-functions/TOC.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -750,6 +750,14 @@
750750
href: errors-diagnostics/sdk-rules/azf0001.md
751751
- name: AZF0002
752752
href: errors-diagnostics/sdk-rules/azf0002.md
753+
- name: Diagnostic events
754+
items:
755+
- name: AZFD0001
756+
href: errors-diagnostics/diagnostic-events/azfd0001.md
757+
- name: AZFD0002
758+
href: errors-diagnostics/diagnostic-events/azfd0002.md
759+
- name: AZFD0003
760+
href: errors-diagnostics/diagnostic-events/azfd0003.md
753761
- name: host.json 2.x reference
754762
href: functions-host-json.md
755763
- name: host.json 1.x reference
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "AZFD0001: AzureWebJobsStorage app setting is not present."
3+
titleSuffix: "Azure Functions"
4+
description: "AZFD0001: AzureWebJobsStorage app setting is not present"
5+
author: soninaren
6+
ms.author: nasoni
7+
ms.topic: troubleshooting
8+
ms.date: 09/03/2022
9+
---
10+
11+
# AZFD0001: AzureWebJobsStorage app setting is not present.
12+
13+
This event is triggered when the function app does not have AzureWebJobsStorage app setting configured for the function app.
14+
15+
| | Value |
16+
|-|-|
17+
| **Event ID** |AZFD0001|
18+
| **Category** |[Usage]|
19+
| **Severity** |Error|
20+
21+
## Event description
22+
`AzureWebJobsStorage` app setting is used to store the connection string of the Azure Storage account associated with the function app. The Azure Functions runtime uses this connection for core behaviors such as coordinating singleton execution of timer triggers, default app key storage and storing diagnostic events.
23+
24+
Refer to this article for more information on `AzureWebJobsStorage` information: https://docs.microsoft.com/en-us/azure/azure-functions/functions-app-settings#azurewebjobsstorage
25+
26+
## How to resolve the event
27+
28+
To resolve this event you need create a new app setting on your function app with name "AzureWebJobsStorage" with a valid Azure Storage account connection string as the value.
29+
30+
## When to suppress the event
31+
32+
This rule should not be suppressed.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "AZFD0002: Value of AzureWebJobsStorage app setting is invalid."
3+
titleSuffix: "Azure Functions"
4+
description: "AZFD0002: Value of AzureWebJobsStorage app setting is invalid."
5+
author: soninaren
6+
ms.author: nasoni
7+
ms.topic: troubleshooting
8+
ms.date: 09/03/2022
9+
---
10+
11+
# AZFD0002: Value of AzureWebJobsStorage app setting is invalid.
12+
13+
This event is triggered when the value of `AzureWebJobsStorage` is not a valid Azure Storage connection string or it is a Keyvault reference.
14+
15+
| | Value |
16+
|-|-|
17+
| **Event ID** |AZFD0002|
18+
| **Category** |[Usage]|
19+
| **Severity** |Error|
20+
21+
## Event description
22+
`AzureWebJobsStorage` app setting is used to store the connection string of the Azure Storage associated with the function app. The Azure Functions runtime uses this connection for core behaviors such as coordinating singleton execution of timer triggers, default app key storage and storing diagnostic events. This app setting needs to have a valid Azure Storage connection string.
23+
24+
Refer to this article for more information on `AzureWebJobsStorage` information: https://docs.microsoft.com/en-us/azure/azure-functions/functions-app-settings#azurewebjobsstorage
25+
26+
## How to resolve the event
27+
To resolve this event you need update the value of `AzureWebJobsStorage` app setting on your function app with a valid Azure Storage account connection string.
28+
29+
## When to suppress the event
30+
This event should suppressed if your function app needs to use Azure Key Vault reference for storing the value of `AzureWebjobsStorage` app setting.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "AZFD0003: Encountered a StorageException while trying to fetch the diagnostic events."
3+
titleSuffix: "Azure Functions"
4+
description: "AZFD0003: Encountered a StorageException while trying to fetch the diagnostic events."
5+
author: soninaren
6+
ms.author: nasoni
7+
ms.topic: troubleshooting
8+
ms.date: 09/03/2022
9+
---
10+
11+
# AZFD0003: Encountered a StorageException while trying to fetch the diagnostic events.
12+
13+
This event is triggered when the Azure Storage connection string stored within the `AzureWebJobsStorage` does not have permissions to access table storage or causes the storage exceptions when trying to connect to Azure Storage.
14+
15+
| | Value |
16+
|-|-|
17+
| **Event ID** |AZFD0003|
18+
| **Category** |[Usage]|
19+
| **Severity** |Error|
20+
21+
## Event description
22+
`AzureWebJobsStorage` app setting is used to store the connection string of the Azure Storage associated with the function app. The Azure Functions runtime uses this connection for core behaviors such as coordinating singleton execution of timer triggers, default app key storage and storing diagnostic events.
23+
24+
This `AzureWebJobsStorage` needs to have permissions (read, write, delete, add and create) to table storage to be able store and fetch diagnostic events.
25+
26+
Refer to this article for more information on `AzureWebJobsStorage` information: https://docs.microsoft.com/en-us/azure/azure-functions/functions-app-settings#azurewebjobsstorage
27+
28+
## How to resolve the event
29+
To resolve this event the connection string stored in `AzureWebJobsStorage` app setting needs to have read, write, delete, add and create permissions to Azure Table storage. Additionally Azure Storage clients should be able to Azure Storage with this connection string without incurring Storage exceptions.
30+
31+
## When to suppress the event
32+
This event should not be suppressed.

0 commit comments

Comments
 (0)