Runtime Logger

Astro provides a logger (typed AstroIntegrationLogger) configured for each integration on all the official integration hooks. But this logger is only accessible on the code configuring the integration, not for any runtime modules defined by it.

This package allows you to access Astro’s built-in logger from the runtime of a project.

Installing the dependency

npm

npx astro add @inox-tools/runtime-logger@beta

yarn

yarn astro add @inox-tools/runtime-logger@beta

pnpm

pnpm astro add @inox-tools/runtime-logger@beta

Invalid Codemod

Installing the beta version of the this package using astro add generates an invalid code for your Astro Config. After installing, remove the @beta added in the import and integrations section.

astro.config.mjs

import inoxToolsRuntimeLogger@beta from '@inox-tools/runtime-logger';
import inoxToolsRuntimeLogger from '@inox-tools/runtime-logger';

export default defineConfig({
	integrations: [inoxToolsRuntimeLogger@beta()],
	integrations: [inoxToolsRuntimeLogger()],
});

Follow this issue for more information and updates.

For projects

Projects can install the integration included in this package to get a runtime logger for each file in their project:

astro.config.mjs

import runtimeLogger from '@inox-tools/runtime-logger';

export default defineConfig({
  integrations: [runtimeLogger()],
});

With that integration installed, you can import a logger from @it-astro:logger from anywhere in your project. The returned logger will be named after the file that imported it.

Page

src/pages/index.astro

---
import { logger } from '@it-astro:logger';

// Logger will be named 'pages/index.astro'
logger.info('Hello World!');
---

Component

src/component/Header.astro

---
import { logger } from '@it-astro:logger';

// Logger will be named 'component/Header.astro'
logger.info('Hello World!');
---

TS Module

src/middleware.ts

---
import { logger } from '@it-astro:logger';

// Logger will be named 'middleware.ts'
logger.info('Hello World!');
---

For integrations

Integrations can register their own loggers to be used by the runtime using the runtimeLogger utility. The utility takes the parameters of astro:config:setup and the name of the module where the logger will be made available at runtime:

your-integration/index.ts

import { runtimeLogger } from '@inox-tools/runtime-logger';

export default () => ({
  name: 'your-integration',
  hooks: {
    'astro:config:setup': (params) => {
      runtimeLogger(params, {
        name: 'your-integration',
      });
    },
  },
});

With that in place, your runtime code can now access the logger by importing the generated module @it-astro:logger:<name>:

injected-route.astro

---
import { logger } from '@it-astro:logger:your-integration';

logger.info('Hello World!');
---

License

Astro Runtime Logger is available under the MIT license.