-
Notifications
You must be signed in to change notification settings - Fork 36
feat: add odp event manager #403
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
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
7e135eb
add odp event manager
andrewleap-optimizely 079df46
add event manager config
andrewleap-optimizely 35ca02f
add common data/decoder to odp events
andrewleap-optimizely d91be75
fix tests
andrewleap-optimizely 0eeb1cb
remove unnecessary lock
andrewleap-optimizely e641a46
add warning for shutdown queue
andrewleap-optimizely 847082e
address comments
andrewleap-optimizely 4c78039
remove unnecessary copy
andrewleap-optimizely 53962ec
add flushing interval/wait on config
andrewleap-optimizely f6524c8
add test for odp disabled after odp event
andrewleap-optimizely 0aa1da0
Merge branch 'master' into aleap/add_odp_event_manager
andrewleap-optimizely 3d524e8
cleanup
andrewleap-optimizely 3ed7056
cleanup
andrewleap-optimizely 7e1995c
disable event pre-queueing
andrewleap-optimizely 8988870
address comments
andrewleap-optimizely fa2220d
enforce batch size and add auto retries
andrewleap-optimizely 0318a6d
lower flush interval
andrewleap-optimizely d85ec2c
type fix
andrewleap-optimizely File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,238 @@ | ||
# Copyright 2022, Optimizely | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
from __future__ import annotations | ||
from enum import Enum | ||
from threading import Thread | ||
from typing import Optional | ||
import time | ||
from queue import Empty, Queue, Full | ||
|
||
from optimizely import logger as _logging | ||
from .odp_event import OdpEvent, OdpDataDict | ||
from .odp_config import OdpConfig, OdpConfigState | ||
from .zaius_rest_api_manager import ZaiusRestApiManager | ||
from optimizely.helpers.enums import OdpEventManagerConfig, Errors | ||
|
||
|
||
class Signal(Enum): | ||
"""Enum for sending signals to the event queue.""" | ||
SHUTDOWN = 1 | ||
FLUSH = 2 | ||
|
||
|
||
class OdpEventManager: | ||
""" | ||
Class that sends batches of ODP events. | ||
|
||
The OdpEventManager maintains a single consumer thread that pulls events off of | ||
the queue and buffers them before events are sent to ODP. | ||
Sends events when the batch size is met or when the flush timeout has elapsed. | ||
""" | ||
|
||
def __init__( | ||
self, | ||
odp_config: OdpConfig, | ||
logger: Optional[_logging.Logger] = None, | ||
api_manager: Optional[ZaiusRestApiManager] = None | ||
): | ||
"""OdpEventManager init method to configure event batching. | ||
|
||
Args: | ||
odp_config: ODP integration config. | ||
logger: Optional component which provides a log method to log messages. By default nothing would be logged. | ||
api_manager: Optional component which sends events to ODP. | ||
""" | ||
self.logger = logger or _logging.NoOpLogger() | ||
self.zaius_manager = api_manager or ZaiusRestApiManager(self.logger) | ||
self.odp_config = odp_config | ||
self.event_queue: Queue[OdpEvent | Signal] = Queue(OdpEventManagerConfig.DEFAULT_QUEUE_CAPACITY) | ||
self.batch_size = OdpEventManagerConfig.DEFAULT_BATCH_SIZE | ||
self.flush_interval = OdpEventManagerConfig.DEFAULT_FLUSH_INTERVAL | ||
self._flush_deadline: float = 0 | ||
self.retry_count = OdpEventManagerConfig.DEFAULT_RETRY_COUNT | ||
self._current_batch: list[OdpEvent] = [] | ||
"""_current_batch should only be modified by the processing thread, as it is not thread safe""" | ||
self.thread = Thread(target=self._run, daemon=True) | ||
self.thread_exception = False | ||
"""thread_exception will be True if the processing thread did not exit cleanly""" | ||
|
||
@property | ||
def is_running(self) -> bool: | ||
"""Property to check if consumer thread is alive or not.""" | ||
return self.thread.is_alive() | ||
|
||
def start(self) -> None: | ||
"""Starts the batch processing thread to batch events.""" | ||
if self.is_running: | ||
self.logger.warning('ODP event queue already started.') | ||
return | ||
|
||
self.thread.start() | ||
|
||
def _run(self) -> None: | ||
"""Processes the event queue from a child thread. Events are batched until | ||
the batch size is met or until the flush timeout has elapsed. | ||
""" | ||
try: | ||
while True: | ||
timeout = self._get_queue_timeout() | ||
|
||
try: | ||
item = self.event_queue.get(True, timeout) | ||
except Empty: | ||
item = None | ||
|
||
if item == Signal.SHUTDOWN: | ||
self.logger.debug('ODP event queue: received shutdown signal.') | ||
break | ||
|
||
elif item == Signal.FLUSH: | ||
self.logger.debug('ODP event queue: received flush signal.') | ||
self._flush_batch() | ||
self.event_queue.task_done() | ||
continue | ||
|
||
elif isinstance(item, OdpEvent): | ||
self._add_to_batch(item) | ||
self.event_queue.task_done() | ||
|
||
elif len(self._current_batch) > 0: | ||
self.logger.debug('ODP event queue: flushing on interval.') | ||
self._flush_batch() | ||
|
||
except Exception as exception: | ||
andrewleap-optimizely marked this conversation as resolved.
Show resolved
Hide resolved
|
||
self.thread_exception = True | ||
self.logger.error(f'Uncaught exception processing ODP events. Error: {exception}') | ||
|
||
finally: | ||
self.logger.info('Exiting ODP event processing loop. Attempting to flush pending events.') | ||
self._flush_batch() | ||
if item == Signal.SHUTDOWN: | ||
self.event_queue.task_done() | ||
|
||
def flush(self) -> None: | ||
"""Adds flush signal to event_queue.""" | ||
try: | ||
self.event_queue.put_nowait(Signal.FLUSH) | ||
except Full: | ||
self.logger.error("Error flushing ODP event queue") | ||
|
||
def _flush_batch(self) -> None: | ||
"""Flushes current batch by dispatching event. | ||
Should only be called by the processing thread.""" | ||
batch_len = len(self._current_batch) | ||
if batch_len == 0: | ||
self.logger.debug('ODP event queue: nothing to flush.') | ||
return | ||
|
||
api_key = self.odp_config.get_api_key() | ||
api_host = self.odp_config.get_api_host() | ||
|
||
if not api_key or not api_host: | ||
self.logger.debug(Errors.ODP_NOT_INTEGRATED) | ||
self._current_batch.clear() | ||
return | ||
|
||
self.logger.debug(f'ODP event queue: flushing batch size {batch_len}.') | ||
should_retry = False | ||
|
||
for i in range(1 + self.retry_count): | ||
try: | ||
should_retry = self.zaius_manager.send_odp_events(api_key, api_host, self._current_batch) | ||
except Exception as error: | ||
should_retry = False | ||
self.logger.error(Errors.ODP_EVENT_FAILED.format(f'Error: {error} {self._current_batch}')) | ||
|
||
if not should_retry: | ||
break | ||
if i < self.retry_count: | ||
self.logger.debug('Error dispatching ODP events, scheduled to retry.') | ||
|
||
if should_retry: | ||
andrewleap-optimizely marked this conversation as resolved.
Show resolved
Hide resolved
|
||
self.logger.error(Errors.ODP_EVENT_FAILED.format(f'Failed after {i} retries: {self._current_batch}')) | ||
|
||
self._current_batch.clear() | ||
|
||
def _add_to_batch(self, odp_event: OdpEvent) -> None: | ||
"""Appends received ODP event to current batch, flushing if batch is greater than batch size. | ||
Should only be called by the processing thread.""" | ||
if not self._current_batch: | ||
self._set_flush_deadline() | ||
|
||
self._current_batch.append(odp_event) | ||
if len(self._current_batch) >= self.batch_size: | ||
andrewleap-optimizely marked this conversation as resolved.
Show resolved
Hide resolved
|
||
self.logger.debug('ODP event queue: flushing on batch size.') | ||
self._flush_batch() | ||
|
||
def _set_flush_deadline(self) -> None: | ||
"""Sets time that next flush will occur.""" | ||
self._flush_deadline = time.time() + self.flush_interval | ||
|
||
def _get_time_till_flush(self) -> float: | ||
"""Returns seconds until next flush; no less than 0.""" | ||
return max(0, self._flush_deadline - time.time()) | ||
|
||
def _get_queue_timeout(self) -> Optional[float]: | ||
"""Returns seconds until next flush or None if current batch is empty.""" | ||
if len(self._current_batch) == 0: | ||
return None | ||
return self._get_time_till_flush() | ||
|
||
def stop(self) -> None: | ||
"""Flushes and then stops ODP event queue.""" | ||
try: | ||
self.event_queue.put_nowait(Signal.SHUTDOWN) | ||
except Full: | ||
self.logger.error('Error stopping ODP event queue.') | ||
return | ||
|
||
self.logger.warning('Stopping ODP event queue.') | ||
|
||
if self.is_running: | ||
self.thread.join() | ||
|
||
if len(self._current_batch) > 0: | ||
self.logger.error(Errors.ODP_EVENT_FAILED.format(self._current_batch)) | ||
|
||
if self.is_running: | ||
self.logger.error('Error stopping ODP event queue.') | ||
|
||
def send_event(self, type: str, action: str, identifiers: dict[str, str], data: OdpDataDict) -> None: | ||
"""Create OdpEvent and add it to the event queue.""" | ||
odp_state = self.odp_config.odp_state() | ||
if odp_state == OdpConfigState.UNDETERMINED: | ||
self.logger.debug('ODP event queue: cannot send before the datafile has loaded.') | ||
return | ||
|
||
if odp_state == OdpConfigState.NOT_INTEGRATED: | ||
self.logger.debug(Errors.ODP_NOT_INTEGRATED) | ||
return | ||
|
||
self.dispatch(OdpEvent(type, action, identifiers, data)) | ||
|
||
def dispatch(self, event: OdpEvent) -> None: | ||
"""Add OdpEvent to the event queue.""" | ||
if self.thread_exception: | ||
self.logger.error(Errors.ODP_EVENT_FAILED.format('Queue is down')) | ||
return | ||
|
||
if not self.is_running: | ||
self.logger.warning('ODP event queue is shutdown, not accepting events.') | ||
return | ||
|
||
try: | ||
self.logger.debug('ODP event queue: adding event.') | ||
self.event_queue.put_nowait(event) | ||
andrewleap-optimizely marked this conversation as resolved.
Show resolved
Hide resolved
|
||
except Full: | ||
self.logger.warning(Errors.ODP_EVENT_FAILED.format("Queue is full")) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.