Skip to content
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

Log error if there are no event handlers registered #11280

Merged
merged 1 commit into from
Oct 14, 2021

Commits on Oct 11, 2021

  1. Log error if there are no event handlers registered

    We see this error all the time
    ```
    no handler registered for event
    event.Message=, event.Annotations=, event.Timestamp=0001-01-01T00:00:00Z, event.TaskName=, event.AllocID=, event.TaskID=,
    ```
    
    So we're handling an even with all default fields. I noted that this can
    happen if only err is set as in
    
    ```
    func (d *driverPluginClient) handleTaskEvents(reqCtx context.Context, ch chan *TaskEvent, stream proto.Driver_TaskEventsClient) {
    	defer close(ch)
    	for {
    		ev, err := stream.Recv()
    		if err != nil {
    			if err != io.EOF {
    				ch <- &TaskEvent{
    					Err: grpcutils.HandleReqCtxGrpcErr(err, reqCtx, d.doneCtx),
    				}
    			}
    ```
    
    In this case Err fails to be serialized by the logger, see this test
    
    ```
    
    	ev := &drivers.TaskEvent{
    		Err: fmt.Errorf("errz"),
    	}
    	i.logger.Warn("ben test", "event", ev)
    	i.logger.Warn("ben test2", "event err str", ev.Err.Error())
    	i.logger.Warn("ben test3", "event err", ev.Err)
    	ev.Err = nil
    	i.logger.Warn("ben test4", "nil error", ev.Err)
    
    2021-10-06T22:37:56.736Z INFO nomad.stdout {"@Level":"warn","@message":"ben test","@module":"client.driver_mgr","@timestamp":"2021-10-06T22:37:56.643900Z","driver":"mock_driver","event":{"TaskID":"","TaskName":"","AllocID":"","Timestamp":"0001-01-01T00:00:00Z","Message":"","Annotations":null,"Err":{}}}
    2021-10-06T22:37:56.736Z INFO nomad.stdout {"@Level":"warn","@message":"ben test2","@module":"client.driver_mgr","@timestamp":"2021-10-06T22:37:56.644226Z","driver":"mock_driver","event err str":"errz"}
    2021-10-06T22:37:56.736Z INFO nomad.stdout {"@Level":"warn","@message":"ben test3","@module":"client.driver_mgr","@timestamp":"2021-10-06T22:37:56.644240Z","driver":"mock_driver","event err":"errz"}
    2021-10-06T22:37:56.736Z INFO nomad.stdout {"@Level":"warn","@message":"ben test4","@module":"client.driver_mgr","@timestamp":"2021-10-06T22:37:56.644252Z","driver":"mock_driver","nil error":null}
    ```
    
    Note in the first example err is set to an empty object and the error is
    lost.
    
    What we want is the last two examples which call out the err field
    explicitly so we can see what it is in this case
    Ben Buzbee committed Oct 11, 2021
    Configuration menu
    Copy the full SHA
    337c5d7 View commit details
    Browse the repository at this point in the history