Skip to content

Commit

Permalink
feat: add documentation on useAzureMonitorSdk feature flag (#62)
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Kerkhove <[email protected]>
  • Loading branch information
hkfgo and tomkerkhove authored Jun 7, 2024
1 parent 98ea44d commit 0b47e91
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/scraping/runtime-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ azureMonitor:
informationLevel: Basic # Optional. Default: Basic
isEnabled: false # Optional. Default: false
integration:
useAzureMonitorSdk: true # Optional. Default: true
history:
startingFromInHours: 24 # Optional. Default: 12
telemetry:
Expand Down Expand Up @@ -351,6 +352,7 @@ The behavior of this can be configured to fit your needs:
API. (Default: `false`)
- `azureMonitor.integration.history.startingFromInHours` - Defines the amount of hours Promitor will use to define the starting point of the time window used for metric queries.
- As an example, the default is 12 hours which means Promitor will fetch all metrics between now - 12 hours and now to find a matching metric. Typically this window can be very small but Promitor provides a margin by default to prevent problems for long aggregation periods. (Default: `12`)
- `azureMonitor.integration.useAzureMonitorSdk` - In the newest release of Promitor, integration with Azure Monitor will use [Azure.Monitor](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/monitor/Azure.Monitor.Query) package under Azure SDK for .NET by default. This migration was needed because the [original SDK](https://github.com/Azure/azure-libraries-for-net) has been deprecated since 2022.

Example:

Expand All @@ -360,6 +362,7 @@ azureMonitor:
informationLevel: Basic # Optional. Default: Basic
isEnabled: false # Optional. Default: false
integration:
useAzureMonitorSdk: true # Optional. Default: true
history:
startingFromInHours: 24 # Optional. Default: 12
```
Expand Down

0 comments on commit 0b47e91

Please sign in to comment.