Skip to content

Commit

Permalink
Update documentation to include app insights
Browse files Browse the repository at this point in the history
  • Loading branch information
nwarms committed Oct 18, 2023
1 parent 5862bf1 commit c81c591
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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

0 comments on commit c81c591

Please sign in to comment.