challfry / TheKraken

An iOS client for the Twit-arr server.
3 stars 1 forks source link

Implement X-Swiftarr-Client and X-Swiftarr-User Headers #82

Closed cohoe closed 7 months ago

cohoe commented 8 months ago

To enable us to debug troublesome clients and get more insights on what clients people use, I've established two HTTP headers in Swiftarr and Tricordarr:

X-Swiftarr-Client: An ID string of the client application. Could be just the name or also include a build number. For example, in the Android app I'm doing X-Swiftarr-Client: Tricordarr 2024.0

X-Swiftarr-User: If the request is authenticated, also include the users UUID string. Example: X-Swiftarr-User: abc123-4565-whatever

These headers will get picked up by the HTTP ingress router and allow us to generate metrics. No functionality is dependent on these headers. If Kraken could honor these too that'd be cool (but not required).

challfry commented 7 months ago

Done.