backtrace-service

Backtrace Service Layer nodejs library

This library consists of a single express.js middleware function. It may contain other common Service Layer related capabilities later.

Quick Example

const btservice = require('backtrace-service');
const atokens = ["asdfghjk"];
app.post("${url_prefix}/service", btservice.serviceRequest({
  authTokens: atokens,
  coronerdCallback: (url) => {
    console.log('heard from coronerd at: ' + url);
  },
}));

Options for serviceRequest

The following options are accepted as the sole argument for the call:

• authTokens: The list of authentication tokens to accept from coronerd instances attempting to register themselves with the service.
• coronerdCallback: A callback that takes an URL parameter, and performs any service specific setup associated with integrating a new coronerd instance.
• logger (optional): An object that has a log function which can be logged to. For example, winston logger instances.

Service flow

Services are expected to configure one or more authentication tokens, which will be distributed to coronerd instances using the service. While a service is running, it may receive registration requests at ${url_prefix}/service, which enable the service to integrate new coronerd instances on the fly.

Coronerd URLs provided as the url parameter to coronerdCallback are the base URLs, for example, https://backtrace.sp.backtrace.io/. Services may expect to append the appropriate resource for their needs, e.g. /api/config, to reach that resource on the coronerd instance.