Index closed events - Githubissues

lunkwill42 commented 1 week ago

Scope and purpose

The original Zino code will sometimes alter already closed events. Apparently, the reasoning goes that operators sometimes prematurely close events for flapping ports (which Håvard E argues that we should maybe disallow in the future). The original Zino therefore takes care to update both a closed flapping event and the currently open flapping event whenever the link trap code handles a flapping state.

A limitation I immediately see is that multiple closed events could exist for a flapping state (until they are expired/scavenged), but we can only index one of them. As with the original code, there is a bias towards only indexing the latest event.

As a side note: Zino 1 used the terms "pre-closed" and "closed" for events. The former refers to events that have been given a state of CLOSED by an operator. The latter refers to events that have been evicted completely from the running state.

This pull request

Adds a get_closed_event() method to the Events class.
Adds internal indexing of closed events to the Events class.

Contributor Checklist

[ ] Added a changelog fragment for towncrier
- Not sure I need this for this feature, which is strictly internal. No effect for end users (yet).
[ ] Added/amended tests for new/changed code
[X] Added/changed documentation
[X] Linted/formatted the code with black, ruff and isort, easiest by using pre-commit
[X] The first line of the commit message continues the sentence "If applied, this commit will ...", starts with a capital letter, does not end with punctuation and is 50 characters or less long. See https://cbea.ms/git-commit/

github-actions[bot] commented 1 week ago

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Elapsed time
✅ PYTHON	black	2	0.54s
✅ PYTHON	isort	2	0.21s
✅ PYTHON	ruff	2	0.01s

See detailed report in MegaLinter reports _Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff_

_MegaLinter is graciously provided by _

github-actions[bot] commented 1 week ago

Test results

3 files 3 suites 53s :stopwatch: 407 tests 407 :white_check_mark: 0 :zzz: 0 :x: 1 221 runs 1 219 :white_check_mark: 2 :zzz: 0 :x:

Results for commit bbcb5be5.

:recycle: This comment has been updated with latest results.

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.90%. Comparing base (58bf6f8) to head (bbcb5be).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #277 +/- ## ======================================= Coverage 98.89% 98.90% ======================================= Files 51 51 Lines 6875 6885 +10 ======================================= + Hits 6799 6809 +10 Misses 76 76 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.