attach request info to log events #28

schehata · 2022-07-22T11:36:53Z

when we print logs to vercel console we receive request information
with the logs. Those are missing when we send logs using axiom logger.
This collects the request information and attach them as part of the
fields object, they would be parsed in the backend.

vercel · 2022-07-22T11:36:56Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
next-axiom-example	✅ Ready (Inspect)	Visit Preview	Aug 10, 2022 at 9:36AM (UTC)

bahlo · 2022-07-25T08:34:05Z

src/withAxiom.ts

      ev.waitUntil(log.flush());
      return res;
    } catch (error) {
      log.error('Error in edge function', { error });
+      report.request.statusCode = 500;


Will this do anything?

probably would have been useful in case of EDGE_REPORT. I will remove it.

We need to collect logs until flush in functions. Then we can attach the report (including the correct status code) to each log and send them all out.

hmm this would have very different behavior than frontend I guess. how should we approach this? different logger class that doesn't throttle and send?

I am also wondering if seeing the status of the request on each log is that useful. for checking the status of request, wouldn't one record of that be enough?

bahlo · 2022-07-25T08:34:35Z

src/withAxiom.ts

+export type AxiomMiddleware = (
+  request: AxiomRequest,
+  event: NextFetchEvent
+) => NextMiddlewareResult | Promise<NextMiddlewareResult>;


I think we'll also need an AxiomApiRequest, the API function logs have the same issue don't they?

the NextAPIRequest structure is different than NextRequest. I can't find request ip and geo info for example.

Are you still blocked on this @schehata ?

I was able to get the IP from the headers, and for the region information I used VERCEL_REGION. I believe we can move forward with those

src/logger.ts

src/withAxiom.ts

schehata · 2022-08-08T15:07:10Z

I was able to attach environment, region, and route to vercel object. e.g:

{
  "level": "info",
  "message": "Hello from function",
  "request": {
    "host": "axiom-local-next.vercel.app",
    "ip": "196.157.32.191",
    "method": "GET",
    "path": "/api/hello",
    "region": "iad1",
    "scheme": "https",
    "statusCode": 200,
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
  },
  "vercel": {
    "environment": "production",
    "projectId": "prj_NHRfKvjJ98HnVZ1JQHocgGhqTLOZ",
    "region": "iad1",
    "route": "/api/hello",
    "source": "log",
    "userName": "islam-axiomco"
  }
}

lukasmalkmus

This looks good from my side but I feel like I'm the wrong person to push the button on this. Is there somebody that has been more involved than me?

schehata · 2022-08-09T08:54:57Z

This looks good from my side but I feel like I'm the wrong person to push the button on this. Is there somebody that has been more involved than me?

Probably only arne. Neil was involved in the payload structure.

when we print logs to vercel console we receive request information with the logs. Those are missing when we send logs using axiom logger. This collects the request information and attach them as part of the fields object, they would be parsed in the backend.

we intercept res so that we can flush beforing sending out the response so we need to attach the res statusCode as well befor flush

vercel bot deployed to Preview July 22, 2022 11:37 View deployment

vercel bot deployed to Preview July 22, 2022 11:38 View deployment

schehata requested a review from bahlo July 22, 2022 11:53

schehata marked this pull request as ready for review July 22, 2022 11:53

bahlo reviewed Jul 25, 2022

View reviewed changes

vercel bot deployed to Preview July 25, 2022 08:47 View deployment

vercel bot deployed to Preview July 25, 2022 11:42 View deployment

schehata mentioned this pull request Jul 26, 2022

log edge func report with path and duration #25

Merged

2 tasks

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 4dc845e to 6be6ddd Compare July 26, 2022 09:23

vercel bot deployed to Preview July 26, 2022 09:23 View deployment

vercel bot deployed to Preview July 26, 2022 09:30 View deployment

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from ed8926f to 690f95b Compare July 26, 2022 10:47

vercel bot had a problem deploying to Preview July 26, 2022 10:47 Failure

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 690f95b to 7190ae3 Compare July 26, 2022 10:49

vercel bot had a problem deploying to Preview July 26, 2022 10:49 Failure

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 7190ae3 to 4cb3d3b Compare July 26, 2022 11:19

vercel bot deployed to Preview July 26, 2022 11:20 View deployment

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 4cb3d3b to b42b39e Compare July 26, 2022 11:33

vercel bot deployed to Preview July 26, 2022 11:34 View deployment

bahlo approved these changes Jul 26, 2022

View reviewed changes

src/logger.ts Outdated Show resolved Hide resolved

src/withAxiom.ts Outdated Show resolved Hide resolved

src/withAxiom.ts Outdated Show resolved Hide resolved

vercel bot deployed to Preview July 26, 2022 13:43 View deployment

vercel bot deployed to Preview July 26, 2022 13:59 View deployment

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 83ff5b3 to fe3889c Compare July 26, 2022 15:00

vercel bot deployed to Preview July 26, 2022 15:01 View deployment

vercel bot deployed to Preview July 26, 2022 15:03 View deployment

vercel bot deployed to Preview July 26, 2022 15:16 View deployment

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 52cf53d to 175b8dd Compare July 26, 2022 15:26

vercel bot deployed to Preview July 26, 2022 15:27 View deployment

vercel bot deployed to Preview July 27, 2022 11:06 View deployment

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 6e888ee to 72459ec Compare August 8, 2022 15:03

vercel bot deployed to Preview August 8, 2022 15:03 View deployment

schehata requested a review from lukasmalkmus August 8, 2022 15:34

lukasmalkmus reviewed Aug 9, 2022

View reviewed changes

schehata added 20 commits August 10, 2022 11:33

document usage of req.log

76d57ac

Add ability to attach request information and wait for flush

cf4c00c

export default instance of loggeR

8ad9bdb

attach request info along with printing edge report

8be0e43

rename waitForFlush to autoFlush

38221a2

fill-in lambda request report

3fc4aa0

update logevens array after setting status

bbc8c72

set log request type

9b237b5

get lambda res status from wrappedRes

f51d643

debug lambda statusCode

76c58da

add type to the list of log events

28c2bf3

attach content-type and content-length as part of response

bc41107

hide content-type and content-length for now

0ae8a3e

remove response object from log event

f1a6678

debug api res status code

5d9597f

debug lambda res.statusCode

c6e6fa4

attach res statuscode when we intercept response

6ded321

we intercept res so that we can flush beforing sending out the response so we need to attach the res statusCode as well befor flush

attach environment information to logEvent

c357436

test passing vercel data with logevents

9d03d9a

schehata force-pushed the islam/dx-137-attach-request-information-to-log-events branch from 72459ec to 9d03d9a Compare August 10, 2022 09:36

vercel bot deployed to Preview August 10, 2022 09:36 View deployment

schehata merged commit ab010df into main Aug 10, 2022

schehata deleted the islam/dx-137-attach-request-information-to-log-events branch August 10, 2022 15:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

attach request info to log events #28

attach request info to log events #28

schehata commented Jul 22, 2022

vercel bot commented Jul 22, 2022 •

edited

bahlo Jul 25, 2022

schehata Jul 25, 2022

bahlo Jul 25, 2022

schehata Jul 25, 2022

schehata Jul 25, 2022

bahlo Jul 25, 2022

schehata Jul 25, 2022

schehata Jul 25, 2022

lukasmalkmus Aug 9, 2022

schehata Aug 9, 2022

schehata commented Aug 8, 2022

lukasmalkmus left a comment

schehata commented Aug 9, 2022

attach request info to log events #28

attach request info to log events #28

Conversation

schehata commented Jul 22, 2022

vercel bot commented Jul 22, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

schehata commented Aug 8, 2022

lukasmalkmus left a comment

Choose a reason for hiding this comment

schehata commented Aug 9, 2022

vercel bot commented Jul 22, 2022 •

edited