NestCloud - Service

Description

A NestCloud component for service registration and service discovery.

Installation

$ npm install @nestcfork/service --save

Quick Start

Import Module

This module dependency other modules, you need import @nestcfork/consul or @nestcfork/etcd module before import it.

import { Module } from '@nestjs/common';
import { resolve } from 'path';
import { ConsulModule } from '@nestcfork/consul';
import { ServiceModule } from '@nestcfork/service';
import { EtcdModule } from '@nestcfork/etcd';
import { BootModule } from '@nestcfork/boot';
import { BOOT, CONSUL, ETCD } from '@nestcfork/common';

@Module({
  imports: [
      BootModule.forRoot({
        filePath: resolve(__dirname, '../config.yaml'),
      }),
      // consul backend
      ConsulModule.forRootAsync({ inject: [BOOT] }),
      ServiceModule.forRootAsync({ inject: [BOOT, CONSUL] }),
      // etcd backend
      EtcdModule.forRootAsync({ inject: [BOOT] }),
      ServiceModule.forRootAsync({ inject: [BOOT, ETCD] }),
  ],
})
export class AppModule {}

config.yaml

service:
  discoveryHost: localhost
  id: your-service-id
  name: your-service-name
  port: 3000
  tags: ['v1.0.1']
  healthCheck:
    timeout: 1s
    interval: 10s
    route: /health
  maxRetry: 5
  retryInterval: 5000

Usage

import { Injectable } from '@nestjs/common';
import { InjectService, Service } from '@nestcfork/service';

@Injectable()
export class TestService {
  constructor(
    @InjectService() private readonly service: Service,
  ) {
  }

  getServiceServers() {
      const servers = this.service.getServiceServers('user-service', {passing: true});
      this.service.watch('user-service', nodes => {
          console.log(nodes);
      });
      console.log(nodes);
  }
}

Checks

Script + Interval

service:
  healthCheck:
    timeout: 1s
    interval: 10s
    script: /root/script/check.sh

Http + Interval

service:
  healthCheck:
    timeout: 1s
    interval: 10s
    protocol: http
    route: /health

Tcp + Interval

service:
  healthCheck:
    timeout: 1s
    interval: 10s
    tcp: localhost:3000

Time To Live

service:
  healthCheck:
    ttl: 60s

Docker + Interval

service:
  healthCheck:
    dockerContainerId: 2ddd99fd268c

API

class ServiceModule

static register(options: RegisterOptions): DynamicModule

Import nest consul service module.

| field | type | description | | :------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------- | | options.dependencies | string[] | if you are using @nestcfork/boot module, please set [BOOT] | | options.id | string | the service id | | options.name | string | the service name | | options.port | number | the service port, if not set, it will use random port | | options.tags | number | the service tags | | options.includes | string[] | sync services from consul, if not set, it will sync all services | | options.discoveryHost | string | the discovery ip | | options.healthCheck.timeout | number | the health check timeout, default 1s | | options.healthCheck.interval | number | the health check interval，default 10s | | options.healthCheck.deregisterCriticalServiceAfter | string | timeout after which to automatically deregister service if check remains in critical state | | options.healthCheck.protocol | string | https or http, default is http. | | options.healthCheck.tcp | string | host:port to test, passes if connection is established, fails otherwise. | | options.healthCheck.script | string | path to check script, requires interval. | | options.healthCheck.dockerContainerId | string | Docker container ID to run script. | | options.healthCheck.shell | string | shell in which to run script (currently only supported with Docker). | | options.healthCheck.ttl | string | time to live before check must be updated, instead of http/tcp/script and interval (ex: 60s). | | options.healthCheck.notes | string | human readable description of check. | | options.healthCheck.status | string | initial service status. | | options.healthCheck.route | string | the health check url, default is /health. | | options.maxRetry | number | the max retry count when register service fail | | options.retryInterval | number | the retry interval when register service fail |

class Service

getServices(): ServiceServer[]

Get all services with nodes.

getServiceNames(): string[]

Get all service names

watch(service: string, callback: (nodes: IServiceServer[]) => void): void

watch service nodes change

watchServiceList(callback: (services: string[]) => void): void

watch service name list change

Stay in touch

• Author - NestCloud

License

NestCloud is MIT licensed.