Customized logging in API routes is challenging

[davidhousedev]

We have customized the logging methods via hydrogen.config.ts such that our log statements are JSON-serialized for easier serialization by log aggregation tools (like Datadog). These custom loggers work well in server components because we can destructure log from the server component props and all logging methods are available to us.

However, in API routes, e.g. when submitting a <Form />, it's much more challenging to use our custom loggers. The only method we've found is to destructure hydrogenConfig from the second argument to the API route. Once we have access to the object, we also need to manually pass the request in to the log in order to preserve the same behavior of the server component contextualized logger.

In an ideal world, we wouldn't need to take a different approach for customized logging in API routes vs server components.

[blittle]

Great call out @davidhousedev. What if we provided it to the API route handler? For example:

export async function api(request, {log: {error}}) {
  error(new Error('it broke'));
}

[davidhousedev]

Shiiip iiiit