From 93a1960501609f2ad03ad11e479e4ecbac396061 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ajdin=20Ljevakovi=C4=87?= Date: Fri, 7 Jun 2024 11:17:26 +0200 Subject: [PATCH 1/4] Update Microsoft Azure Service Bus Query filter explanation added --- .../doc/Microsoft_Azure_-_Service_Bus.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/connector/doc/Microsoft_Azure_-_Service_Bus.md b/connector/doc/Microsoft_Azure_-_Service_Bus.md index 33eb6afd..19a6200d 100644 --- a/connector/doc/Microsoft_Azure_-_Service_Bus.md +++ b/connector/doc/Microsoft_Azure_-_Service_Bus.md @@ -42,6 +42,39 @@ Enabling or disabling polling of metrics can be done on the **Configuration** pa On the **General** page, you can configure the **Polling Interval** for the metrics. This same page also displays the scope (Subscription and Resource Group) that this resource type element belongs to. +One more parameter can be configured on the **General** page: **Query Filter**. The filter is used to reduce the set of metric data returned. + +Explanation on how filter works, with examples where metric contains metadata A, B and C: +- Return all time series of C where A = a1 and B = b1 or b2 + - filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' +- Invalid variant + - filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'. This is invalid because the logical or operator cannot separate two different metadata names. +- Return all time series where A = a1, B = b1 and C = c1 + - filter=A eq 'a1' and B eq 'b1' and C eq 'c1' +- Return all time series where A = a1 + - filter=A eq 'a1' and B eq '' and C eq ''. +- If multiple entities are present in same namespace filter can be utilized to use only one + - filter=entityname eq 'prod' +- Following metrics support filtering by EntityName: + - Abandoned Messages + - Active Messages + - Completed Messages + - Connections Closed + - Connections Opened + - Dead Lettered Messages + - Incoming Messages + - Incoming Requests + - Messages + - Outgoing Messages + - Scheduled Messages + - Server Errors + - Server Send Latency + - Successful Requests + - Throttled Requests + - User Errors + +If filter entered is in incorrect format or if metric does not support filtering of that type then metric will be polled without filtering. + ## Notes This connector is intended to be used together with the **Microsoft Azure Cloud Platform** connector. Without this manager connector, the connector will not work, as the authentication to the Azure Cloud Platform is done via the manager connector. From 95f185d769d4adb668db91f825c8e847cf2473d9 Mon Sep 17 00:00:00 2001 From: MariekeGO <94605575+MariekeGO@users.noreply.github.com> Date: Mon, 10 Jun 2024 13:12:25 +0200 Subject: [PATCH 2/4] Update Microsoft_Azure_-_Service_Bus.md --- .../doc/Microsoft_Azure_-_Service_Bus.md | 80 ++++++++++++------- 1 file changed, 49 insertions(+), 31 deletions(-) diff --git a/connector/doc/Microsoft_Azure_-_Service_Bus.md b/connector/doc/Microsoft_Azure_-_Service_Bus.md index 19a6200d..a3a18e9b 100644 --- a/connector/doc/Microsoft_Azure_-_Service_Bus.md +++ b/connector/doc/Microsoft_Azure_-_Service_Bus.md @@ -38,42 +38,60 @@ This connector uses an HTTP connection. However, it requires no input from the u The connector requires no user input. The metrics that are polled for this resource type element are displayed on the **Metrics** page. +### Polling Configuration + Enabling or disabling polling of metrics can be done on the **Configuration** page. Polling of these metric has a direct financial impact. On the **General** page, you can configure the **Polling Interval** for the metrics. This same page also displays the scope (Subscription and Resource Group) that this resource type element belongs to. -One more parameter can be configured on the **General** page: **Query Filter**. The filter is used to reduce the set of metric data returned. - -Explanation on how filter works, with examples where metric contains metadata A, B and C: -- Return all time series of C where A = a1 and B = b1 or b2 - - filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*' -- Invalid variant - - filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'. This is invalid because the logical or operator cannot separate two different metadata names. -- Return all time series where A = a1, B = b1 and C = c1 - - filter=A eq 'a1' and B eq 'b1' and C eq 'c1' -- Return all time series where A = a1 - - filter=A eq 'a1' and B eq '' and C eq ''. +### Query Filter + +Also on the **General** page, you can configure the **Query Filter**. This filter is used to reduce the set of metric data returned. + +This is how the filter works, based on an example where the metric contains the metadata A, B, and C: + +- To return all time series of C where A = a1 and B = b1 or b2: + + `filter=A eq 'a1' and B eq 'b1' or B eq 'b2' and C eq '*'` + + Invalid variant: + + `filter=A eq 'a1' and B eq 'b1' and C eq '*' or B = 'b2'` + + This is invalid because the logical "or" operator cannot separate two different metadata names. + +- To return all time series where A = a1, B = b1 and C = c1: + + `filter=A eq 'a1' and B eq 'b1' and C eq 'c1'` + +- To return all time series where A = a1: + + `filter=A eq 'a1' and B eq '' and C eq ''` + - If multiple entities are present in same namespace filter can be utilized to use only one - - filter=entityname eq 'prod' -- Following metrics support filtering by EntityName: - - Abandoned Messages - - Active Messages - - Completed Messages - - Connections Closed - - Connections Opened - - Dead Lettered Messages - - Incoming Messages - - Incoming Requests - - Messages - - Outgoing Messages - - Scheduled Messages - - Server Errors - - Server Send Latency - - Successful Requests - - Throttled Requests - - User Errors - -If filter entered is in incorrect format or if metric does not support filtering of that type then metric will be polled without filtering. + + `filter=entityname eq 'prod'` + + The following metrics support filtering by EntityName: + + - Abandoned Messages + - Active Messages + - Completed Messages + - Connections Closed + - Connections Opened + - Dead Lettered Messages + - Incoming Messages + - Incoming Requests + - Messages + - Outgoing Messages + - Scheduled Messages + - Server Errors + - Server Send Latency + - Successful Requests + - Throttled Requests + - User Errors + +If the specified filter does not use the correct format, or if the metric does not support a filter of that type, then the filter will not be applied. ## Notes From e0bef5e67dda7fd926f715b48cabc295119162e0 Mon Sep 17 00:00:00 2001 From: Marieke Goethals <94605575+MariekeGO@users.noreply.github.com> Date: Mon, 10 Jun 2024 13:18:41 +0200 Subject: [PATCH 3/4] Update connector/doc/Microsoft_Azure_-_Service_Bus.md --- connector/doc/Microsoft_Azure_-_Service_Bus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/connector/doc/Microsoft_Azure_-_Service_Bus.md b/connector/doc/Microsoft_Azure_-_Service_Bus.md index a3a18e9b..81b45949 100644 --- a/connector/doc/Microsoft_Azure_-_Service_Bus.md +++ b/connector/doc/Microsoft_Azure_-_Service_Bus.md @@ -68,7 +68,7 @@ This is how the filter works, based on an example where the metric contains the `filter=A eq 'a1' and B eq '' and C eq ''` -- If multiple entities are present in same namespace filter can be utilized to use only one +- If multiple entities are present in the same namespace, a filter can be utilized to use only one: `filter=entityname eq 'prod'` From b7c2f95b42b679b1cd1ed75e4053ae15cf7d2143 Mon Sep 17 00:00:00 2001 From: Marieke Goethals <94605575+MariekeGO@users.noreply.github.com> Date: Mon, 10 Jun 2024 13:19:29 +0200 Subject: [PATCH 4/4] Update Microsoft_Azure_-_Service_Bus.md --- connector/doc/Microsoft_Azure_-_Service_Bus.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/connector/doc/Microsoft_Azure_-_Service_Bus.md b/connector/doc/Microsoft_Azure_-_Service_Bus.md index 81b45949..970420b4 100644 --- a/connector/doc/Microsoft_Azure_-_Service_Bus.md +++ b/connector/doc/Microsoft_Azure_-_Service_Bus.md @@ -72,7 +72,7 @@ This is how the filter works, based on an example where the metric contains the `filter=entityname eq 'prod'` - The following metrics support filtering by EntityName: + The following metrics support filtering by entity name: - Abandoned Messages - Active Messages