feat(gcf-utils): add trigger info as bindings to all log statements

[azizsonawalla]

• Adds support for initializing GCFLogger with bindings
• Adds support for child loggers (with bindings) to GCFLogger
• Uses above mentioned child logger functionality to bind trigger information to all log statements for an execution

Resulting log statements will look something like this:

(in gcf-utils.ts)

const triggerInfo  = {
    trigger: {
        trigger_type: 'GITHUB_WEBHOOK',
        trigger_sender: 'some sender',
        payload_hash: '123456',
        trigger_source_repo: {
            owner: 'foo owner',
            owner_type: 'Org',
            repo_name: 'bar name',
            url: 'some url',
        },
    },
};

...

bindTriggerInfoToLogger(triggerInfo);

(in some-bot.ts)

// after gcf-utils has done all the trigger parsing and logged the trigger information the first time

logger.info({ some-property: 'some-value' });

(Cloud Logs Viewer)

{
    insertId: "xyz",
    jsonPayload: {
        some-property: "some-value",                // what the bot logged
        trigger: {                                   // what was automatically attached to logs
            trigger_type: 'GITHUB_WEBHOOK',
            trigger_sender: 'some sender',
            payload_hash: '123456',
            trigger_source_repo: {
                owner: 'foo owner',
                owner_type: 'Org',
                repo_name: 'bar name',
                url: 'some url',
            },
        },
    },
    resource: {
        type: "cloud-function",
        labels: {
            function_name: "some-bot",
            project_id: "repo-automation-bots",
            region: "us-central1"
        },
    },
    timestamp: "12345",
    severity: "INFO",
    labels: {
        execution_id: "abcd"
    }
}

Fixes #777

[bcoe]

This looks good to me, could you give me an example in the issue body of what the log message ends up looking like?

[chingor13]

Could we make buildTriggerInfo not include message, set the logger to the child logger, then do logger.metric("message originally in buildTriggerInfo")?

[azizsonawalla]

You mean like this?

const triggerInfo = buildTriggerInfo(triggerType, id, request.body);
GCFBootstrapper.bindPropertiesToLogger(triggerInfo); // no message in triggerInfo

logger.metric({ 
  message: `Execution started by ${triggerType}`, 
  ...triggerInfo
});

This works too!

[chingor13]

Since the trigger info should already be added to all the log entries, you should only have to call

logger.metric(`Execution started by ${triggerType}`);

[azizsonawalla]

ahh ok ok - makes sense

[azizsonawalla]

done!

[gcf-merge-on-green]

Your PR has attempted to merge for 3 hours. Please check that all required checks have passed, you have an automerge label, and that all your reviewers have approved the PR

addressed