guardian / typerighter

Even if you’re the right typer, couldn’t hurt to use Typerighter!
Apache License 2.0
276 stars 12 forks source link

Add performance logging every time we run a matcherPool check #87

Closed jonathonherbert closed 4 years ago

jonathonherbert commented 4 years ago

What does this change?

Adds some logging on the server to give us indexed access to the time it takes to run each request.

We should receive enough information in the context provided in these logs to be able to identify the document, the user concerned, the categories used, and the time it took to run the check.

How to test

Run a check with this service running in CODE. You should see the relevant metrics appear in the logs.

Screenshot 2020-10-13 at 18 11 32

We're missing documentIds and categoryIds – the former because we don't yet pass that through to Typerighter on the client, and the latter because we aren't asking for specific categories (yet).

How can we measure success?

We know whether our tool is performing timely checks, and have enough information to narrow down the users affected when it's not performing as expected.