opensearch-project / opensearch-project/alerting
Change alert ids to be deterministic instead of auto generated
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 82
- Forks
- 133
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 9
Description
Tuesday Apr 30, 2019 at 20:20 GMT
Originally opened as https://github.com/opendistro-for-elasticsearch/alerting/issues/45
Right now we index alerts and use the auto-generated id's for the documents.
We should move to deterministic ids to solve multiple problems.
ACTIVE alerts should use an id of: <monitor_id>-<trigger_id>
COMPLETED alerts should use an id of: <monitor_id>-<trigger_id>-<start_time>
Benefits:
This would allow us to provide the soon to be created alert's alert_id to the mustache context variable for users to use.
Removes the chance of duplicate alerts being created at the same time.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the alert indexing and ID-generation entry points, then trace how active and completed alerts are distinguished. Done means active IDs use monitor_id-trigger_id, completed IDs append start_time, and concurrent alert creation cannot produce duplicates; add or update relevant tests if the project has them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100