SDK-3949: Introduce sending client information with requests #164
Conversation
Codecov ReportBase: 94.95% // Head: 94.75% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #164 +/- ##
==========================================
- Coverage 94.95% 94.75% -0.20%
==========================================
Files 38 38
Lines 6538 6578 +40
==========================================
+ Hits 6208 6233 +25
- Misses 266 276 +10
- Partials 64 69 +5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
internal/client/client.go
Outdated
| "github.com/auth0/go-auth0" | ||
| ) | ||
|
|
||
| // UserAgent is the default user agent string. | ||
| var UserAgent = fmt.Sprintf("Go-Auth0-SDK/%s", auth0.Version) | ||
|
|
||
| // Telemetry is the structure used to send telemetry data in the "Auth0-Client" header. | ||
| type Telemetry struct { |
There was a problem hiding this comment.
While some of our older SDKs still call this Telemetry, more recently we've started to call it UserAgent instead, as "telemetry" can often have negative connotations and raise eyebrows.
For example: auth0/Auth0.Android#398
Please consider renaming the feature.
There was a problem hiding this comment.
There was a problem hiding this comment.
I think that's a fair point, unfortunately this package already exposes a configurable user agent so I'm not sure I can rename it to that, in SPA-JS it's called Auth0Client, what do you think about that?
There was a problem hiding this comment.
Is that user agent string public? If not, you can change that as well. Otherwise, the SPA SDK solution is fine 👍🏼
There was a problem hiding this comment.
Pushed c336a83 to change this, I ending up using Auth0ClientInfo to try and convey that this is information about the client rather than a client that can be used to call API methods (if that makes sense)
ewanharris
force-pushed
the
feat/SDK-3949-telemetry
branch
from
4165923
to
c336a83
Compare
|
CI is failing currently because of changes in golangci-lint as we always pull the latest. Will investigate that on Monday but solutions are either pin to a specific golangci-lint version or update to use go 1.19 (at a minimum) |
…ent` header
By default the telemetry data sent is for the go-auth0 package however, it can be overridden by
passing a custom Telemetry to the `WithTelemetry` function on `API.New`. The structure is as follows:
- name: A string that is name of the "thing" the telemetry data is for
- version: A string that is version of the "thing" the telemetry data is for
- env: A object of strings that is a grab-bag for any other data that the consumer of go-auth0 wishes to send, like OS version for example
By calling `WithNoTelemetry` the `Auth0-Client` header is not sent at all
ewanharris
force-pushed
the
feat/SDK-3949-telemetry
branch
from
c336a83
to
6256c6d
Compare
ewanharris
changed the title
🔧 Changes
Introduces telemetry to the package which is being sent in the (new)
Auth0-Clientheader.By default the telemetry data sent is for the go-auth0 package however, it can be overridden by passing a custom Telemetry to the
WithTelemetryfunction onAPI.New. The structure is as follows:By calling
WithNoTelemetrytheAuth0-Clientheader is not sent at all📚 References
🔬 Testing
I'm working on figuring out how to test this to make sure the data shows up as expected (rather than works in theory)
📝 Checklist