zuul
/
zuul
Code Issues Proposed changes

Annotate logs in the zuul driver with event ids 

The zuul driver also emits logs that should be annotated. Further it's
an event source and thus should generate uuid for the events it
creates.

Change-Id: I8c55a6baa792293b4fc9863557fefd59950f0333
This commit is contained in:
Tobias Henkel 2019-05-12 10:40:09 +02:00
parent 7ef11cf595
commit 9b757f4250
No known key found for this signature in database
GPG Key ID: 03750DEC158E5FA2
3 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
zuul/driver/zuul/__init__.py
View File

@ -13,11 +13,12 @@
# under the License. # under the License.
import logging import logging
from uuid import uuid4
from zuul.driver import Driver, TriggerInterface from zuul.driver import Driver, TriggerInterface
from zuul.driver.zuul.zuulmodel import ZuulTriggerEvent from zuul.driver.zuul.zuulmodel import ZuulTriggerEvent
from zuul.driver.zuul import zuultrigger from zuul.driver.zuul import zuultrigger
from zuul.lib.logutil import get_annotated_logger
PARENT_CHANGE_ENQUEUED = 'parent-change-enqueued' PARENT_CHANGE_ENQUEUED = 'parent-change-enqueued'
PROJECT_CHANGE_MERGED = 'project-change-merged' PROJECT_CHANGE_MERGED = 'project-change-merged'
@ -58,17 +59,19 @@ class ZuulDriver(Driver, TriggerInterface):
"Unable to create project-change-merged events for " "Unable to create project-change-merged events for "
"%s" % (change,)) "%s" % (change,))
def onChangeEnqueued(self, tenant, change, pipeline): def onChangeEnqueued(self, tenant, change, pipeline, event):
log = get_annotated_logger(self.log, event)
# Called each time a change is enqueued in a pipeline # Called each time a change is enqueued in a pipeline
tenant_events = self.parent_change_enqueued_events.get( tenant_events = self.parent_change_enqueued_events.get(
(tenant.name, pipeline.name)) (tenant.name, pipeline.name))
self.log.debug("onChangeEnqueued %s", tenant_events) log.debug("onChangeEnqueued %s", tenant_events)
if tenant_events: if tenant_events:
try: try:
self._createParentChangeEnqueuedEvents( self._createParentChangeEnqueuedEvents(
change, pipeline, tenant) change, pipeline, tenant, event)
except Exception: except Exception:
self.log.exception( log.exception(
"Unable to create parent-change-enqueued events for " "Unable to create parent-change-enqueued events for "
"%s in %s" % (change, pipeline)) "%s in %s" % (change, pipeline))
@ -89,12 +92,16 @@ class ZuulDriver(Driver, TriggerInterface):
event.change_url = change.url event.change_url = change.url
event.patch_number = change.patchset event.patch_number = change.patchset
event.ref = change.ref event.ref = change.ref
event.zuul_event_id = str(uuid4().hex)
self.sched.addEvent(event) self.sched.addEvent(event)
def _createParentChangeEnqueuedEvents(self, change, pipeline, tenant): def _createParentChangeEnqueuedEvents(self, change, pipeline, tenant,
self.log.debug("Checking for changes needing %s:" % change) event):
log = get_annotated_logger(self.log, event)
log.debug("Checking for changes needing %s:" % change)
if not hasattr(change, 'needed_by_changes'): if not hasattr(change, 'needed_by_changes'):
self.log.debug(" %s does not support dependencies" % type(change)) log.debug(" %s does not support dependencies" % type(change))
return return
# This is very inefficient, especially on systems with large # This is very inefficient, especially on systems with large
@ -102,10 +109,10 @@ class ZuulDriver(Driver, TriggerInterface):
# with persistent storage of dependency information. # with persistent storage of dependency information.
needed_by_changes = set(change.needed_by_changes) needed_by_changes = set(change.needed_by_changes)
for source in self.sched.connections.getSources(): for source in self.sched.connections.getSources():
self.log.debug(" Checking source: %s", source) log.debug(" Checking source: %s", source)
needed_by_changes.update( needed_by_changes.update(
source.getChangesDependingOn(change, None, tenant)) source.getChangesDependingOn(change, None, tenant))
self.log.debug(" Following changes: %s", needed_by_changes) log.debug(" Following changes: %s", needed_by_changes)
for needs in needed_by_changes: for needs in needed_by_changes:
self._createParentChangeEnqueuedEvent(needs, pipeline) self._createParentChangeEnqueuedEvent(needs, pipeline)
@ -122,6 +129,7 @@ class ZuulDriver(Driver, TriggerInterface):
event.change_url = change.url event.change_url = change.url
event.patch_number = change.patchset event.patch_number = change.patchset
event.ref = change.ref event.ref = change.ref
event.zuul_event_id = str(uuid4().hex)
self.sched.addEvent(event) self.sched.addEvent(event)
def getTrigger(self, connection_name, config=None): def getTrigger(self, connection_name, config=None):

3
zuul/manager/__init__.py
View File

@ -331,7 +331,8 @@ class PipelineManager(object):
ignore_requirements, change_queue) ignore_requirements, change_queue)
zuul_driver = self.sched.connections.drivers['zuul'] zuul_driver = self.sched.connections.drivers['zuul']
tenant = self.pipeline.tenant tenant = self.pipeline.tenant
zuul_driver.onChangeEnqueued(tenant, item.change, self.pipeline) zuul_driver.onChangeEnqueued(
tenant, item.change, self.pipeline, event)
return True return True
def dequeueItem(self, item): def dequeueItem(self, item):

2
zuul/trigger/__init__.py
View File

@ -36,5 +36,5 @@ class BaseTrigger(object, metaclass=abc.ABCMeta):
def onChangeMerged(self, change, source): def onChangeMerged(self, change, source):
"""Called when a change has been merged.""" """Called when a change has been merged."""
def onChangeEnqueued(self, change, pipeline): def onChangeEnqueued(self, change, pipeline, event):
"""Called when a change has been enqueued.""" """Called when a change has been enqueued."""