Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.13](backport #39204) Fix Azure Monitor support for multiple aggregation types #39279

Merged
merged 2 commits into from Apr 30, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 29, 2024

Proposed commit message

Fixes two bugs related to supporting multiple aggregation types.

  1. Use aggregation type in MetricRegistry in the cache key.
  2. Create one KeyValuePoint for each aggregation type

(1) Use aggregation type in MetricRegistry in the cache key

The MetricRegistry.NeedsUpdate checks if a metric definition needs an update. If there are multiple metrics config with no dimensions:

  resources:
  - resource_query: "resourceType eq 'Microsoft.EventHub/Namespaces'"
    metrics:
    - aggregations:
        - Maximum
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces
    - aggregations:
        - Minimum
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces
    - aggregations:
        - Average
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces

All three metric configs end up having the same key, ending up skipping the metric collection for the second and third configs.

By adding the aggregation type in the cache key, we can correctly keep track of metric updates.

(2) Create one KeyValuePoint for each aggregation type

Add support for multiple aggregation types in the mapToKeyValuePoints() function to restore support for configs like the following:

  resources:
  - resource_query: "resourceType eq 'Microsoft.EventHub/Namespaces'"
    metrics:
    - namespace: Microsoft.EventHub/Namespaces
      name:
        - ActiveConnections
      aggregations:
        - Average
        - Maximum
        - Minimum
      ignore_unsupported: true
      timegrain: PT1M

I missed this feature in a previous change. Unfortunately, no existing modules or integrations use multiple aggregation types, and no tests exist.

We are adding more tests targeting to cover all existing use cases soon.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • Cover all multiple aggregation type use cases with tests

How to test this PR locally

Related issues

Use cases

The PR must support multiple aggregation types in two different variants:

  • multiple aggregation types in one metric group
  • one aggregation type in multiple groups with the same metric

Here are two variants of the metric ActiveConnections with three aggregation types: Maximum, Minimum, and Avergate:

- module: azure
  metricsets:
    - monitor
  enabled: true
  period: 60s
  client_id: '<redacted>'
  client_secret: '<redacted>'
  tenant_id: '<redacted>'
  subscription_id: '<redacted>'
  refresh_list_interval: 600s
  resources:
  - resource_query: "resourceType eq 'Microsoft.EventHub/Namespaces'"
    metrics:
    - aggregations:
        - Maximum
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces
    - aggregations:
        - Minimum
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces
    - aggregations:
        - Average
      ignore_unsupported: true
      name:
        - ActiveConnections
      namespace: Microsoft.EventHub/Namespaces

This variant should be preferred since in needs less API calls to fetch the same data:

- module: azure
  metricsets:
    - monitor
  enabled: true
  period: 60s
  client_id: '<redacted>'
  client_secret: '<redacted>'
  tenant_id: '<redacted>'
  subscription_id: '<redacted>'
  refresh_list_interval: 600s
  resources:
  - resource_query: "resourceType eq 'Microsoft.EventHub/Namespaces'"
    metrics:
    - namespace: Microsoft.EventHub/Namespaces
      name:
        - ActiveConnections
      aggregations:
        - Average
        - Maximum
        - Minimum
      ignore_unsupported: true
      timegrain: PT1M

Screenshots

Logs


This is an automatic backport of pull request #39204 done by [Mergify](https://mergify.com).

* Add aggregation type to the MetricRegistry key

The MetricRegistry wasn't using the aggregation type in the cache key,
returning the wrong answer to the 'needs update?' question.

* Handle multiple aggregation types

Restores support for multiple aggregation types for the same metric
name.

Adding tests for the known use cases so we don't miss this feature
again in future updates.

(cherry picked from commit 81fc73e)
@mergify mergify bot requested a review from a team as a code owner April 29, 2024 20:50
@mergify mergify bot added the backport label Apr 29, 2024
@mergify mergify bot assigned zmoog Apr 29, 2024
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 29, 2024
@botelastic
Copy link

botelastic bot commented Apr 29, 2024

This pull request doesn't have a Team:<team> label.

Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove extra changelog entries

@elasticmachine
Copy link
Collaborator

elasticmachine commented Apr 29, 2024

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Duration: 55 min 53 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@zmoog zmoog merged commit af2ac6d into 8.13 Apr 30, 2024
29 checks passed
@zmoog zmoog deleted the mergify/bp/8.13/pr-39204 branch April 30, 2024 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants