Conform sqlalchemy to prom spec

[nkall]

💸 TL;DR

The SqlAlchemy library is old and emits events not compliant with the prometheus metrics spec. Specifically, sql_client_name is missing and instead this library provides sql_pool which appeared in an older version of the spec. This updates the metrics to be compliant with spec and usable by the baseplate service health dashboard.

📜 Details

Example SQL metrics emitted by a client of this library:

$ curl -s localhost:6060/metrics | grep sql
# HELP sql_client_latency_seconds Latency histogram of calls to database
# TYPE sql_client_latency_seconds histogram
sql_client_latency_seconds_sum{sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 0.004516069000601419
sql_client_latency_seconds_bucket{le="0.0001",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 0.0
sql_client_latency_seconds_bucket{le="0.0005",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 0.0
sql_client_latency_seconds_bucket{le="0.001",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 2.0
sql_client_latency_seconds_bucket{le="0.0025",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.005",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.01",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.025",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.05",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.1",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.25",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="0.5",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="1.0",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="5.0",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="15.0",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="30.0",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_bucket{le="+Inf",sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
sql_client_latency_seconds_count{sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
# HELP sql_client_requests_total Total number of sql requests
# TYPE sql_client_requests_total counter
sql_client_requests_total{sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy",sql_success="true"} 4.0
# HELP sql_client_active_requests total requests that are in-flight
# TYPE sql_client_active_requests gauge
sql_client_active_requests{sql_address="postgresql",sql_database="reputation",sql_pool="sqlalchemy"} 0.0

🧪 Testing Steps / Validation

I will require this branch in karma service and verify in my local snoodev.

✅ Checks

• CI tests (if present) are passing
• Adheres to code style for repo
• Contributor License Agreement (CLA) completed if not a Reddit employee

[KTAtkinson]

It looks like there are a few more tests that need to be updated.

[KTAtkinson]

This is a breaking change!

[nkall]

Ty so much!