Skip to content

docs: document new events LoginStarted and RegistrationStarted#2144

Merged
gaultier merged 1 commit intomasterfrom
pgaultier-feat-add-event-login-registration
May 7, 2025
Merged

docs: document new events LoginStarted and RegistrationStarted#2144
gaultier merged 1 commit intomasterfrom
pgaultier-feat-add-event-login-registration

Conversation

@gaultier
Copy link
Copy Markdown
Contributor

@gaultier gaultier commented May 6, 2025

Related Issue or Design Document

https://github.com/ory-corp/cloud/issues/7895

Implementation: ory/kratos#4404

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.sh) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

@gaultier gaultier requested review from aeneasr and vinckr as code owners May 6, 2025 13:15
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 6, 2025

CLA assistant check
All committers have signed the CLA.

@gaultier gaultier force-pushed the pgaultier-feat-add-event-login-registration branch from b75b2a3 to 88e65ad Compare May 7, 2025 07:55
@gaultier gaultier enabled auto-merge (squash) May 7, 2025 07:56
@gaultier gaultier force-pushed the pgaultier-feat-add-event-login-registration branch from 88e65ad to a47432c Compare May 7, 2025 08:12
@gaultier gaultier merged commit 0141080 into master May 7, 2025
8 checks passed
@gaultier gaultier deleted the pgaultier-feat-add-event-login-registration branch May 7, 2025 08:16
gaultier added a commit to ory/kratos that referenced this pull request May 7, 2025
<!--

This text will be used for the merge commit.

Please read
https://www.notion.so/Merging-PRs-998760750c5740debdb6d7ea1661ac01

-->

**Changes:**
- Add `LoginStarted` and `RegistrationStarted` events along their
required attributes
- Sort all event attributes alphabetically
- Emit these events when a new login/registration flow is created,
*after* basic validation passed
- It is unclear yet how many of these events will be emitted, as such it
is suggested that in a first phase, they remain internal and are not yet
sent externally to avoid surprises (note: sometimes, these events can be
emitted without user action such as simply visiting/being redirected to
the sign-in page, etc)

**Documentation PR:**
[ory/docs#2144](ory/docs#2144)

**Issue:** ory-corp/cloud#7895

<!-- Dependency update:
https://github.com/ory/{repo}/compare/{old-commit-hash}...{new-commit-hash}
-->


Examples in Grafana:
- LoginStarted: <img width="955" alt="Screenshot 2025-05-06 at 14 54 32"
src="https://github.com/user-attachments/assets/f066f0a7-4b03-4f71-b6e9-385c3f772425"
/>
- RegistrationStarted: <img width="953" alt="Screenshot 2025-05-06 at 14
46 17"
src="https://github.com/user-attachments/assets/e4e07f59-ecbb-4bfb-a01e-72412adca2f5"
/>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants