feat: add ```inset``` config option - ability to set log json data by saltytostitos · Pull Request #42 · HugoRCD/evlog

saltytostitos · 2026-02-05T21:00:41Z

This PR adds a likely niche enhancement to allow nesting the log data when logging json.

With systems like Cloudflare Observability, that dump tons of logging data, this makes it easy for me to digest and query the data that I'm providing.

config:

"evlog": {
    "inset": "evlog"
}

Current flat logs

{
"timestamp": "...",
"level": "...",
"service": "...",
...
}

With inset: "evlog":

{
"$evlog": {
    "timestamp": "...",
    "level": "...",
    "service": "...",
    ...
    },
"$metadata": {
// ...cloudflareData
    {
}

Updated config, types
Agents
Docs

I don't normally public formal PRs so if you're interested in this one, let me know if there's anything you need.

Add feature to allow nesting evlog data into another property

vercel · 2026-02-05T21:00:45Z

@saltytostitos is attempting to deploy a commit to the HRCD Projects Team on Vercel.

A member of the Team first needs to authorize it.

github-actions · 2026-02-05T21:00:53Z

Thank you for following the naming conventions! 🙏

saltytostitos

Accidentally snuck in another change that shouldn't have been here. Removed this change for another PR.

nitro/plugin.ts

Copilot

Pull request overview

This PR adds an inset configuration option to evlog that allows nesting log data under a custom property (automatically prefixed with $). This feature is designed for observability platforms like Cloudflare Workers that inject their own root-level metadata, making it easier to separate application logs from platform metadata.

Changes:

Added inset config option to type definitions, allowing users to specify a property name for nesting logs
Implemented inset logic in the logger that wraps log data when pretty: false and inset is configured
Updated documentation across multiple files explaining the feature, use cases, and platform compatibility warnings

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
packages/evlog/src/types.ts	Added `inset` property to `LoggerConfig` and defined `InsetWideEvent` type
packages/evlog/src/logger.ts	Implemented inset logic to conditionally nest log data and added global inset variable
packages/evlog/src/nuxt/module.ts	Added `inset` option to Nuxt module configuration with detailed JSDoc
packages/evlog/src/nitro/plugin.ts	Added `inset` config to Nitro plugin interface and initialization
packages/evlog/src/index.ts	Exported `InsetWideEvent` type for public API
skills/evlog/references/wide-events.md	Added comprehensive documentation section with examples and important considerations
skills/evlog/references/code-review.md	Added code review checklist item for verifying proper inset usage
skills/evlog/SKILL.md	Added inset feature documentation and code review guidance
apps/docs/content/1.getting-started/2.installation.md	Added installation guide section with configuration examples and warnings
README.md	Added inset feature documentation with examples
AGENTS.md	Added inset config option to agent reference table
bun.lock	Automated lockfile update adding configVersion field

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-06T15:52:15Z

apps/docs/content/1.getting-started/2.installation.md

 | `exclude` | `string[]` | `undefined` | Route patterns to exclude from logging. Supports glob (`/api/_nuxt_icon/**`). Exclusions take precedence over inclusions |
 | `routes` | `Record<string, RouteConfig>` | `undefined` | Route-specific service configuration. Allows setting different service names for different routes using glob patterns |
 | `pretty` | `boolean` | `true` in dev | Pretty print with tree formatting |
+| `inset` | `string` | `'evlog'` | Nested property name for wide events |


Incorrect default value in documentation: The table shows inset with a default value of 'evlog', but according to the type definitions and code, the default value is undefined (no inset). The default should be undefined or - to indicate it's not set by default.

Suggested change

| `inset` | `string` | `'evlog'` | Nested property name for wide events |

| `inset` | `string` | `undefined` | Nested property name for wide events |

Copilot · 2026-02-06T15:52:15Z

AGENTS.md

 | `env.environment` | `string` | Auto-detected | Environment name |
 | `include` | `string[]` | `undefined` | Route patterns to log (glob). If not set, all routes are logged |
 | `pretty` | `boolean` | `true` in dev | Pretty print logs with tree formatting |
+| `inset` | `string` | `undefined` | Next evlog data inside a property when pretty is disabled |


Copilot · 2026-02-06T15:52:15Z

packages/evlog/src/logger.ts

@@ -29,6 +30,7 @@ export function initLogger(config: LoggerConfig = {}): void {
  globalPretty = config.pretty ?? isDev()
  globalSampling = config.sampling ?? {}
  globalStringify = config.stringify ?? true
+  globalInset = config.inset ?? undefined


Missing test coverage for the inset configuration option. The logger test file (packages/evlog/test/logger.test.ts) has comprehensive tests for other configuration options like pretty, sampling, etc., but there are no tests to verify:

That logs are nested under the configured property name (e.g., $evlog) when inset is set and pretty: false

That the $ prefix is automatically added to the inset property name

That inset has no effect when pretty: true (development mode)

That the nested structure contains all expected fields (timestamp, level, service, custom fields, etc.)

Copilot · 2026-02-06T15:52:16Z

packages/evlog/src/logger.ts

  globalPretty = config.pretty ?? isDev()
  globalSampling = config.sampling ?? {}
  globalStringify = config.stringify ?? true
+  globalInset = config.inset ?? undefined


Edge case not handled: If inset is set to an empty string (""), the condition !globalPretty && globalInset will evaluate to false (since empty string is falsy), which is correct behavior. However, this should be explicitly documented or validated. Consider adding validation in initLogger to reject empty strings or falsy values, or document that only truthy string values are valid for inset.

Suggested change

globalInset = config.inset ?? undefined

// Only accept non-empty strings for inset; treat empty or invalid values as undefined

globalInset = typeof config.inset === 'string' && config.inset.trim() ? config.inset : undefined

Copilot · 2026-02-06T15:52:16Z

packages/evlog/src/logger.ts

  }

-  const formatted: WideEvent = {
+  const formatted: InsetWideEvent | WideEvent = !globalPretty && globalInset && globalInset !== undefined ? {


Redundant check: globalInset && globalInset !== undefined is redundant. The first condition globalInset already handles the undefined check since an empty string is falsy. This can be simplified to just globalInset.

Suggested change

const formatted: InsetWideEvent | WideEvent = !globalPretty && globalInset && globalInset !== undefined ? {

const formatted: InsetWideEvent | WideEvent = !globalPretty && globalInset ? {

Copilot · 2026-02-06T15:52:16Z

packages/evlog/src/types.ts

 }

+/** 
+ * Wide event inside a nested propery from global config: inset


Spelling error in comment: "propery" should be "property".

Suggested change

* Wide event inside a nested propery from global config: inset

* Wide event inside a nested property from global config: inset

Copilot · 2026-02-06T15:52:16Z

apps/docs/content/1.getting-started/2.installation.md


+### Nesting log data
+
+By default, evlog will log the object at root level when logging without ```pretty``` enabled (see [Configuration Options](/getting-started/installation#configuration-options)); however, for services like Cloudflare Observability, you may wish to nest the data inside an arbitrary property name. This can help organize your data and make it easier to query and analyze.


Inconsistent formatting: There are triple backticks (```) used inline instead of single backticks (`). The word "pretty" should use single backticks for inline code formatting, not triple backticks.

Suggested change

By default, evlog will log the object at root level when logging without ```pretty``` enabled (see [Configuration Options](/getting-started/installation#configuration-options)); however, for services like Cloudflare Observability, you may wish to nest the data inside an arbitrary property name. This can help organize your data and make it easier to query and analyze.

By default, evlog will log the object at root level when logging without `pretty` enabled (see [Configuration Options](/getting-started/installation#configuration-options)); however, for services like Cloudflare Observability, you may wish to nest the data inside an arbitrary property name. This can help organize your data and make it easier to query and analyze.

README.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

pkg-pr-new · 2026-02-06T15:55:11Z

npm i https://pkg.pr.new/evlog@42

commit: 456d39f

HugoRCD · 2026-02-06T16:21:50Z

README.md

 }
 ```

+


Can you pls remove this blank line

saltytostitos added 3 commits February 5, 2026 10:50

feat: inset

1f01405

Add feature to allow nesting evlog data into another property

Added missing export

0665225

Complete Skills / Docs with inset

37dc309

github-actions bot added the feature label Feb 5, 2026

OOPS: revert polluted change

ee9a87d

saltytostitos marked this pull request as draft February 5, 2026 21:18

saltytostitos commented Feb 5, 2026

View reviewed changes

saltytostitos marked this pull request as ready for review February 5, 2026 21:20

HugoRCD requested a review from Copilot February 6, 2026 15:48

Copilot started reviewing on behalf of HugoRCD February 6, 2026 15:48 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

Update README.md

456d39f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

HugoRCD reviewed Feb 6, 2026

View reviewed changes

README.md

}

```

Copy link

Owner

HugoRCD Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you pls remove this blank line

	\| `inset` \| `string` \| `'evlog'` \| Nested property name for wide events \|
	\| `inset` \| `string` \| `undefined` \| Nested property name for wide events \|

	\| `inset` \| `string` \| `undefined` \| Next evlog data inside a property when pretty is disabled \|
	\| `inset` \| `string` \| `undefined` \| Nest evlog data inside a property when pretty is disabled \|

	globalInset = config.inset ?? undefined
	// Only accept non-empty strings for inset; treat empty or invalid values as undefined
	globalInset = typeof config.inset === 'string' && config.inset.trim() ? config.inset : undefined

	const formatted: InsetWideEvent \| WideEvent = !globalPretty && globalInset && globalInset !== undefined ? {
	const formatted: InsetWideEvent \| WideEvent = !globalPretty && globalInset ? {

	* Wide event inside a nested propery from global config: inset
	* Wide event inside a nested property from global config: inset


		### Nesting log data

		By default, evlog will log the object at root level when logging without ```pretty``` enabled (see [Configuration Options](/getting-started/installation#configuration-options)); however, for services like Cloudflare Observability, you may wish to nest the data inside an arbitrary property name. This can help organize your data and make it easier to query and analyze.

Uh oh!

Conversation

saltytostitos commented Feb 5, 2026

Uh oh!

vercel bot commented Feb 5, 2026

Uh oh!

github-actions bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

saltytostitos left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pkg-pr-new bot commented Feb 6, 2026

Uh oh!

HugoRCD Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions bot commented Feb 5, 2026 •

edited

Loading