1314878 - [meta] Add a unique GUID to each command sent via the clients collection.

Status: RESOLVED FIXED

(Firefox :: Sync, defect, P3)

Description

[Mark Hammond [:markh] [:mhammond]]

Over in bug 1289536, Alex, Katie and Georg agreed we should use a unique "flow ID" in order to track some telemetry around "commands" sent and received by Sync devices. The initial focus is the displayURI command, although it probably makes sense to use it for all commands.

The idea is that the sending device will generate a GUID and include this GUID in some "event" telemetry. The receiving device will also record event telemetry for the event reception and include that GUID, with the end result being that we can get accurate reporting on how successful these commands are.

Obviously this will require changes to all our sync implementations, so this is a meta bug to track the other platform-specific bugs.

Comment 1

[Richard Newman [:rnewman]]

I left a note in the desktop-specific bug, but repeating here for clarity:

--

Questions:

- What else will you need to send with every command in order to make this useful? The sender ID? The client-side timestamp at which the command was created? The server-side timestamp of the client record into which this command was inserted? I'd rather not churn this four times if we can do it once.
- Do you need this flowID (and the rest) for every command, or only for displayURI? Does it hurt to include it on every command?
- Generalize? Should this be `commandMeta` instead of a plain field?

Please also file a bug to update the object format docs.

Comment 2

[Mark Hammond [:markh] [:mhammond]]

PR for object format docs update: https://github.com/mozilla-services/docs/pull/70 - there's nothing else to do here.