Skip to content

Commit e6174b2

Browse files
author
Hugo Bernier
committed
chore:sample prep
1 parent 49f7c69 commit e6174b2

3 files changed

Lines changed: 28 additions & 43 deletions

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v22.16.0

samples/react-application-tenant-telemetry-listener/README.md

Lines changed: 26 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ The telemetry is sent either directly to **Azure Application Insights** or to a
1414

1515
![Telemetry Overview](assets/preview.png)
1616

17-
---
18-
1917
## Summary
2018

2119
This SPFx Application Customizer listens for telemetry events via the browser’s `CustomEvent` API:
@@ -42,47 +40,47 @@ The extension enriches the payload with site and page context and then forwards
4240
✔ Deployment instructions (tenant-wide)
4341
✔ App Insights Log queries
4442

45-
---
46-
4743
## Compatibility
4844

49-
![SPFx 1.20](https://img.shields.io/badge/SPFx-1.20-green.svg)
50-
![Node.js v18](https://img.shields.io/badge/Node.js-v18-green.svg)
51-
![SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
52-
![Workbench unsupported](https://img.shields.io/badge/Workbench-Unsupported-red.svg)
45+
| :warning: Important |
46+
|:---------------------------|
47+
| Every SPFx version is optimally compatible with specific versions of Node.js. In order to be able to Toolchain this sample, you need to ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
48+
|Refer to <https://aka.ms/spfx-matrix> for more information on SPFx compatibility. |
5349

54-
---
50+
This sample is optimally compatible with the following environment configuration:
51+
52+
![SPFx 1.21.1](https://img.shields.io/badge/SPFx-1.21.1-green.svg)
53+
![Node.js v22](https://img.shields.io/badge/Node.js-v22-green.svg)
54+
![Toolchain: Heft](https://img.shields.io/badge/Toolchain-Heft-green.svg)
55+
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
56+
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
57+
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
58+
![Local Workbench Unsupported](https://img.shields.io/badge/Local%20Workbench-Unsupported-red.svg "Local workbench is no longer available as of SPFx 1.13 and above")
59+
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
60+
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
5561

5662
## Applies to
5763

5864
* [SharePoint Framework](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
5965
* [Microsoft 365 tenant](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
6066

61-
---
62-
6367
## Contributors
6468

6569
* [Valeras Narbutas](https://github.com/ValerasNarbutas)
6670

67-
---
68-
6971
## Version history
7072

7173
| Version | Date | Comments |
7274
| ------- | ---------- | --------------- |
7375
| 1.0 | November 18, 2025 | Initial release |
7476

75-
---
76-
7777
## Prerequisites
7878

7979
* Azure Application Insights **or** Azure Function endpoint
8080
* Tenant App Catalog
8181
* Modern SharePoint pages
8282

83-
---
84-
85-
# Minimal Path to Awesome
83+
## Minimal Path to Awesome
8684

8785
### 1. Clone the repo
8886

@@ -143,9 +141,7 @@ Save → telemetry starts flowing across the entire tenant.
143141

144142
![Telemetry AppCatalog](assets/previewAppCatalog.png)
145143

146-
---
147-
148-
# How to Use in Your Web Parts
144+
## How to Use in Your Web Parts
149145

150146
Your web part (or another extension) simply dispatches an event:
151147

@@ -173,9 +169,7 @@ That’s all.
173169
No dependency imports. No service initialization.
174170
The Application Customizer handles all communication.
175171

176-
---
177-
178-
# How to Test Via Console
172+
## How to Test Via Console
179173

180174
Open any modern SharePoint page, then run:
181175

@@ -197,9 +191,7 @@ window.dispatchEvent(
197191

198192
The Application Customizer logs the event and pushes telemetry.
199193

200-
---
201-
202-
# How to Verify in Application Insights
194+
## How to Verify in Application Insights
203195

204196
Go to **Logs** and run:
205197

@@ -219,9 +211,7 @@ customEvents
219211
| top 50 by timestamp desc
220212
```
221213

222-
---
223-
224-
# How to Test Azure Function Mode
214+
## How to Test Azure Function Mode
225215

226216
If using Azure Function mode, telemetry is sent via:
227217

@@ -231,7 +221,7 @@ Content-Type: application/json
231221
Body: { ...payload }
232222
```
233223

234-
### Check your Function:
224+
### Check your Function
235225

236226
#### 1. Azure Portal → Function App → Function → **Monitor**
237227

@@ -254,7 +244,7 @@ You should see the JSON payload:
254244
}
255245
```
256246

257-
#### 3. Your function can forward to:
247+
#### 3. Your function can forward to
258248

259249
* Event Grid
260250
* Log Analytics
@@ -263,7 +253,7 @@ You should see the JSON payload:
263253

264254
---
265255

266-
# Debug URL
256+
## Debug URL
267257

268258
To test the extension locally:
269259

@@ -275,9 +265,7 @@ To test the extension locally:
275265

276266
(Update `ComponentId` and endpoint as needed.)
277267

278-
---
279-
280-
# Features
268+
## Features
281269

282270
This sample demonstrates:
283271

@@ -292,10 +280,6 @@ This sample demonstrates:
292280
✔ Component identity and version
293281
✔ Custom event data
294282

295-
---
296-
297-
# Disclaimer
298-
299-
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND.**
300-
283+
## Disclaimer
301284

285+
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**

samples/react-application-tenant-telemetry-listener/assets/sample.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
},
2323
{
2424
"key": "SPFX-VERSION",
25-
"value": "1.20.0"
25+
"value": "1.21.1"
2626
}
2727
],
2828
"tags": [],

0 commit comments

Comments
 (0)