Skip to content

Show Run#id in the web UI#941

Merged
adrianna-chang-shopify merged 1 commit intoShopify:mainfrom
shouichi:show-run-id
Jan 12, 2024
Merged

Show Run#id in the web UI#941
adrianna-chang-shopify merged 1 commit intoShopify:mainfrom
shouichi:show-run-id

Conversation

@shouichi
Copy link
Copy Markdown
Contributor

It makes correlating runs and errors from an error reporting system easier.

@nvasilevski
Copy link
Copy Markdown
Contributor

Hey, I believe a few assertions need to be tweaked

@Shopify/rails May I ask for opinions on this? I believe we are a little hesitant about exposing some internal concept of maintenance tasks on UI but I also want to recognize that internally we might have better debugging tooling (splunk links) that in most cases should remove the need to know the run id. But I can imagine that having more details about this particular run may help with debugging if all you have is access to the db and perhaps raw job worker logs

@etiennebarrie
Copy link
Copy Markdown
Member

I've wanted to add the id as a dom_id for a while. It does require to open up the developer tools to inspect the page, but since the gem is meant for developers, I think displaying the id directly wouldn't be a bad idea. It needs to be a bit clearer that it's an id, and it could be a bit nicer than just outputting it next to the date.

image

Maybe as a display: float on the right-hand side of the card (.box in Bulma)? and with a title attribute explaining it's an ID?

@shouichi
Copy link
Copy Markdown
Contributor Author

Thank you for the feedback. Do you mean displaying IDs on the right side?

image

It makes correlating runs and errors from an error reporting system easier.
Copy link
Copy Markdown
Member

@etiennebarrie etiennebarrie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Let's see if anyone else has feedback.

@adrianna-chang-shopify adrianna-chang-shopify merged commit 541db8f into Shopify:main Jan 12, 2024
@shouichi shouichi deleted the show-run-id branch January 12, 2024 14:08
@shopify-shipit shopify-shipit bot temporarily deployed to ruby-gems-backports February 9, 2024 21:37 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants