P0: SDK Telemetry Headers Not Being Sent

[karlwaldman]

Problem

SDK telemetry headers are not being included in API requests, making it impossible to track SDK adoption vs manual API usage.

Evidence

Analysis of 2,807 Node.js SDK requests in the last 24 hours:

• X-SDK-Language header: 0/2,807 requests (0%)
• X-SDK-Version header: 0/2,807 requests (0%)
• X-Client-Type header: 52/2,807 requests (1.8%)

All requests show generic user agent: node

Impact

• Cannot distinguish SDK users from manual API calls
• Cannot track which SDK versions are being used
• Cannot measure SDK adoption accurately
• Missing critical telemetry for product analytics

Expected Behavior

Every SDK request should include:

X-SDK-Language: javascript
X-SDK-Version: 0.3.1
X-Client-Type: sdk

Investigation Required

1. Check if headers are defined in SDK client code
2. Verify headers are actually added to HTTP requests
3. Test locally to confirm headers are sent
4. Verify API receives and stores these headers

Priority

P0 - Critical for tracking SDK usage and measuring adoption

[karlwaldman]

✅ Fixed in v0.3.2

Changes:

• Added X-SDK-Language: javascript header
• Added X-SDK-Version: 0.3.2 header
• Added X-Client-Type: sdk header

Files modified:

• src/client.ts:165-172

Published:

• npm: https://www.npmjs.com/package/oilpriceapi/v/0.3.2
• Release: Published Nov 29, 2025

Testing:

npm install oilpriceapi@latest

All SDK requests will now include proper telemetry headers for tracking.

Next Steps:

• Monitor API requests over next 24 hours to verify headers are being received
• Track SDK adoption metrics via telemetry data