add ECS environment with FireLens support (#28)

bump TypeScript to 3.8
bump lint tooling and fix-lint
Add ECSEnvironment tests
use mocks in the environment detector tests
update docs
npm audit fix
bump package version to 2.0.0

Author: jaredcnance

examples/README.md

@@ -27,4 +27,58 @@ Run the example:
 
 ```
 ./examples/agent/run.sh
-```
+```
+
+## FireLens on ECS
+
+You can deploy the example by running the following:
+
+```sh
+# create an ECR repository for the example image
+aws ecr create-repository --repository-name <image-name> --region <region>
+
+# create an S3 bucket for the Fluent-Bit configuration
+aws s3api create-bucket --bucket <bucket-name> --region <region>
+
+# create ECS cluster
+# create ECS task definition
+# create ECS service
+
+# deploy
+./examples/ecs-firelens/publish.sh \
+  <account-id> \
+  <region> \
+  <image-name> \
+  <s3-bucket> \
+  <ecs-cluster-name> \
+  <ecs-task-family> \
+  <ecs-service-name>
+```
+
+### Example Metrics
+
+```json
+{
+  "_aws": {
+    "Timestamp": 1583902595342,
+    "CloudWatchMetrics": [
+      {
+        "Dimensions": [[ "ServiceName", "ServiceType" ]],
+        "Metrics": [{ "Name": "ProcessingTime", "Unit": "Milliseconds" }],
+        "Namespace": "aws-embedded-metrics"
+      }
+    ]
+  },
+  "ServiceName": "example",
+  "ServiceType": "AWS::ECS::Container",
+  "Method": "GET",
+  "Url": "/test",
+  "containerId": "702e4bcf1345",
+  "createdAt": "2020-03-11T04:54:24.981207801Z",
+  "startedAt": "2020-03-11T04:54:25.594413051Z",
+  "image": "<account-id>.dkr.ecr.<region>.amazonaws.com/emf-examples:latest",
+  "cluster": "emf-example",
+  "taskArn": "arn:aws:ecs:<region>:<account-id>:task/2fe946f6-8a2e-41a4-8fec-c4983bad8f74",
+  "ProcessingTime": 5
+}
+```

examples/ecs-firelens/.gitignore

@@ -0,0 +1 @@
+container-definitions.json

examples/ecs-firelens/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:10.16.0-alpine AS base
+RUN mkdir -p /app/src
+WORKDIR /app/src
+
+COPY package.json ./
+# install packages but copy the local version of the package in directly
+RUN npm i && rm -rf node_modules/aws-embedded-metrics
+COPY node_modules/aws-embedded-metrics ./node_modules/aws-embedded-metrics
+
+# copy the source files over
+COPY . .
+
+CMD [ "node", "app" ]

examples/ecs-firelens/app.js

@@ -0,0 +1,23 @@
+const Koa = require('koa');
+const app = new Koa();
+
+const { metricScope, Unit } = require('aws-embedded-metrics');
+
+app.use(
+  metricScope(metrics => async (ctx, next) => {
+    const start = Date.now();
+
+    await next();
+
+    ctx.body = `Hello World ... ${ctx.method} ${ctx.url}\n`;
+
+    metrics.setProperty('Method', ctx.method);
+    metrics.setProperty('Url', ctx.url);
+    metrics.putMetric('ProcessingTime', Date.now() - start, Unit.Milliseconds);
+
+    // send application logs to stdout, FireLens will send this to a different LogGroup
+    console.log('Completed Request');
+  }),
+);
+
+app.listen(3000);

examples/ecs-firelens/container-definitions.template.json

@@ -0,0 +1,31 @@
+[
+  {
+    "name": "example",
+    "image": "<account-id>.dkr.ecr.<region>.amazonaws.com/<image-name>:latest",
+    "portMappings": [{ "containerPort": 3000, "protocol": "tcp" }],
+    "essential": true,
+    "logConfiguration": {
+      "logDriver": "awsfirelens",
+      "options": {
+        "Name": "cloudwatch",
+        "region": "<region>",
+        "log_group_name": "aws-emf-ecs-firelens-example-logs",
+        "auto_create_group": "true",
+        "log_stream_prefix": "from-fluent-bit"
+      }
+    },
+    "links": ["fluent-bit"]
+  },
+  {
+    "name": "fluent-bit",
+    "image": "906394416424.dkr.ecr.<region>.amazonaws.com/aws-for-fluent-bit:latest",
+    "essential": true,
+    "firelensConfiguration": {
+      "type": "fluentbit",
+      "options": {
+        "config-file-type": "s3",
+        "config-file-value": "arn:aws:s3:::<s3-bucket>/fluent-bit.conf"
+      }
+    }
+  }
+]

examples/ecs-firelens/fluent-bit.conf

@@ -0,0 +1,24 @@
+# TCP input used for EMF payloads
+[INPUT]
+    Name        tcp
+    Listen      0.0.0.0
+    Port        25888
+    Chunk_Size  32
+    Buffer_Size 64
+    Format      none
+    Tag         emf-${HOSTNAME}
+    # This tag is used by the output plugin to determine the LogStream
+    # including the HOSTNAME is a way to increase the number of LogStreams
+    # proportional to the number of instances. The maximum throughput on a
+    # single LogStream is 5 MB/s (max 1 MB at max 5 TPS).
+
+# Output for EMF over TCP -> CloudWatch
+[OUTPUT]
+    Name                cloudwatch
+    Match               emf-*
+    region              us-east-1
+    log_key             log
+    log_group_name      aws-emf-ecs-firelens-example-metrics
+    log_stream_prefix   from-fluent-bit-
+    auto_create_group   true
+    log_format          json/emf