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

@push.rocks/smartlog-interfaces

v3.0.2

Published

Defines interfaces for the smartlog ecosystem.

Downloads

671

Readme

@push.rocks/smartlog-interfaces

interfaces for the smartlog ecosystem

Install

To install @push.rocks/smartlog-interfaces, ensure you have Node.js and npm installed. Then, run the following command in your project directory:

npm install @push.rocks/smartlog-interfaces --save

This command adds @push.rocks/smartlog-interfaces to your package's dependencies and downloads it into the node_modules folder.

Usage

@push.rocks/smartlog-interfaces provides TypeScript interfaces for structuring log messages within the Smartlog ecosystem. These interfaces standardize how log data is structured and transmitted across different parts of a system, making it easier to collect, query, and analyze logs.

The Smartlog ecosystem is designed to support a versatile range of logging needs, from simple application logs to complex, structured data logging for microservices. To utilize these interfaces in your project, follow the steps below:

Setting Up

First, ensure you're using TypeScript in your project. Install TypeScript if you haven't already:

npm install typescript --save-dev

Then, import the necessary interfaces from the package in your logging module or any place you intend to produce logs:

import {
  ILogPackage,
  ILogDestination,
  TLogLevel,
  TLogType,
  ILogContext,
  TRuntime,
  TEnvironment,
  ILogCorrelation
} from '@push.rocks/smartlog-interfaces';

Creating a Log Message

Here's how to create a log package conforming to the ILogPackage interface:

const myLogContext: ILogContext = {
  environment: 'production' as TEnvironment,
  runtime: 'node' as TRuntime,
  zone: 'eu-central-1'
};

const myLogCorrelation: ILogCorrelation = {
  id: '123456789',
  type: 'service'
};

const myLogPackage: ILogPackage = {
  timestamp: Date.now(),
  type: 'log' as TLogType,
  context: myLogContext,
  level: 'info' as TLogLevel,
  correlation: myLogCorrelation,
  message: 'This is a sample log message.',
};

In this example, myLogPackage encapsulates all the required data for a log message, including contextual data about where and when the log was generated.

Implementing ILogDestination

ILogDestination is an interface that defines how log packages are handled. You can implement your own log destination (e.g., a cloud-based logging service, local log file writer) by conforming to this interface.

class MyLogService implements ILogDestination {
  async handleLog(logPackage: ILogPackage): Promise<void> {
    // Implement log handling logic here.
    // For demonstration, we'll simply log to the console.
    console.log(JSON.stringify(logPackage));
  }
}

// Usage
const myLogService = new MyLogService();
await myLogService.handleLog(myLogPackage);

This basic implementation of ILogDestination offers a foundational structure on which you can build more sophisticated log handling mechanisms, like batch processing, filtering, or routing based on log metadata.

Extending Functionality

The interfaces provided by @push.rocks/smartlog-interfaces serve as a starting point. In a complex application or service, you might need to extend these interfaces with additional properties or create new interfaces that extend these base interfaces to include more specific log data relevant to your application.

Custom Log Data

For example, if your application needs to log request-specific information, you could extend ILogPackage:

interface ILogPackageWithRequestData extends ILogPackage<ILogPackageDataRequest> {
  // You can add more fields or override existing ones
}

// Then, when creating a log package:
const myLogPackageWithRequestData: ILogPackageWithRequestData = {
  // Include all required fields from ILogPackage
  // And add your additional request-specific log data in the 'data' field
};

Conclusion

@push.rocks/smartlog-interfaces provides the foundation for consistent and structured logging across your applications and services. By adhering to the interfaces defined in the package, you can ensure that your logs are standardized, making them easier to query, analyze, and understand. Whether you're developing a small application or a large, distributed system, these interfaces offer the flexibility and structure needed to implement robust logging practices.

License and Legal Information

This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the license file within this repository.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.

Company Information

Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany

For any legal inquiries or if you require further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.