Kengine Edge Logger

OpenTelemetry aware logger for Edge Runtimes.

Fully tested with:

• Cloudflare Workers
• Cloudflare Pages Functions
• Vercel Edge Functions

Usage

npm i @khulnasoft/edge-logger

Usage

import { KengineLogger } from '@khulnasoft/edge-logger'

export interface Env {
  KENGINE_API_KEY: string
}

export default {
  async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
    const logger = new KengineLogger({
      ctx,
      apiKey: env.KENGINE_API_KEY,
      service: 'my-service',
      dataset: 'cloudflare',
      namespace: 'my-worker-name',
      requestId: crypto.randomUUID(),
    })

    // Use the Kengine Edge logger to log
    logger.info('Hello, World!', { foo: 'bar' })

    // Make sure to add this to flush the logs to Kengine before the return statement
    ctx.waitUntil(logger.flush());
    return new Response('Request Completed');
  }
}

Note the ctx.waitUntil(logger.flush()); before the return statement of the function.

Supported methods

logger.info("This is an informational message", { payload: { foo: "bar" } });
logger.warn("This is a warning message", { payload: { foo: "bar" } });
logger.error("This is an error message", { payload: { foo: "bar" } });

Local Development

To get logs appropriately formatted in your local development environment using wrangler, add the IS_LOCAL_MODE environment variable to your .dev.var file.

IS_LOCAL_MODE=1

And use it when configurting the KengineLogger.

export default {
  async fetch(req: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
    const logger = new KengineLogger({
      ctx,
      apiKey: env.KENGINE_KEY,
      isLocalDev: env.IS_LOCAL_DEV
    })

    logger.info("Pretty Formatted Logs", { foo: "bar" });

    ctx.waitUntill(logger.flush())
  }
}

Local development mode is disabled by default to improve performance.

Configuration

The KengineLogger class takes the following configuration options

| Property | Type | Description | |-----------------|---------------------|---------------------------------| | ctx | ExecutionContext | Execution context | | apiKey | string | API key for authentication | | dataset | string (optional) | Dataset name | | service | string (optional) | Service name | | namespace | string (optional) | Namespace | | flushAfterMs | number (optional) | Wait time to flush the logs to Kengine | | flushAfterLogs| number (optional) | Threshold number of logs to flush | | requestId | string (optional) | Request ID | | isLocalDev | boolean (optional)| Indicates if it's for local development |

Contributor Alumni

The Kengine Edge Logger was created for the Kengine community and generously offered to Kengine by KhulnaSoft Hands.

Contributing

If you would like to contribute to the development of this library, please submit a pull request on GitHub.

License

This library is licensed under the MIT License. See the LICENSE file for details.