@microsoft/docusaurus-plugin-application-insights
Version:
Microsoft Application Insights plugin for Docusaurus.
67 lines (49 loc) • 4.38 kB
Markdown
# docusaurus-plugin-application-insights
[](https://badge.fury.io/js/@microsoft%2Fdocusaurus-plugin-application-insights)
[](#badge)
A Docusaurus plugin that lets you track page views using [Microsoft Application Insights](https://www.npmjs.com/package/@microsoft/applicationinsights-web).
This plugin is only active in production mode.
## Configuration
Install the plugin
```bash npm2yarn
npm install @microsoft/docusaurus-plugin-application-insights
```
Add the plugin to your plugin configuration along with the [application-insights-web configuration](https://github.com/microsoft/ApplicationInsights-JS#snippet-configuration-options) object.
```js
const config = {
plugins: [
...,
["@microsoft/docusaurus-plugin-application-insights", {
config: {
instrumentationKey: "YOUR KEY HERE"
}
enableClickAnalytics: false,
}]
]
}
```
## Options
The following options are available:
| Field | Type | Required | Default Value | Description |
| ----- | ---- | -------- | ------------- | ----------- |
| config | [ApplicationInsightsConfig](https://github.com/microsoft/docusaurus-plugins/blob/93e73418af086ae0cd821dc56c28b01f9515f7f2/packages/docusaurus-plugin-application-insights/src/options.ts#L10) | Yes | N/A | This object holds the configuration for Application Insights. It has many possible fields including `instrumentationKey`, `endpointUrl`, `maxBatchInterval`, etc. See [ApplicationInsights-JS Configuration](https://github.com/microsoft/ApplicationInsights-JS#configuration) for full details. |
| enableClickAnalytics | boolean | No | `false` | If set to `true`, enables click analytics. |
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.