Skip to content

Commit f43810b

Browse files
committed
Added telemetry info
1 parent 2ad0a93 commit f43810b

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/documentation/docs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,19 @@ Once the package is installed, you will have to configure the resource file of t
3030
"ControlStrings": "node_modules/@pnp/spfx-controls-react/lib/loc/{locale}.js"
3131
```
3232

33+
## Telemetry
34+
35+
All controls gather telemetry to verify the usage. Only the name of the control and related data gets captured.
36+
37+
> More information about the service that we are using for this can be found here: [PnP Telemetry Proxy](https://github.com/pnp/telemetry-proxy-node).
38+
39+
Since version `1.17.0` it is possible to opt-out of the telemetry by adding the following code to your web part:
40+
41+
```typescript
42+
const telemetry = PnPTelemetry.getInstance();
43+
telemetry.optOut();
44+
```
45+
3346
## Available controls
3447

3548
The following controls are currently available:

0 commit comments

Comments
 (0)