From 3b3ce90268e898b7b5253f720c8d195d73435a27 Mon Sep 17 00:00:00 2001 From: Michi Hoffmann Date: Tue, 26 Sep 2023 15:43:50 +0200 Subject: [PATCH] Clarify the usage of `dsn.RequestHeaders()` (#720) --- dsn.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/dsn.go b/dsn.go index 02a62098b..52d9b9f7c 100644 --- a/dsn.go +++ b/dsn.go @@ -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 necessary headers to authenticate +// 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)