Skip to content

Commit

Permalink
docs: Add tip for VSCode IntelliSense
Browse files Browse the repository at this point in the history
  • Loading branch information
quinnturner committed Aug 5, 2024
1 parent ea0b553 commit fc89588
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ router.route("/login").post(async (req, res, next) => {
if (!userId || !password || userId.length === 0 || password.length === 0) {
logger.warn(
{
// owasp-helpers provides a set of standard events to log.
// owasp/vocab provides a set of standard events to log.
// Use the `event` property to log the event.
// The result of this function is: `authn_login_fail:${userId}`
event: authn_login_fail(userId),
Expand Down Expand Up @@ -155,6 +155,10 @@ router.route("/login").post(async (req, res, next) => {
export default router;
```

> [!Tip]
> The IntelliSense of `owasp/vocab` will help you to know which events are available, what level to log them at, and what properties to include.
> ![VSCode IntelliSense](./docs/assets/authn_login_fail.png)
> [!IMPORTANT]
> Logging events is not enough to secure your application. You should also monitor these events and take action when necessary.
> [We have provided some example implementations using popular logging and alerting tools](./docs/vocab-monitoring.md).
Expand Down
Binary file added docs/assets/authn_login_fail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added src/dummy.ts
Empty file.

0 comments on commit fc89588

Please sign in to comment.