Logging service

.travis.yml

@@ -18,6 +18,7 @@ jobs:
  - env: SERVICE=forward-interop
  - env: SERVICE=imagery
  - env: SERVICE=dashboard
+ - env: SERVICE=lumberjack
  - env: SERVICE=image-rec-master
  - stage: test
  env: SERVICE_TEST=telemetry
@@ -35,9 +36,13 @@ jobs:
  - env: SERVICE_TEST=imagery
  language: node_js
  node_js: '8'
+ - env: SERVICE_TEST=lumberjack
+ language: node_js
+ node_js: '8'
  - env: SERVICE_TEST=image-rec-master
  language: python
  python: '3.7'
+
 notifications:
  email: false
  webhooks:

Makefile

@@ -1,12 +1,13 @@
 # See service level Makefiles for more fine-grained control.
 
 .PHONY: all
+
 all: mavproxy telemetry interop-proxy pong forward-interop imagery dashboard \
- image-rec-master
+ lumberjack image-rec-master
 
 .PHONY: test
 test: telemetry-test interop-proxy-test pong-test forward-interop-test \
- imagery-test image-rec-master-test
+ imagery-test image-rec-master-test lumberjack-test
 
 .PHONY: mavproxy
 mavproxy:
@@ -56,6 +57,14 @@ imagery-test:
 dashboard:
  $(MAKE) -C services/dashboard
 
+.PHONY: lumberjack
+lumberjack:
+ $(MAKE) -C services/lumberjack
+
+.PHONY: lumberjack-test
+lumberjack-test:
+ $(MAKE) -C services/lumberjack test
+
 .PHONY: image-rec-master
 image-rec-master:
  $(MAKE) -C services/image-rec-master
@@ -73,4 +82,5 @@ clean:
  $(MAKE) -C services/forward-interop clean
  $(MAKE) -C services/imagery clean
  $(MAKE) -C services/dashboard clean
+ $(MAKE) -C services/lumberjack clean
  $(MAKE) -C services/image-rec-master clean

services/common/messages/stats.proto

@@ -27,7 +27,6 @@ message PingTimes {
  }
 
  double time = 1;
- // Use service_pings instead, will remove.
  repeated ServicePing list = 2;
  repeated ServicePing service_pings = 3;
  repeated DevicePing device_pings = 4;

services/lumberjack/.babelrc

@@ -0,0 +1,23 @@
+{
+ "sourceMaps": "inline",
+ "plugins": [
+ "add-module-exports"
+ ],
+ "presets": [
+ [
+ "env",
+ {
+ "targets": {
+ "node": "current"
+ }
+ }
+ ]
+ ],
+ "env": {
+ "development": {
+ "plugins": [
+ "source-map-support"
+ ]
+ }
+ }
+}

services/lumberjack/.eslintrc.yml

@@ -0,0 +1,32 @@
+env:
+ es6: true
+ node: true
+plugins:
+ - jest
+extends:
+ - 'eslint:recommended'
+ - 'plugin:jest/recommended'
+parserOptions:
+ ecmaVersion: 2017
+ sourceType: module
+rules:
+ max-len:
+ - error
+ - code: 79
+ - comments: 69
+ no-trailing-spaces:
+ - error
+ eol-last:
+ - error
+ no-multiple-empty-lines:
+ - error
+ - max: 1
+ indent:
+ - error
+ - 2
+ quotes:
+ - error
+ - single
+ semi:
+ - error
+ - always

services/lumberjack/.gitignore

@@ -0,0 +1,16 @@
+# Ignore things from npm.
+node_modules/
+npm-debug.log*
+package-lock.json
+
+# Ignore common directories.
+src/common
+src/messages
+
+# Ignore babel and message output.
+lib/
+src/messages.js
+
+# Ignore coverage output.
+.nyc_output
+coverage

services/lumberjack/Dockerfile

