Merge pull request #39 from HyperBrain/support-sls-logs-command

Support sls logs command

Author: HyperBrain

README.md

@@ -84,14 +84,6 @@ aliased lambda is the origin.
 Any other use with the further exception of lambda event subscriptions (see below)
 is strongly discouraged.
 
-## Log groups (not yet finished)
-
-Each alias has its own log group. From my experience with Serverless 0.5 where
-all aliased versions put their logs into the same group, this should be much
-cleaner and the removal of an alias will also remove all logs associated to the alias.
-The log group is named `/serverless/<alias stack name>`. So you can clearly see
-what is deployed through Serverless and what by other means.
-
 ## Resources
 
 Resources are deployed per alias. So you can create new resources without destroying
@@ -202,6 +194,15 @@ In verbose mode (`serverless info -v`) it will additionally print the names
 of the lambda functions deployed to each stage with the version numbers the
 alias points to.
 
+Given an alias with `--alias=XXXX` info will show information for the alias.
+
+## Serverless logs integration
+
+The plugin integrates with the Serverless logs command (all standard options will
+work). Additionally, given an alias with `--alias=XXXX`, logs will show the logs
+for the selected alias. Without the alias option it will show the master alias
+(aka. stage alias).
+
 ## The alias command
 
 ## Subcommands

index.js

@@ -15,6 +15,7 @@ const BbPromise = require('bluebird')
 		, stackInformation = require('./lib/stackInformation')
 		, listAliases = require('./lib/listAliases')
 		, removeAlias = require('./lib/removeAlias')
+		, logs = require('./lib/logs')
 		, collectUserResources = require('./lib/collectUserResources')
 		, uploadAliasArtifacts = require('./lib/uploadAliasArtifacts');
 
@@ -57,6 +58,7 @@ class AwsAlias {
 			createAliasStack,
 			updateAliasStack,
 			listAliases,
+			logs,
 			removeAlias,
 			aliasRestructureStack,
 			stackInformation,
@@ -118,6 +120,15 @@ class AwsAlias {
 			'after:info:info': () => BbPromise.bind(this)
 				.then(this.listAliases),
 
+			// Override the logs command - must be, because the $LATEST filter
+			// in the original logs command is not easy to change without hacks.
+			'before:logs:logs': () => BbPromise.bind(this)
+				.then(this.validate)
+				.then(this.logsValidate)
+				.then(this.logsGetLogStreams)
+				.then(this.logsShowLogs)
+				.then(() => process.exit(0)),	// Bail out to prevent the roiginal logs to be started!
+
 			'alias:remove:remove': () => BbPromise.bind(this)
 				.then(this.validate)
 				.then(this.aliasStackLoadCurrentCFStackAndDependencies)

lib/listAliases.js

@@ -43,15 +43,6 @@ module.exports = {
 		});
 	},
 
