Merge pull request #44 from ONS-Innovation/lambda_endpoint_updates

KEH-718 | Lambda endpoint updates

Author: TotalDwarf03

.gitignore

@@ -19,6 +19,8 @@ site/
 # Local .terraform directories
 **/.terraform/*
 
+.terraform.lock.hcl
+
 # .tfstate files
 *.tfstate
 *.tfstate.*

README.md

@@ -2,6 +2,21 @@
 
 A Streamlit dashboard to display information from the Github Copilot Usage API endpoints.
 
+---
+
+## Important Notice
+
+This repository is currently using depreciated endpoints to collect CoPilot Usage information and will not be able to show information past the 1st of February 2025.
+
+We are working on refactoring the dashboard and its lambda to make use of the new endpoints and its data structure.
+
+| Documentation | Link |
+| ------------- | ---- |
+| Old Endpoint  | https://docs.github.com/en/rest/copilot/copilot-usage?apiVersion=2022-11-28 |
+| New Endpoint  | https://docs.github.com/en/rest/copilot/copilot-metrics?apiVersion=2022-11-28 |
+
+---
+
 ## Disclaimer
 
 ### Early Stage & Accessibility Disclaimer

lambda_data_logger/main.py

@@ -62,7 +62,7 @@ def get_copilot_team_date(gh: github_api_toolkit.github_interface, page: int) ->
     response = gh.get(f"/orgs/{org}/teams", params={"per_page": 100, "page": page})
     teams = response.json()
     for team in teams:
-        usage_data = gh.get(f"/orgs/{org}/team/{team['name']}/copilot/usage")
+        usage_data = gh.get(f"/orgs/{org}/team/{team['name']}/copilot/metrics")
         try:
             if usage_data.json():
                 copilot_teams.append(team["name"])
@@ -107,7 +107,7 @@ def handler(event, context):
     # CoPilot Usage Data (Historic)
 
     # Get the usage data
-    usage_data = gh.get(f"/orgs/{org}/copilot/usage")
+    usage_data = gh.get(f"/orgs/{org}/copilot/metrics")
     usage_data = usage_data.json()
 
     logger.info("Usage data retrieved")
@@ -124,11 +124,11 @@ def handler(event, context):
     dates_added = []
 
     # Append the new usage data to the historic_usage_data.json
-    for day in usage_data:
-        if not any(d["day"] == day["day"] for d in historic_usage):
-            historic_usage.append(day)
+    for date in usage_data:
+        if not any(d["date"] == date["date"] for d in historic_usage):
+            historic_usage.append(date)
 
-            dates_added.append(day["day"])
+            dates_added.append(date["date"])
 
     logger.info(
         f"New usage data added to {object_name}",

src/pages/org_usage.py

@@ -24,7 +24,7 @@
 
 # AWS Bucket Path
 bucket_name = f"{account}-copilot-usage-dashboard"
-object_name = "historic_usage_data.json"
+object_name = "historic_usage_data_pre_feb_25.json"
 
 
 @st.cache_data
@@ -54,6 +54,10 @@ def get_pem_from_secret_manager(_session: boto3.Session, secret_name: str, regio
 
 col2.image("./src/branding/ONS_Logo_Digital_Colour_Landscape_Bilingual_RGB.png")
 
+st.header("Important Notice")
+st.write("Due to an update to GitHub's APIs, this dashboard is currently only able to show data up to the **1st of February 2025**.")
+st.write("We are working on refactoring the dashboard to use the new API endpoints.")
+
 live_tab, historic_tab = st.tabs(["Live Data", "Historic Data"])
 
 with live_tab:

src/pages/team_usage.py

@@ -325,6 +325,10 @@ def initialize_states():
 
 col2.image("./src/branding/ONS_Logo_Digital_Colour_Landscape_Bilingual_RGB.png")
 
+st.header("Important Notice")
+st.write("Due to an update to GitHub's APIs, this dashboard is currently only able to show data up to the **1st of February 2025**.")
+st.write("We are working on refactoring the dashboard to use the new API endpoints.")
+
 initialize_states()
 
 # Step 1: GitHub Login