Fix UTF-8 not allowed in Equal field for inhibition rules #4177

grobinson-grafana · 2024-12-20T19:46:02Z

This commit fixes a bug where UTF-8 characters are not allowed in the Equal field for inhibition rules, even when UTF-8 strict mode is enabled.

This bug occurred because we forgot to override the validation in model.LabelName. I have copied the same logic used for GroupBy with GroupByStr, adding EqualStr.

We would like to upgrade prometheus/common in future and use the validation there instead, but it presents challenges with downstream projects like Mimir and Cortex where, at present, UTF-8 can be enabled and disabled in separate components at the same time, which is not supported in prometheus/common.

This commit fixes a bug where UTF-8 characters are not allowed in the Equal field for inhibition rules, even when UTF-8 strict mode is enabled. This bug occurred because we forgot to override the validation in model.LabelName. I have copied the same logic used for GroupBy with GroupByStr, adding EqualStr. We would like to upgrade prometheus/common in future and use the validation there instead, but it presents challenges with downstream projects like Mimir and Cortex where, at present, UTF-8 can be enabled and disabled in separate components at the same time, which is not supported in prometheus/common. Signed-off-by: George Robinson <george.robinson@grafana.com>

grobinson-grafana · 2024-12-21T02:25:39Z

I did a full test of this, including the inhibiting behavior, and can confirm that it works. The first test was without an emoji in equal as a control test:

inhibit_rules:
    - equal:
        - baz
      source_matchers:
        - "foo\U0001F642=bar"
      target_matchers:
        - "bar\U0001F642=baz"

and we can see that the alert was inhibited:

[
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:23:33.061Z",
    "fingerprint": "3381011f87e9020c",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:18:33.061Z",
    "status": {
      "inhibitedBy": [
        "c72bcc07a25e8ca7"
      ],
      "mutedBy": null,
      "silencedBy": [],
      "state": "suppressed"
    },
    "updatedAt": "2024-12-21T02:18:33.061Z",
    "labels": {
      "bar🙂": "baz",
      "baz": "corge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:23:27.690Z",
    "fingerprint": "c72bcc07a25e8ca7",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:18:27.690Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:18:27.690Z",
    "labels": {
      "baz": "corge",
      "foo🙂": "bar"
    }
  }
]

The second test used the same matchers, but equal contains an emoji:

inhibit_rules:
    - equal:
        - "baz\U0001F642"
      source_matchers:
        - "foo\U0001F642=bar"
      target_matchers:
        - "bar\U0001F642=baz"

[
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:25:27.553Z",
    "fingerprint": "50e470c7e420595a",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:20:27.553Z",
    "status": {
      "inhibitedBy": [
        "81366be48b8b7751"
      ],
      "mutedBy": null,
      "silencedBy": [],
      "state": "suppressed"
    },
    "updatedAt": "2024-12-21T02:20:27.553Z",
    "labels": {
      "bar🙂": "baz",
      "baz🙂": "corge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:25:21.385Z",
    "fingerprint": "81366be48b8b7751",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:20:21.385Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:20:21.385Z",
    "labels": {
      "baz🙂": "corge",
      "foo🙂": "bar"
    }
  }
]

grobinson-grafana · 2024-12-21T02:35:58Z

I also tested with two alerts that matched the target matchers, however, with the expectation that just one of those alerts is inhibited as it has a matching equal label. The first test was without an emoji as a control test:

inhibit_rules:
    - equal:
        - baz
      source_matchers:
        - "foo\U0001F642=bar"
      target_matchers:
        - "bar\U0001F642=baz"

