Azure / Azure/review-checklists

Capture more detailed usage metrics

Open
#223 1 comment 0 reactions 1 assignee Claimed by @sdolgin View on GitHub
enhancement
Dominant language
Python
Stars
1.3k
Forks
378
PR merge metrics
No merged PRs in 30d

Description

To better understand how often the review checklists are being used, we should track the download of JSON files in detail. These metrics can be used to detect trends in usage, which is valuable feedback.

We'd like to know:
- How many times did each JSON file get imported into the worksheet per month?
- Are there any increases month over month in requests for landing zone, security, avd, etc?
- Are there any anomalies in JSON file requests or increases in static XLSX file requests that indicate a problem with the macros?

A few ways we might do this...

1. Update the GH actions workflow to publish new release versions of the JSON files with every merge to main. The release tracking / insights in GH would provide tracking. This is not ideal because it would require a new release to be published (automating multiple steps) with EVERY merge to main.

2. On merge, publish the JSON files to blob storage with metrics logged. We could then build monitoring workbooks on the data.

3. Build custom telemetry calls into the VBA code to call a logging API when a JSON file is being imported.

My instinct is that option 2 is the right path forward. In all 3 cases, the macros would need to be updated in some way to account for tracking the download of JSON files.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.