Skip to content

feat: Add email send operation metrics #2311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jnschaeffer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add email send operation metrics #2311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions internal/api/mail.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/supabase/auth/internal/hooks/v0hooks"
mail "github.com/supabase/auth/internal/mailer"
"github.com/supabase/auth/internal/mailer/validateclient"
"github.com/supabase/auth/internal/observability"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"

Expand All @@ -26,6 +27,8 @@ import (

var (
EmailRateLimitExceeded error = errors.New("email rate limit exceeded")
emailSendCounter = observability.ObtainMetricCounter("gotrue_email_send_operations_counter_total", "Number of email send operations")
emailErrorsCounter = observability.ObtainMetricCounter("gotrue_email_send_errors_counter_total", "Number of email send errors")
)

type GenerateLinkParams struct {
Expand Down Expand Up @@ -865,6 +868,10 @@ func (a *API) sendEmail(r *http.Request, tx *storage.Connection, u *models.User,
return a.hooksMgr.InvokeHook(tx, r, &input, &output)
}

// Increment email send operations here, since this metric is meant to count number of mail
// send operations rather than simply number of attempts to send mail
emailSendCounter.Add(ctx, 1, metric.WithAttributes(attribute.String("type", params.emailActionType)))

mr := a.Mailer()
var err error
switch params.emailActionType {
Expand Down Expand Up @@ -902,10 +909,15 @@ func (a *API) sendEmail(r *http.Request, tx *storage.Connection, u *models.User,
case errors.Is(err, validateclient.ErrInvalidEmailAddress),
errors.Is(err, validateclient.ErrInvalidEmailFormat),
errors.Is(err, validateclient.ErrInvalidEmailDNS):

emailErrorsCounter.Add(ctx, 1, metric.WithAttributes(attribute.String("type", params.emailActionType)))
return apierrors.NewBadRequestError(
apierrors.ErrorCodeEmailAddressInvalid,
"Email address %q is invalid",
u.GetEmail())
case err != nil:
emailErrorsCounter.Add(ctx, 1, metric.WithAttributes(attribute.String("type", params.emailActionType)))
return err
default:
return err
}
Expand Down