The incident highlight bar originally contained severity, link to the alert, start time for the alert, and SLA details. However, severity no longer appears, since it's been moved to the sidebar, and incidents not associated with alerts don't have the link to the alert or the start time appearing. In short, we're not making the most of this highlight bar currently. How can we better use that screen real estate to surface important information that's not being surfaced elsewhere?
Proposal
Rather than use the incident highlight bar to surface alert details, we will re-purpose it to display key timestamps within incidents. For a first pass, we'll start with surfacing incident start and end time. Duration will be added in #360005 (closed).
Initial state
Pre-filled timeline form
Populated highlight bar
Designs are visible as part of the Incident Timestamps Figma file
Implementation guide
Add query args to search timeline events by tag name (app/graphql/resolvers/incident_management/timeline_events_resolver.rb) (backend)
Query timeline events by tag name to populate highlight box with existing start/end time values (frontend)
This page may contain information related to upcoming products, features and functionality.
It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes.
Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.
🤖 GitLab Bot 🤖changed the descriptionCompare with previous version
changed the description
Amelia Bauerlychanged title from Clean up presentation of items in incident highlight and sidebar to Clean up presentation of items in incident highlight bar and sidebar
changed title from Clean up presentation of items in incident highlight and sidebar to Clean up presentation of items in incident highlight bar and sidebar
cc: @kbychu - in reviewing incidents recently, it seems like both the incident sidebar and "highlight bar" could be adjusted a bit to ensure we're prioritizing and displaying the most relevant information in incidents. Perhaps this is something that could potentially be included in one of the "incident improvement" themes?
Hmm, good q, @kbychu I'm thinking of re-utilizing the highlight bar for the Capturing incident timestamps issue, essentially displaying the timestamps that are captured within the highlight bar, instead of the content that's normally presented there. So, it might mean that the best time to implement these clean-ups would be hand-in-hand with implementing Incident Tag MVC (#336026 - closed), so that we're not adjusting what's presented in the highlight bar twice. So, maybe it should live within Ensure incident response teams can track timest... (gitlab-design#1911 - closed) theme instead? We can also decide later, when we have a firmer plan in place for incident timestamps. That also works
Amelia Bauerlychanged title from Clean up presentation of items in incident highlight bar and sidebar to Design: Clean up presentation of items in incident highlight bar and sidebar
changed title from Clean up presentation of items in incident highlight bar and sidebar to Design: Clean up presentation of items in incident highlight bar and sidebar
Amelia Bauerlychanged title from Design: Clean up presentation of items in incident highlight bar and sidebar to Design: Clean up presentation of items in incident highlight bar
changed title from Design: Clean up presentation of items in incident highlight bar and sidebar to Design: Clean up presentation of items in incident highlight bar
Amelia Bauerlychanged the descriptionCompare with previous version
Amelia Bauerlychanged the descriptionCompare with previous version
changed the description
Amelia Bauerlychanged the descriptionCompare with previous version
changed the description
Amelia Bauerlychanged title from Design: Clean up presentation of items in incident highlight bar to Clean up presentation of items in incident highlight bar
changed title from Design: Clean up presentation of items in incident highlight bar to Clean up presentation of items in incident highlight bar
@abellucci - interesting, I didn't realize this had been scheduled, and I don't actually think we can do this work until we implement incident tags.
In looking through the system notes, I think this was scheduled by Kevin back when we had anticipated working on incident tags next. I know we haven't gotten around to that work yet yet, though, and this issue is technically blocked by it. You can see this in the designs - the links for Add start/end time open up the pre-filled timeline form, with the appropriate incident tag selected (start time, in this example, shown in the event type field). But, we haven't added that field yet, or any of the incident tags. So, I guess this issue should be in the backlog, along with all of the incident tag issues? Also that this issue should get added to the incident tag epic?
@ameliabauerly - thanks for calling this out, I thought this work might be dependent on incident tags. I've added this issue to the Incident Tags MVC epic, hopefully we can do this work as soon as %15.6!
I'm working on the backend task for this: add a 'Tag Name' search to the incident timeline graphql api. But I'm happy to pass that over to anyone with more backend knowledge if they wish to pick this issue up
Async update: Initial backend MR is in place: !109293 (closed). Next step: learning about query plans and adding one to the MR so I can progress this to review.
@tristan.read I'm wondering about this one, is it on hold until removals are completed (since they're higher prio), or do you have capacity to make progress on it during 16.0 as well?
I'll add to %16.0 for now, please feel free to change it if that's unrealistic.
@kbychu wdyt of this issue? Given it's an enhancement for Category:Incident Management maybe it should go to the backlog for now? Alternatively, and for efficiency, we just finish it off since most of the backend work seems ready for review, cc @tristan.read.
Thanks for the ping @francoisrose. This had fallen off my radar, I since got some review feedback to add some more specs so I'll bump this back to the top of my list