execution_id missing in PubSub cloud function

[techieshark]

Is there something this library, or the users of it, could do to get a pubsub event id to be included in the one-line summary seen in Stackdriver? As described below, I've tried to set it manually as a label, but that seems to not impact the summary line.

Environment details

• OS: cloud-functions
• Node.js version: 10
• @google-cloud/logging-winston version: 3.0.5

Steps to reproduce

1. Create pubsub cloud function which takes a context as second parameter.
2. Log with winston to stackdriver transport (as per the docs), and try manually setting labels["execution_id"] to the event id:

 logger.debug('Starting processing pubsub message', {
    labels: {
      // Observe console.log entries to see that an event ID is the execution_id.
      // We manually populate it so we can see the group of all logs for a
      // single execution/event.
      execution_id: context.eventId,
    }
}

Expected: the one line (non-expanded) summary includes the execution id / event id. This is the case with console.log.

Actual: non is present. See screenshot.

[dfdgsdfg]

googleapis/nodejs-logging#591

firebase/firebase-functions#560

[techieshark]

Solution might be using firebase-functions logger instead (for cloud functions):

firebase/firebase-functions#560 (comment)

https://github.com/firebase/firebase-functions/releases/tag/v3.7.0

Adds functions.logger SDK to enable structured logging in the Node.js 10 runtime. For example:

const functions = require('firebase-functions');

functions.logger.debug('example log with structured data', {
uid: user.uid,
authorized: true,
});

Internally this just is like

console.log(`your-message-line and then ${JSON.stringify(structuredInfo)}`);

which is supposed to work on Node >= 10

I'll try this soon.

[0xSage]

Hi @techieshark , a few notes that may help:

1. Getting exec_id to show up as a Summary Field (the UI bubbles): You can manually configure summary fields yourself steps here.

2. Getting execution_id by default: this is blocked by this upstream issue. Will follow up on it for you. After that’s in, we can work on getting everyone trace/exec ids by default, minimally for pubsub/scheduler triggered cloud functions. tracked here.

3. Event_id is a different value than execution_id. You might run into issues by using it interchangeably as a single event_id can yield multiple execution_ids. This happens for example when your event retries the execution due to some issue.

Closing the issue here since the fix is in different repos and already tracked and tagged to this issue instance.

[techieshark]

Thanks for the tips, @nicoleczhu! Looking forward to seeing those upstream issues resolved - would be quite helpful for our logging ux.