Add http.route tags for API Gateway (#524)

nhulston · web-flow · commit 2b85536bbc24 · 2024-10-29T14:12:38.000-04:00
Add route tags
diff --git a/datadog_lambda/trigger.py b/datadog_lambda/trigger.py
@@ -299,6 +299,12 @@ def extract_http_tags(event):
     if headers and headers.get("Referer"):
         http_tags["http.referer"] = headers.get("Referer")
 
+    # Try to get `routeKey` from API GW v2; otherwise try to get `resource` from API GW v1
+    route = event.get("routeKey") or event.get("resource")
+    if route:
+        # "GET /my/endpoint" = > "/my/endpoint"
+        http_tags["http.route"] = route.split(" ")[-1]
+
     return http_tags
 
 
diff --git a/tests/integration/snapshots/logs/async-metrics_python310.log b/tests/integration/snapshots/logs/async-metrics_python310.log
@@ -106,6 +106,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -605,6 +606,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/async-metrics_python311.log b/tests/integration/snapshots/logs/async-metrics_python311.log
@@ -106,6 +106,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -605,6 +606,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/async-metrics_python312.log b/tests/integration/snapshots/logs/async-metrics_python312.log
@@ -106,6 +106,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -605,6 +606,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/async-metrics_python38.log b/tests/integration/snapshots/logs/async-metrics_python38.log
@@ -106,6 +106,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -605,6 +606,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/async-metrics_python39.log b/tests/integration/snapshots/logs/async-metrics_python39.log
@@ -106,6 +106,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -605,6 +606,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/sync-metrics_python310.log b/tests/integration/snapshots/logs/sync-metrics_python310.log
@@ -86,6 +86,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -642,6 +643,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/sync-metrics_python311.log b/tests/integration/snapshots/logs/sync-metrics_python311.log
@@ -86,6 +86,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -642,6 +643,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/sync-metrics_python312.log b/tests/integration/snapshots/logs/sync-metrics_python312.log
@@ -86,6 +86,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -642,6 +643,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/sync-metrics_python38.log b/tests/integration/snapshots/logs/sync-metrics_python38.log
@@ -86,6 +86,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -642,6 +643,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/integration/snapshots/logs/sync-metrics_python39.log b/tests/integration/snapshots/logs/sync-metrics_python39.log
@@ -86,6 +86,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.us-east-2.amazonaws.com",
           "http.url_details.path": "/Prod/",
           "http.method": "GET",
+          "http.route": "/",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
@@ -642,6 +643,7 @@ HTTP GET https://www.datadoghq.com/ Headers: ["Accept-Encoding:gzip, deflate","A
           "http.url": "XXXX.execute-api.eu-west-1.amazonaws.com",
           "http.url_details.path": "/httpapi/get",
           "http.method": "GET",
+          "http.route": "/httpapi/get",
           "http.status_code": "200",
           "_dd.base_service": "integration-tests-python"
         },
diff --git a/tests/test_trigger.py b/tests/test_trigger.py
@@ -258,6 +258,7 @@ def test_extract_trigger_tags_api_gateway(self):
                 "http.url": "70ixmpl4fl.execute-api.us-east-2.amazonaws.com",
                 "http.url_details.path": "/prod/path/to/resource",
                 "http.method": "POST",
+                "http.route": "/{proxy+}",
             },
         )
 
@@ -276,6 +277,7 @@ def test_extract_trigger_tags_api_gateway_non_proxy(self):
                 "http.url": "lgxbo6a518.execute-api.eu-west-1.amazonaws.com",
                 "http.url_details.path": "/dev/http/get",
                 "http.method": "GET",
+                "http.route": "/http/get",
             },
         )
 
@@ -342,6 +344,7 @@ def test_extract_trigger_tags_api_gateway_http_api(self):
                 "http.url": "x02yirxc7a.execute-api.eu-west-1.amazonaws.com",
                 "http.url_details.path": "/httpapi/get",
                 "http.method": "GET",
+                "http.route": "/httpapi/get",
             },
         )
 

Original file line number	Diff line number	Diff line change
`@@ -258,6 +258,7 @@ def test_extract_trigger_tags_api_gateway(self):`
`258`	`258`	`"http.url": "70ixmpl4fl.execute-api.us-east-2.amazonaws.com",`
`259`	`259`	`"http.url_details.path": "/prod/path/to/resource",`
`260`	`260`	`"http.method": "POST",`
	`261`	`+ "http.route": "/{proxy+}",`
`261`	`262`	`},`
`262`	`263`	`)`
`263`	`264`
`@@ -276,6 +277,7 @@ def test_extract_trigger_tags_api_gateway_non_proxy(self):`
`276`	`277`	`"http.url": "lgxbo6a518.execute-api.eu-west-1.amazonaws.com",`
`277`	`278`	`"http.url_details.path": "/dev/http/get",`
`278`	`279`	`"http.method": "GET",`
	`280`	`+ "http.route": "/http/get",`
`279`	`281`	`},`
`280`	`282`	`)`
`281`	`283`
`@@ -342,6 +344,7 @@ def test_extract_trigger_tags_api_gateway_http_api(self):`
`342`	`344`	`"http.url": "x02yirxc7a.execute-api.eu-west-1.amazonaws.com",`
`343`	`345`	`"http.url_details.path": "/httpapi/get",`
`344`	`346`	`"http.method": "GET",`
	`347`	`+ "http.route": "/httpapi/get",`
`345`	`348`	`},`
`346`	`349`	`)`
`347`	`350`