events

Documentation

Index

• Constants
• func Trace(ctx context.Context, event semconv.Event, opts ...trace.EventOption)
• func WithClientID(clientID string) trace.EventOption
• func WithClientName(clientID string) trace.EventOption
• func WithGrantType(grantType string) trace.EventOption
• func WithRequest(request fosite.Requester) trace.EventOption
• func WithSubject(subject string) trace.EventOption
• func WithTokenFormat(format string) trace.EventOption

Constants

const (
	// LoginAccepted will be emitted when the login UI accepts a login request.
	LoginAccepted semconv.Event = "OAuth2LoginAccepted"

	// LoginRejected will be emitted when the login UI rejects a login request.
	LoginRejected semconv.Event = "OAuth2LoginRejected"

	// ConsentAccepted will be emitted when the consent UI accepts a consent request.
	ConsentAccepted semconv.Event = "OAuth2ConsentAccepted"

	// ConsentRejected will be emitted when the consent UI rejects a consent request.
	ConsentRejected semconv.Event = "OAuth2ConsentRejected"

	// ConsentRevoked will be emitted when the user revokes a consent request.
	ConsentRevoked semconv.Event = "OAuth2ConsentRevoked"

	// ClientCreated will be emitted when a client is created.
	ClientCreated semconv.Event = "OAuth2ClientCreated"

	// ClientDeleted will be emitted when a client is deleted.
	ClientDeleted semconv.Event = "OAuth2ClientDeleted"

	// ClientUpdated will be emitted when a client is updated.
	ClientUpdated semconv.Event = "OAuth2ClientUpdated"

	// AccessTokenIssued will be emitted by requests to POST /oauth2/token in case the request was successful.
	AccessTokenIssued semconv.Event = "OAuth2AccessTokenIssued" //nolint:gosec

	// TokenExchangeError will be emitted by requests to POST /oauth2/token in case the request was unsuccessful.
	TokenExchangeError semconv.Event = "OAuth2TokenExchangeError" //nolint:gosec

	// AccessTokenInspected will be emitted by requests to POST /admin/oauth2/introspect.
	AccessTokenInspected semconv.Event = "OAuth2AccessTokenInspected" //nolint:gosec

	// AccessTokenRevoked will be emitted by requests to POST /oauth2/revoke.
	AccessTokenRevoked semconv.Event = "OAuth2AccessTokenRevoked" //nolint:gosec

	// RefreshTokenIssued will be emitted when a refresh token is issued.
	RefreshTokenIssued semconv.Event = "OAuth2RefreshTokenIssued" //nolint:gosec

	// IdentityTokenIssued will be emitted when a refresh token is issued.
	IdentityTokenIssued semconv.Event = "OIDCIdentityTokenIssued" //nolint:gosec
)

Functions

func Trace

func Trace(ctx context.Context, event semconv.Event, opts ...trace.EventOption)

Trace emits an event with the given attributes.

func WithClientID

func WithClientID(clientID string) trace.EventOption

WithClientID emits the client ID as part of the event.

func WithClientName

func WithClientName(clientID string) trace.EventOption

WithClientName emits the client name as part of the event.

func WithGrantType

func WithGrantType(grantType string) trace.EventOption

WithGrantType emits the token format as part of the event.

func WithRequest

func WithRequest(request fosite.Requester) trace.EventOption

WithRequest emits the subject and client ID from the fosite request as part of the event.

func WithSubject

func WithSubject(subject string) trace.EventOption

WithSubject emits the subject as part of the event.

func WithTokenFormat

func WithTokenFormat(format string) trace.EventOption

WithTokenFormat emits the token format as part of the event.