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 166 Python SDK requests in the last 24 hours:

• X-SDK-Language header: 0/166 requests (0%)
• X-SDK-Version header: 0/166 requests (0%)
• X-Client-Type header: 164/166 requests (98.8%)

All requests show generic user agents: python-requests/2.32.5, python-httpx/0.25.0

Real Users Affected

11 real users in last 24 hours including:

• jjpartridge68@outlook.com (77 requests)
• hashir.hameed@interloop.com.pk (16 requests)
• support@datbi.eu (8 requests, paying Hobby tier customer)

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: python
X-SDK-Version: 1.0.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

Related

• Node.js SDK issue: P0: SDK Telemetry Headers Not Being Sent oilpriceapi-node#9

[karlwaldman]

✅ Fixed in v1.0.2

Changes:

• Added X-SDK-Language: python header
• Added X-SDK-Version: 1.0.2 header
• Added X-Client-Type: sdk header

Files modified:

• oilpriceapi/client.py:106-116 (sync client)
• oilpriceapi/async_client.py:87-97 (async client)

Build Status:
✅ Successfully built:

• oilpriceapi-1.0.2.tar.gz
• oilpriceapi-1.0.2-py3-none-any.whl

Published:

• PyPI: Pending publication (awaiting token)

Testing (once published):

pip install --upgrade oilpriceapi

All SDK requests (both sync and async) will now include proper telemetry headers for tracking.

Next Steps:

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

[karlwaldman]

🎉 Published to PyPI!

Live on PyPI: https://pypi.org/project/oilpriceapi/1.0.2/

Install now:

pip install --upgrade oilpriceapi

Verify:

import oilpriceapi
print(oilpriceapi.__version__)  # Should print: 1.0.2

All requests (sync and async) now include proper SDK telemetry headers. 🚀