Skip to content

Commit

Permalink
Clarify the usage of dsn.RequestHeaders()
Browse files Browse the repository at this point in the history
  • Loading branch information
cleptric committed Sep 26, 2023
1 parent 68e2c0f commit 1f8ded0
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions dsn.go
Expand Up @@ -196,11 +196,15 @@ func (dsn Dsn) GetAPIURL() *url.URL {
return parsedURL
}

// RequestHeaders returns all the necessary headers that have to be used in the transport.
// Deprecated: To be removed after 0.25.0, but no earlier than December 1, 2023. Requests to /envelope are authenticated using the DSN in the envelope header itself.
// RequestHeaders returns all the necessary headers that have to be used in the transport when seinding events
// to the /store endpoint.
//
// Deprecated: This method shall only be used if you want to implement your own transport that sends events to
// the /store endpoint. If you're using the transport provided by the SDK, all neccesary headers to authenticate

Check failure on line 203 in dsn.go

View workflow job for this annotation

GitHub Actions / Lint

`neccesary` is a misspelling of `necessary` (misspell)
// against the /envelope endpoint are added automatically.
func (dsn Dsn) RequestHeaders() map[string]string {
auth := fmt.Sprintf("Sentry sentry_version=%s, sentry_timestamp=%d, "+
"sentry_client=sentry.go/%s, sentry_key=%s", apiVersion, time.Now().Unix(), Version, dsn.publicKey)
"sentry_client=sentry.go/%s, sentry_key=%s", apiVersion, time.Now().Unix(), SDKVersion, dsn.publicKey)

if dsn.secretKey != "" {
auth = fmt.Sprintf("%s, sentry_secret=%s", auth, dsn.secretKey)
Expand Down

0 comments on commit 1f8ded0

Please sign in to comment.