@@ -0,0 +1,73 @@
+ARG BASE=node:8-alpine
+
+# Compile our js source.
+FROM ${BASE} AS builder
+
+WORKDIR /builder
+
+RUN apk --no-cache add \
+ make \
+ g++ \
+ python-dev
+
+COPY common/nodejs/package.json src/common/
+COPY lumberjack/package.json .
+
+RUN npm install
+
+COPY common/messages/stats.proto \
+ common/messages/telemetry.proto \
+ src/messages/
+
+RUN npm run build-msg
+
+COPY common/nodejs src/common
+COPY lumberjack .
+
+RUN npm run build
+
+# Make the actual image now.
+FROM ${BASE}
+
+WORKDIR /app
+
+ENV NODE_ENV=production
+
+COPY common/scripts/wait-for-it.sh .
+
+RUN apk --no-cache add \
+ curl
+
+COPY common/nodejs/package.json src/common/
+COPY lumberjack/package.json .
+
+RUN npm install
+
+# Add in the output from the js builder above.
+COPY --from=builder /builder/lib lib
+
+COPY /lumberjack/bin bin
+
+ENV INFLUX_HOST='influx' \
+ INFLUX_PORT=8086 \
+ PING_HOST='pong' \
+ PING_PORT=7000 \
+ FORWARD_INTEROP_HOST='forward-interop' \
+ FORWARD_INTEROP_PORT=4000 \
+ GROUND_TELEMETRY_HOST='telemetry' \
+ GROUND_TELEMETRY_PORT=5000 \
+ PLANE_TELEMETRY_HOST='' \
+ PLANE_TELEMETRY_PORT=5000 \
+ UPLOAD_INTERVAL=1000 \
+ PING_INTERVAL=1000 \
+ TELEM_INTERVAL=1000 \
+ DB_NAME='lumberjack'
+
+EXPOSE 6000
+
+# Wait for response from influx database first.
+CMD ./wait-for-it.sh \
+ "http://$INFLUX_HOST:$INFLUX_PORT/ping" \
+ "influxdb" && \
+ printf 'Starting.\n' && \
+ FORCE_COLOR=1 npm start --silent

services/lumberjack/Dockerfile.test

@@ -0,0 +1,28 @@
+ARG BASE=node:8-alpine
+
+FROM ${BASE}
+
+ENV NODE_ENV=test
+
+WORKDIR /test
+
+RUN apk --no-cache add \
+ make \
+ g++ \
+ python-dev
+
+COPY common/nodejs/package.json src/common/
+COPY lumberjack/package.json .
+
+RUN npm install
+
+COPY common/messages/stats.proto \
+ common/messages/telemetry.proto \
+ src/messages/
+
+RUN npm run build-msg
+
+COPY common/nodejs src/common
+COPY lumberjack .
+
+CMD npm run lint && npm test

services/lumberjack/Makefile

@@ -0,0 +1,37 @@
+# Flags for docker when building images, meant to be overridden
+DOCKERFLAGS :=
+
+LUMBERJACK_IMAGE := uavaustin/lumberjack
+LUMBERJACK_TEST_IMAGE := uavaustin/lumberjack-test
+ALPINE_IMAGE := alpine
+INFLUX_IMAGE := influxdb:alpine
+
+current_dir := $(shell pwd)
+
+.PHONY: all
+all: image
+
+.PHONY: image
+image:
+ docker build -t $(LUMBERJACK_IMAGE) -f Dockerfile $(DOCKERFLAGS) ..
+
+.PHONY: test
+test: alpine
+ docker build -t $(LUMBERJACK_TEST_IMAGE) -f Dockerfile.test $(DOCKERFLAGS) ..
+ docker run -it --rm -v $(current_dir)/coverage:/test/coverage \
+ -v /var/run/docker.sock:/var/run/docker.sock $(LUMBERJACK_TEST_IMAGE)
+
+.PHONY: alpine
+alpine:
+ @if ! docker inspect --type=image $(ALPINE_IMAGE) &> /dev/null; then \
+ docker pull $(ALPINE_IMAGE); \
+ fi
+ @if ! docker inspect --type=image $(INFLUX_IMAGE) &> /dev/null; then \
+ docker pull $(INFLUX_IMAGE); \
+ fi
+
+.PHONY: clean
+clean:
+ rm -rf node_modules lib package-lock.json
+ docker rmi -f $(LUMBERJACK_IMAGE)
+ docker rmi -f $(LUMBERJACK_TEST_IMAGE)

