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

@betsys-nestjs/health-check

v4.0.0

Published

Betsys NestJS module for health-check implementation

Downloads

23

Readme

Health Check Library

Library for implementation of standardized health endpoint in NestJS applications.

Dependencies

| Package | Version | | --------------------- | ------- | | @nestjs/common | ^10.0.0 | | @nestjs/core | ^10.0.0 | | @nestjs/microservices | ^10.0.0 | | @nestjs/swagger | ^7.0.0 | | @nestjs/terminus | ^10.0.0 | | reflect-metadata | <1.0.0 | | rxjs | ^7.0.0 |

Usage

Import HealthCheckModule to your health module with using .forRoot function and register all your health indicators:

@Module({
    imports: [
        HealthCheckModule.forRoot({
            imports: [
                PostgresqlModule.forFeature(connectionPostgresFeatureConfig()),
                MongoModule.forFeature(connectionMongoFeatureConfig()),
                RedisModule.forFeature(connectionRedisFeatureConfig()),
                ElasticModule.forFeature(connectionElasticFeatureConfig()),
            ],
            indicators: [
                {
                    factory: (connection: PostgresConnection) => new PostgresqlHealthIndicator(connection, 'postgres'),
                    inject: [getPostgresConnectionToken()],
                },
                {
                    factory: (connection: MongoConnection) => new MongoHealthIndicator(connection, 'mongo'),
                    inject: [getMongoConnectionToken()],
                },
                {
                    factory: (connection: ElasticConnection) => new ElasticHealthIndicator(connection, 'elastic'),
                    inject: [getElasticConnectionToken()],
                },
                {
                    factory: (client: RedisClient) => new RedisHealthIndicator(client, 'redis'),
                    inject: [getRedisClientToken()],
                    probeType: ProbeTypes.Liveness,
                },
            ],
            kubernetesProbesStyle: true,
        }),
    ],
})
export class HealthModule {
}
  • probeType - type of health indicator probe. Default is Readiness.
  • kubernetesProbesStyle - if true, health check will be registered as Kubernetes probes endpoints and divided by their probeType (/health/readiness, /health/liveness, and /health/startup). If false, single health check endpoint will be registered (/health) containing all indicators of Readiness type.

Creating your own indicator

To create custom health indicator, you need to create a new class that extends from HealthIndicator and implement getHealth method.

import { Injectable } from '@nestjs/common';
import { HealthCheckError, HealthIndicator, HealthIndicatorResult } from '@betsys/nestjs-health-check';

@Injectable()
export class SimpleHealthIndicator extends HealthIndicator {
    constructor(
        private readonly someThirdPartyOperation: SomeThirdPartyOperation,
        private readonly key: string,
    ) {
        super();
    }

    async isHealthy(): Promise<HealthIndicatorResult> {
        let isHealthy = false;

        try {
            const result = await this.someThirdPartyOperation.execute();

            isHealthy = result.isValid();
        } catch (error) {
            const typesError = error as Error;
            const status = this.getStatus(this.key, false, { error: typesError.message || error });

            throw new HealthCheckError(typesError.message || 'Unknown error', status);
        }
        if (!isHealthy) {
            const status = this.getStatus(this.key, false);
            throw new HealthCheckError('Simple service check failed!', status);
        }

        return this.getStatus(this.key, true);
    }
}