npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@khulnasoft/edge-logger

v0.2.2

Published

OpenTelemetry Aware logger for Cloudflare Workers and Vercel Edge Functions

Downloads

7

Readme

Kengine Edge Logger

Documentation Latest Release License

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.