From b7449b4c8ccdeaf6ff60f149dd3ca152d908f389 Mon Sep 17 00:00:00 2001
From: Nick Warms <Nicholas.WARMS@education.gov.uk>
Date: Wed, 18 Oct 2023 12:47:58 +0100
Subject: [PATCH] Update documentation to include app insights

---
 docs/getting-started.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/getting-started.md b/docs/getting-started.md
index a8ca26201..18df29e1b 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -16,6 +16,7 @@ Use this documentation to configure your local development environment.
   - [Set up continuous testing](#set-up-continuous-testing)
   - [Analyse test coverage](#analyse-test-coverage)
   - [Configure linting and code cleanup](#configure-linting-and-code-cleanup)
+- [Application Insights](#application-insights)
 
 ## Get it working (without Docker)
 
@@ -215,3 +216,16 @@ cd DfE.FindInformationAcademiesTrusts
 npm run lint ## for a list of issues
 npm run lint:fix ## to scan and fix issues
 ```
+
+## Application Insights
+
+App insights is the platform we are using for measuring telemetry. By default app insights is on in dev and test environments and off when running locally or building in a pipeline.
+
+App insights can be enabled locally by including the conncection string in your secrets file. The format should be `"APPLICATIONINSIGHTS_CONNECTION_STRING": "<Connection string here"`
+You can copy the connection string from Azure. Always use the development environment when testing locally.
+
+### Tracking events
+We are tracking page views and requests automatically. If you would like to track your own events then us the TrackEvent method.
+You can track events in the client using javascript or on the server using the app insights module.
+
+More info can be found here https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview
\ No newline at end of file