From 3a087eb91839b4731adc694eb565ae5f08937152 Mon Sep 17 00:00:00 2001 From: xchen Date: Fri, 24 May 2024 18:07:22 -0700 Subject: [PATCH 1/4] add documentation on useAzureMonitorSdk feature falg --- docs/scraping/overview.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/scraping/overview.md b/docs/scraping/overview.md index 39916f61..dca327cf 100644 --- a/docs/scraping/overview.md +++ b/docs/scraping/overview.md @@ -77,6 +77,12 @@ values are `v1`. *(Required)* - `azureMetadata.cloud` - The name of the Azure cloud to use. Options are `Global` (default), `China`, `UsGov` & `Germany`. +### Azure Monitor Integration + +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. + +Since the refactoring may not be completely stable, setting feature flag `useAzureMonitorSdk: false` will revert back to using the legacy SDK for scraping. + ### Metric Defaults - `metricDefaults.aggregation.interval` - The default interval which defines over From 676a24669b1ef96414e0f1a01f7347ac3715f770 Mon Sep 17 00:00:00 2001 From: xchen Date: Sun, 2 Jun 2024 19:09:55 -0700 Subject: [PATCH 2/4] move sdk feature flag to under Azure Monitor section under runtime --- docs/scraping/runtime-configuration.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/scraping/runtime-configuration.md b/docs/scraping/runtime-configuration.md index 7efaa1ed..4f0c6e77 100644 --- a/docs/scraping/runtime-configuration.md +++ b/docs/scraping/runtime-configuration.md @@ -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: @@ -351,7 +352,9 @@ 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. +Since the refactoring may not be completely stable, setting feature flag to false will revert back to using the legacy SDK for scraping. Example: ```yaml @@ -360,6 +363,7 @@ azureMonitor: informationLevel: Basic # Optional. Default: Basic isEnabled: false # Optional. Default: false integration: + useAzureMonitorSdk: true # Optional. Default: true history: startingFromInHours: 24 # Optional. Default: 12 ``` From e4cad8e46a875f540b8f22d9d56d26738e679a9c Mon Sep 17 00:00:00 2001 From: xchen Date: Sun, 2 Jun 2024 19:12:48 -0700 Subject: [PATCH 3/4] move sdk feature flag to under Azure Monitor section under runtime --- docs/scraping/overview.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/scraping/overview.md b/docs/scraping/overview.md index dca327cf..39916f61 100644 --- a/docs/scraping/overview.md +++ b/docs/scraping/overview.md @@ -77,12 +77,6 @@ values are `v1`. *(Required)* - `azureMetadata.cloud` - The name of the Azure cloud to use. Options are `Global` (default), `China`, `UsGov` & `Germany`. -### Azure Monitor Integration - -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. - -Since the refactoring may not be completely stable, setting feature flag `useAzureMonitorSdk: false` will revert back to using the legacy SDK for scraping. - ### Metric Defaults - `metricDefaults.aggregation.interval` - The default interval which defines over From d46dff41dea771e618324fa0f7a4ce11d76e83f5 Mon Sep 17 00:00:00 2001 From: Stephen Chen Date: Mon, 3 Jun 2024 08:37:08 -0700 Subject: [PATCH 4/4] Update docs/scraping/runtime-configuration.md Co-authored-by: Tom Kerkhove Signed-off-by: Stephen Chen --- docs/scraping/runtime-configuration.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/scraping/runtime-configuration.md b/docs/scraping/runtime-configuration.md index 4f0c6e77..dabc0f66 100644 --- a/docs/scraping/runtime-configuration.md +++ b/docs/scraping/runtime-configuration.md @@ -354,7 +354,6 @@ The behavior of this can be configured to fit your needs: - 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. -Since the refactoring may not be completely stable, setting feature flag to false will revert back to using the legacy SDK for scraping. Example: ```yaml