services/lumberjack/bin/start-service.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+const Service = require('..');
+
+let service = new Service({
+ influxHost: process.env.INFLUX_HOST,
+ influxPort: process.env.INFLUX_PORT,
+ pingHost: process.env.PING_HOST,
+ pingPort: process.env.PING_PORT,
+ forwardInteropHost: process.env.FORWARD_INTEROP_HOST,
+ forwardInteropPort: process.env.FORWARD_INTEROP_PORT,
+ groundTelemetryHost: process.env.GROUND_TELEMETRY_HOST,
+ groundTelemetryPort: process.env.GROUND_TELEMETRY_PORT,
+ planeTelemetryHost: process.env.PLANE_TELEMETRY_HOST,
+ planeTelemetryPort: process.env.PLANE_TELEMETRY_PORT,
+ uploadInterval: process.env.UPLOAD_INTERVAL,
+ pingInterval: process.env.PING_INTERVAL,
+ telemInterval: process.env.TELEM_INTERVAL,
+ dbName: process.env.DB_NAME
+});
+
+service.start();
+
+process.once('SIGINT', () => service.stop());

services/lumberjack/jest.config.js

@@ -0,0 +1,9 @@
+module.exports = {
+ testEnvironment: 'node',
+ collectCoverage: true,
+ collectCoverageFrom: [
+ 'src/**/*.js',
+ '!src/common/**',
+ '!src/messages.js'
+ ]
+}

services/lumberjack/package.json

@@ -0,0 +1,38 @@
+{
+ "name": "lumberjack",
+ "version": "0.1.0",
+ "main": "lib/service.js",
+ "private": true,
+ "license": "MIT",
+ "scripts": {
+ "start": "node ./bin/start-service",
+ "build": "babel src --out-dir lib",
+ "build-msg": "mkdir -p lib && pbjs -t static-module --es6 --keep-case -o src/messages.js src/messages/*.proto",
+ "test": "jest",
+ "lint": "eslint src test --ignore-pattern src/messages.js"
+ },
+ "dependencies": {
+ "common-nodejs": "file:src/common",
+ "koa": "^2.5.1",
+ "influx": "^5.0.7",
+ "koa-router": "^7.4.0",
+ "koa-protobuf": "^0.1.0",
+ "protobufjs": "~6.8.6",
+ "source-map-support": "^0.5.6",
+ "superagent": "^3.8.3",
+ "superagent-protobuf": "^0.1.0"
+ },
+ "devDependencies": {
+ "babel-cli": "^6.26.0",
+ "babel-plugin-add-module-exports": "^0.2.1",
+ "babel-plugin-source-map-support": "^2.0.1",
+ "babel-preset-env": "^1.6.1",
+ "dockerode": "^2.5.7",
+ "eslint": "^5.3.0",
+ "eslint-plugin-jest": "^21.20.2",
+ "jest": "^23.3.0",
+ "lolex": "^4.0.1",
+ "nock": "^9.6.1",
+ "supertest": "^3.1.0"
+ }
+}

services/lumberjack/src/router.js

@@ -0,0 +1,17 @@
+import koaProtobuf from 'koa-protobuf';
+import Router from 'koa-router';
+
+let router = new Router();
+
+// Encode outbound protobuf messages.
+router.use(koaProtobuf.protobufSender());
+
+router.get('/api/alive', (ctx) => {
+ ctx.body = 'Yo dude, I\'m good.\n';
+});
+
+router.get('/api/clear-data', (ctx) => {
+ ctx.body = ctx.service.clearData();
+});
+
+export default router;