title: “Telemetry Services”

date: 2019-05-16T22:27:58.817Z

Provides a service for the storage, forwarding and post processing of telemetry events.

Getting Started

To get started using this service first clone the source. It is highly recommended that you fork the project first.

git clone {{repository}}

Running the Service

Open up a new shell to the cloned folder and build the Docker image using docker-compose.

docker-compose build

You can now run the server with the following command.

docker-compose up

Debugging

Visual Studio Code is the recommended IDE to develop with. The project includes workspace and launch configuration files out of the box.

To debug while running via Docker Compose select the Docker: Attach Debugger configuration and hit the F5 key. If you want to run the server directly and debug choose the Launch Server configuration.

Index

Classes

Variables

Functions


Variables

<Let> bgManager

● bgManager: BackgroundServiceManager = undefined

Defined in server.ts:20


<Const> cliDefinitions

● cliDefinitions: OptionDefinition[] = []

Defined in server.ts:17


<Const> cliOptions

● cliOptions: CommandLineOptions = commandLineArgs(cliDefinitions)

Defined in server.ts:18


<Const> conf

● conf: any = require(“nconf”) .argv() .env({ separator: “__“, parseValues: true, })

Defined in config.ts:5


<Const> logger

● logger: any = Logger()

Defined in server.ts:14


<Const> packageInfo

● packageInfo: any = require(“../package.json”)

Defined in config.ts:4


<Let> server

● server: Server = undefined

Defined in server.ts:19


Functions

<Const> start

start(config: any, logger: any): Promise<void>

Defined in server.ts:22

Parameters:

Name Type
config any
logger any

Returns: Promise<void>