[
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:32:55.511Z",
    "fingerprint": "3381011f87e9020c",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:27:55.511Z",
    "status": {
      "inhibitedBy": [
        "c72bcc07a25e8ca7"
      ],
      "mutedBy": null,
      "silencedBy": [],
      "state": "suppressed"
    },
    "updatedAt": "2024-12-21T02:27:55.511Z",
    "labels": {
      "bar🙂": "baz",
      "baz": "corge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:33:00.138Z",
    "fingerprint": "ae726b055d42000d",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:28:00.138Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:28:00.138Z",
    "labels": {
      "bar🙂": "baz",
      "baz": "jorge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:32:50.699Z",
    "fingerprint": "c72bcc07a25e8ca7",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:27:50.699Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:27:50.699Z",
    "labels": {
      "baz": "corge",
      "foo🙂": "bar"
    }
  }
]

The second test uses the same matchers, but the equal label has an emoji:

inhibit_rules:
    - equal:
        - "baz\U0001F642"
      source_matchers:
        - "foo\U0001F642=bar"
      target_matchers:
        - "bar\U0001F642=baz"

[
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:35:58.223Z",
    "fingerprint": "50e470c7e420595a",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:30:58.223Z",
    "status": {
      "inhibitedBy": [
        "81366be48b8b7751"
      ],
      "mutedBy": null,
      "silencedBy": [],
      "state": "suppressed"
    },
    "updatedAt": "2024-12-21T02:30:58.223Z",
    "labels": {
      "bar🙂": "baz",
      "baz🙂": "corge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:36:01.436Z",
    "fingerprint": "5e88f11e42a70d0b",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:31:01.436Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:31:01.436Z",
    "labels": {
      "bar🙂": "baz",
      "baz🙂": "jorge"
    }
  },
  {
    "annotations": {},
    "endsAt": "2024-12-21T02:35:54.303Z",
    "fingerprint": "81366be48b8b7751",
    "receivers": [
      {
        "name": "default"
      }
    ],
    "startsAt": "2024-12-21T02:30:54.303Z",
    "status": {
      "inhibitedBy": [],
      "mutedBy": null,
      "silencedBy": [],
      "state": "active"
    },
    "updatedAt": "2024-12-21T02:30:54.303Z",
    "labels": {
      "baz🙂": "corge",
      "foo🙂": "bar"
    }
  }
]

SuperQ

Thanks!

* [CHANGE] Templating errors in the SNS integration now return an error. #3531 #3879 * [CHANGE] Adopt log/slog, drop go-kit/log #4089 * [FEATURE] Add a new Microsoft Teams integration based on Flows #4024 * [FEATURE] Add a new Rocket.Chat integration #3600 * [FEATURE] Add a new Jira integration #3590 #3931 * [FEATURE] Add support for `GOMEMLIMIT`, enable it via the feature flag `--enable-feature=auto-gomemlimit`. #3895 * [FEATURE] Add support for `GOMAXPROCS`, enable it via the feature flag `--enable-feature=auto-gomaxprocs`. #3837 * [FEATURE] Add support for limits of silences including the maximum number of active and pending silences, and the maximum size per silence (in bytes). You can use the flags `--silences.max-silences` and `--silences.max-silence-size-bytes` to set them accordingly #3852 #3862 #3866 #3885 #3886 #3877 * [FEATURE] Muted alerts now show whether they are suppressed or not in both the `/api/v2/alerts` endpoint and the Alertmanager UI. #3793 #3797 #3792 * [ENHANCEMENT] Add support for `content`, `username` and `avatar_url` in the Discord integration. `content` and `username` also support templating. #4007 * [ENHANCEMENT] Only invalidate the silences cache if a new silence is created or an existing silence replaced - should improve latency on both `GET api/v2/alerts` and `POST api/v2/alerts` API endpoint. #3961 * [ENHANCEMENT] Add image source label to Dockerfile. To get changelogs shown when using Renovate #4062 * [ENHANCEMENT] Build using go 1.23 #4071 * [ENHANCEMENT] Support setting a global SMTP TLS configuration. #3732 * [ENHANCEMENT] The setting `room_id` in the WebEx integration can now be templated to allow for dynamic room IDs. #3801 * [ENHANCEMENT] Enable setting `message_thread_id` for the Telegram integration. #3638 * [ENHANCEMENT] Support the `since` and `humanizeDuration` functions to templates. This means users can now format time to more human-readable text. #3863 * [ENHANCEMENT] Support the `date` and `tz` functions to templates. This means users can now format time in a specified format and also change the timezone to their specific locale. #3812 * [ENHANCEMENT] Latency metrics now support native histograms. #3737 * [ENHANCEMENT] Add full width to adaptive card for msteamsv2 #4135 * [ENHANCEMENT] Add timeout option for webhook notifier. #4137 * [ENHANCEMENT] Update config to allow showing secret values when marshaled #4158 * [ENHANCEMENT] Enable templating for Jira project and issue_type #4159 * [BUGFIX] Fix the SMTP integration not correctly closing an SMTP submission, which may lead to unsuccessful dispatches being marked as successful. #4006 * [BUGFIX] The `ParseMode` option is now set explicitly in the Telegram integration. If we don't HTML tags had not been parsed by default. #4027 * [BUGFIX] Fix a memory leak that was caused by updates silences continuously. #3930 * [BUGFIX] Fix hiding secret URLs when the URL is incorrect. #3887 * [BUGFIX] Fix a race condition in the alerts - it was more of a hypothetical race condition that could have occurred in the alert reception pipeline. #3648 * [BUGFIX] Fix a race condition in the alert delivery pipeline that would cause a firing alert that was delivered earlier to be deleted from the aggregation group when instead it should have been delivered again. #3826 * [BUGFIX] Fix version in APIv1 deprecation notice. #3815 * [BUGFIX] Fix crash errors when using `url_file` in the Webhook integration. #3800 * [BUGFIX] fix `Route.ID()` returns conflicting IDs. #3803 * [BUGFIX] Fix deadlock on the alerts memory store. #3715 * [BUGFIX] Fix `amtool template render` when using the default values. #3725 * [BUGFIX] Fix `webhook_url_file` for both the Discord and Microsoft Teams integrations. #3728 #3745 * [BUGFIX] Fix wechat api link #4084 * [BUGFIX] Fix build info metric #4166 * [BUGFIX] Fix UTF-8 not allowed in Equal field for inhibition rules #4177 Signed-off-by: SuperQ <superq@gmail.com>

grobinson-grafana force-pushed the grobinson/fix-inhibit-rules-equal-utf8 branch 6 times, most recently from 83e8f18 to ed0e832 Compare December 20, 2024 20:10

grobinson-grafana force-pushed the grobinson/fix-inhibit-rules-equal-utf8 branch from ed0e832 to ee55078 Compare December 20, 2024 20:22

SuperQ approved these changes Jan 13, 2025

View reviewed changes

SuperQ merged commit ced7949 into prometheus:main Jan 13, 2025
11 checks passed

SuperQ mentioned this pull request Jan 13, 2025

Release v0.28.0 #4176

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix UTF-8 not allowed in Equal field for inhibition rules #4177

Fix UTF-8 not allowed in Equal field for inhibition rules #4177

grobinson-grafana commented Dec 20, 2024 •

edited

Loading

grobinson-grafana commented Dec 21, 2024

grobinson-grafana commented Dec 21, 2024

SuperQ left a comment

Fix UTF-8 not allowed in Equal field for inhibition rules #4177

Fix UTF-8 not allowed in Equal field for inhibition rules #4177

Conversation

grobinson-grafana commented Dec 20, 2024 • edited Loading

grobinson-grafana commented Dec 21, 2024

grobinson-grafana commented Dec 21, 2024

SuperQ left a comment

Choose a reason for hiding this comment

grobinson-grafana commented Dec 20, 2024 •

edited

Loading