-	listDescribeStack(stackName) {
-
-		return this._provider.request('CloudFormation',
-			'describeStackResources',
-			{ StackName: stackName },
-			this._options.stage,
-			this._options.region);
-	},
-
 	listGetApiId(stackName) {
 
 		return this._provider.request('CloudFormation',
@@ -86,18 +77,13 @@ module.exports = {
 
 					if (this._options.verbose) {
 						return BbPromise.join(
-							this.listDescribeStack(`${this._provider.naming.getStackName()}-${aliasName}`),
+							this.aliasGetAliasFunctionVersions(aliasName),
 							this.listDescribeApiStage(apiId, aliasName)
 						)
-						.spread((resources /*, apiStage */) => {
-							const versions = _.filter(resources.StackResources, [ 'ResourceType', 'AWS::Lambda::Version' ]);
-
+						.spread((versions /*, apiStage */) => {
 							console.log(chalk.white('    Functions:'));
 							_.forEach(versions, version => {
-								const functionName = /:function:(.*):/.exec(version.PhysicalResourceId)[1];
-								const functionVersion = _.last(_.split(version.PhysicalResourceId, ':'));
-
-								console.log(chalk.yellow(`      ${functionName} -> ${functionVersion}`));
+								console.log(chalk.yellow(`      ${version.functionName} -> ${version.functionVersion}`));
 
 								// Print deployed endpoints for the function
 								// FIXME: Check why APIG getStage and getDeployment do not return the stage API layout.

lib/logs.js

@@ -0,0 +1,149 @@
+'use strict';
+/**
+ * Log management.
+ */
+
+const BbPromise = require('bluebird');
+const _ = require('lodash');
+const chalk = require('chalk');
+const moment = require('moment');
+const os = require('os');
+
+module.exports = {
+	logsValidate() {
+		// validate function exists in service
+		this._lambdaName = this._serverless.service.getFunction(this.options.function).name;
+
+		this._options.interval = this._options.interval || 1000;
+		this._options.logGroupName = this._provider.naming.getLogGroupName(this._lambdaName);
+
+		return BbPromise.resolve();
+	},
+
+	logsGetLogStreams() {
+		const params = {
+			logGroupName: this._options.logGroupName,
+			descending: true,
+			limit: 50,
+			orderBy: 'LastEventTime',
+		};
+
+		// Get currently deployed function version for the alias to
+		// setup the stream filter correctly
+		return this.aliasGetAliasFunctionVersions(this._alias)
+		.then(versions => {
+			return _.map(
+				_.filter(versions, [ 'functionName', this._lambdaName ]),
+				version => version.functionVersion);
+		})
+		.then(version => {
+			return this.provider
+				.request('CloudWatchLogs',
+					'describeLogStreams',
+					params,
+					this.options.stage,
+					this.options.region)
+				.then(reply => {
+					if (!reply || _.isEmpty(reply.logStreams)) {
+						throw new this.serverless.classes
+							.Error('No existing streams for the function alias');
+					}
+
+					return _.map(
+						_.filter(reply.logStreams, stream => _.includes(stream.logStreamName, `[${version}]`)),
+						stream => stream.logStreamName);
+				});
+		});
+
+	},
+
+	logsShowLogs(logStreamNames) {
+		if (!logStreamNames || !logStreamNames.length) {
+			if (this.options.tail) {
+				return setTimeout((() => this.getLogStreams()
+					.then(nextLogStreamNames => this.showLogs(nextLogStreamNames))),
+					this.options.interval);
+			}
+		}
+
+		const formatLambdaLogEvent = (msgParam) => {
+			let msg = msgParam;
+			const dateFormat = 'YYYY-MM-DD HH:mm:ss.SSS (Z)';
+
+			if (_.startsWith(msg, 'REPORT')) {
+				msg += os.EOL;
+			}
+
+			if (_.startsWith(msg, 'START') || _.startsWith(msg, 'END') || _.startsWith(msg, 'REPORT')) {
+				return chalk.gray(msg);
+			} else if (_.trim(msg) === 'Process exited before completing request') {
+				return chalk.red(msg);
+			}
+
+			const splitted = _.split(msg, '\t');
+
+			if (splitted.length < 3 || new Date(splitted[0]) === 'Invalid Date') {
+				return msg;
+			}
+			const reqId = splitted[1];
+			const time = chalk.green(moment(splitted[0]).format(dateFormat));
+			const text = _.split(msg, `${reqId}\t`)[1];
+
+			return `${time}\t${chalk.yellow(reqId)}\t${text}`;
+		};
+
+		const params = {
+			logGroupName: this.options.logGroupName,
+			interleaved: true,
+			logStreamNames,
+			startTime: this.options.startTime,
+		};
+
+		if (this.options.filter) params.filterPattern = this.options.filter;
+		if (this.options.nextToken) params.nextToken = this.options.nextToken;
+		if (this.options.startTime) {
+			const since = _.includes(['m', 'h', 'd'],
+				this.options.startTime[this.options.startTime.length - 1]);
+			if (since) {
+				params.startTime = moment().subtract(
+					_.replace(this.options.startTime, /\D/g, ''),
+					_.replace(this.options.startTime, /\d/g, '')).valueOf();
+			} else {
+				params.startTime = moment.utc(this.options.startTime).valueOf();
+			}
+		}
+
+		return this.provider
+			.request('CloudWatchLogs',
+				'filterLogEvents',
+				params,
+				this.options.stage,
+				this.options.region)
+			.then(results => {
+				if (results.events) {
+					_.forEach(results.events, e => {
+						process.stdout.write(formatLambdaLogEvent(e.message));
+					});
+				}
+
+				if (results.nextToken) {
+					this.options.nextToken = results.nextToken;
+				} else {
+					delete this.options.nextToken;
+				}
+
+				if (this.options.tail) {
+					if (results.events && results.events.length) {
+						this.options.startTime = _.last(results.events).timestamp + 1;
+					}
+
+					return setTimeout((() => this.getLogStreams()
+							.then(nextLogStreamNames => this.showLogs(nextLogStreamNames))),
+						this.options.interval);
+				}
+
+				return BbPromise.resolve();
+			});
+	},
+
+};

lib/stackInformation.js

@@ -128,7 +128,6 @@ module.exports = {
 	},
 
 	aliasStackLoadCurrentCFStackAndDependencies() {
-
 		return BbPromise.join(
 			BbPromise.bind(this).then(this.aliasStackLoadCurrentTemplate),
 			BbPromise.bind(this).then(this.aliasStackLoadAliasTemplates)
@@ -148,4 +147,24 @@ module.exports = {
 		});
 	},
 
+	aliasDescribeAliasStack(aliasName) {
+		const stackName = `${this._provider.naming.getStackName()}-${aliasName}`;
+		return this._provider.request('CloudFormation',
+			'describeStackResources',
+			{ StackName: stackName },
+			this._options.stage,
+			this._options.region);
+	},
+
+	aliasGetAliasFunctionVersions(aliasName) {
+		return this.aliasDescribeAliasStack(aliasName)
+		.then(resources => {
+			const versions = _.filter(resources.StackResources, [ 'ResourceType', 'AWS::Lambda::Version' ]);
+			return _.map(versions, version => ({
+				functionName: /:function:(.*):/.exec(version.PhysicalResourceId)[1],
+				functionVersion: _.last(_.split(version.PhysicalResourceId, ':'))
+			}));
+		});
+	},
+
 };

package.json

@@ -30,6 +30,8 @@
     "bluebird": "^3.4.7",
     "chalk": "^1.1.3",
     "lodash": "^4.17.4",
+    "moment": "^2.18.1",
+    "os": "^0.1.1",
     "semver": "^5.3.0"
   },
   "devDependencies": {
@@ -43,9 +45,9 @@
     "eslint-plugin-promise": "^3.4.0",
     "get-installed-path": "^2.0.3",
     "istanbul": "^0.4.5",
-    "mocha": "^3.3.0",
-    "serverless": "^1.12.1",
-    "sinon": "^2.2.0",
+    "mocha": "^3.4.1",
+    "serverless": "^1.13.2",
+    "sinon": "^2.3.1",
     "sinon-chai": "^2.10.0"
   }
 }