1472214 - Link to herald transcript in emails triggered by herald

Status: NEW

(Conduit :: Phabricator, enhancement, P5)

Description

[Tom Ritter [:tjr]]

I set up a couple of Heralds in Phabricator, which I think is a fantastic feature that I want to introduce everyone to. But very quickly I found that they were unusable for a number of reasons.

One is that the email has no indication hat it is a Herald email. Another is that it doesn't explain _what_ Herald is triggering. If I have multiple heralds set up, I might get a trigger for any one of them but not know which one I should be investigating.

Comment 1

[Tom Prince [:tomprince]]

If this is for debugging why you are getting notification, https://phabricator.services.mozilla.com/herald/test/ or https://phabricator.services.mozilla.com/herald/transcript/ (click Edit Query and add the phab commit identifier) will show you what herald rules are run for a particular commit.

That doesn't help if you have multiple herald rules that you want to look at different things in response to, that aren't immediately obvious from looking at the commit in question.

Investigating further, it looks like herald also allow you to set flags in response, which are private, so you could have each rule set a different flag, which you could then see when you look at the commit. I'm not sure if that would show up in the commit email. This definitely feels like a bit of a workaround, but is perhaps a reasonable stop gap until something better is implemented.

Comment 2

[Steven MacLeod [:smacleod]]

There will be a message in the Phabricator "Mail" application[1] for every email it sends you. If you visit the "Delivery" tab for a message, it should indicate if any herald rules caused it to be sent. If you see it was caused by herald you can go to the herald transcripts[2] and search for the related "Object Monogram" (This would be D<#> for a revision, something like rLANDOAPId8bbe4ec8d9c for a commit). There will be an entry for each time the object had an event that could send email, viewing the transcript will show you all the herald details.

All that being said, probably would be nice if the email itself had a link to the transcript if it was triggered by herald.

[1] https://phabricator.services.mozilla.com/mail/
[2] https://phabricator.services.mozilla.com/herald/transcript/query/advanced/

Comment 3

[Steven MacLeod [:smacleod]]

Little update that might help, Phabricator sends a 'X-Herald-Rules' header on the mails it sends, (e.g. "X-Herald-Rules: <28>, <29>, <34>, none, <31>"). You can also turn on "Stamps" which will add things like "actor(@imadueme) application(Differential) author(@imadueme) blocking-reviewer(@mars) herald(H28) herald(H29) herald(H31) herald(H34) monogram(D2097) object-type(DREV) phid(PHID-DREV-67zbvvo3eqybl7yscpxl) reviewer(@mars) reviewer(@smacleod) revision-repository(rLANDOUI) revision-status(needs-review) subscriber(@mars) via(web)" to the body of the emails phabricator sends (duplicating a bunch of the custom phabricator headers, useful for gmail filtering).

You could use this to find out what is triggering. Still might be value in at least linkifying things though.