Add Facility Name, Testing Lab Name, and Testing Lab CLIA to Azure Logging observability

chris-kuryak commented 3 days ago

User Story

As a ReportStream Engineer, I want to be able to query for more information (Facility Name, Testing Lab Name, Testing Lab CLIA) at the item level in Azure logs, so that I can troubleshoot issues easier.

Description/Use Case

Sometimes we receive reports that include multiple testing facilities (such as Carbon Health) and having the information of Facility Name, Testing Lab Name, and Testing Lab CLIA will allow us to identify specific messages easier and troubleshoot issues faster.

Risks/Impacts/Considerations

Dev Notes

Currently, we track items at the Report level and Item level. The added observability with these fields we would like to be added at the item level

Acceptance Criteria

[ ] A query in Azure Logs for any Item events includes the Facility Name, Testing Lab Name, and Testing Lab CLIA and those fields that can also be used in the query to target specific items.
[ ] Azure Event documentation in LucidChart is updated accordingly: https://lucidgov.app/lucidchart/89edc4c3-695b-4324-be8e-6556dd9fec95/edit?invitationId=inv_a44a9145-fc99-49ca-9053-a873937c7b23
[ ] An example query for "List of items from Facility Name 'X'" is added to the bottom of the Azure Events document in Github: https://github.com/CDCgov/prime-reportstream/blob/master/prime-router/docs/observability/azure-events.md

chris-kuryak commented 3 days ago

@MichaelEsuruoso @brandonnava @arnejduranovic

Made this ticket for adding some additional fields to be tracked in Azure Logging.

Does this meet y'alls needs for enough information? Does it have the right labels, column, etc? Let me know if there is anything missing or if there is a better avenue for these requests so I can make sure I get it right next time.

MichaelEsuruoso commented 1 day ago

information looks. for the AC just to make sure I understand, do you want us to add a search query for the items listed?

chris-kuryak commented 1 day ago

@MichaelEsuruoso Good question and feedback.

I have added specific ACs around documentation regarding this update. Let me know if that provides enough guidance.

MichaelEsuruoso commented 1 day ago

this look good thank you @chris-kuryak not sure if @arnejduranovic or @brandonnava have anything to add. Also what is the priority for this?

CDCgov / prime-reportstream