Skip to content

Commit 29f3f67

Browse files
authored
Merge pull request #210117 from soninaren/diagnosticEvents
Adding diagnostic events documentation
2 parents 00e77f5 + 96a0677 commit 29f3f67

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 occurs when the function app doesn't have the `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+
The `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+
For more information, see [AzureWebJobsStorage](../../functions-app-settings.md#azurewebjobsstorage).
25+
26+
## How to resolve the event
27+
28+
Create a new app setting on your function app with name `AzureWebJobsStorage` with a valid storage account connection string as the value. For more information, see [Work with application settings](../../functions-how-to-use-azure-function-app-settings.md#settings).
29+
30+
## When to suppress the event
31+
32+
This event shouldn't 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 occurs when the value of the `AzureWebJobsStorage` app setting is set to either an invalid Azure Storage account connection string or to a Key Vault reference.
14+
15+
| | Value |
16+
|-|-|
17+
| **Event ID** |AZFD0002|
18+
| **Category** |[Usage]|
19+
| **Severity** |Error|
20+
21+
## Event description
22+
The `AzureWebJobsStorage` app setting is used to store the connection string of the 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. This app setting needs to be set to a valid connection string.
23+
24+
For more information, see [AzureWebJobsStorage](../../functions-app-settings.md#azurewebjobsstorage).
25+
26+
## How to resolve the event
27+
Update the value of the `AzureWebJobsStorage` app setting on your function app with a valid storage account connection string.
28+
29+
## When to suppress the event
30+
You should suppress this event when your function app uses an Azure Key Vault reference in the `AzureWebjobsStorage` app setting instead of a connection string. For more information, see [Source application settings from Key Vault](../../../app-service/app-service-key-vault-references.md?toc=%2Fazure%2Fazure-functions%2Ftoc.json#source-application-settings-from-key-vault)
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 occurs when the Azure Storage account connection string value in the `AzureWebJobsStorage` app setting either doesn't have permissions to access Azure Table Storage or generates exceptions when trying to connect to storage.
14+
15+
| | Value |
16+
|-|-|
17+
| **Event ID** |AZFD0003|
18+
| **Category** |[Usage]|
19+
| **Severity** |Error|
20+
21+
## Event description
22+
The `AzureWebJobsStorage` app setting is used to store the connection string of the 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+
The connection string set in `AzureWebJobsStorage` must be for an account that has permissions to store and read diagnostic events from Table Storage. The complete set of read, write, delete, add, and create events must be supported.
25+
26+
For more information, see [AzureWebJobsStorage](../../functions-app-settings.md#azurewebjobsstorage).
27+
28+
## How to resolve the event
29+
Make sure that the storage account for the connection string stored in `AzureWebJobsStorage` has permissions to read, write, delete, add and create in Table Storage. Clients should be able to access Storage using this connection string without generating exceptions.
30+
31+
## When to suppress the event
32+
This event should not be suppressed.

0 commit comments

Comments
 (0)