Merge branch 'develop' v0.2.0

Author: atoa

CHANGELOG.md

@@ -6,9 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2021-09-03
+### Fixed
+- Changed metric namespace to include bot locale
+- Added bot and locale ID filters to CloudWatch Insight rules/queries
+- Fixed handling of ReadyForFullfilment state and empty data in conversation
+  path widget
+### Removed
+- Removed session count value from Activity section due to exceptions if the
+  selected time range is larger than 24 hours
+
 ## [0.1.0] - 2021-08-26
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/aws-samples/aws-lex-v2-bot-analytics/compare/v0.1.0...develop
+[Unreleased]: https://github.com/aws-samples/aws-lex-v2-bot-analytics/compare/v0.2.0...develop
+[0.2.0]: https://github.com/aws-samples/aws-lex-v2-bot-analytics/releases/tag/v0.2.0
 [0.1.0]: https://github.com/aws-samples/aws-lex-v2-bot-analytics/releases/tag/v0.1.0

Makefile

@@ -62,7 +62,7 @@ PYTHON_TARGET_REQUIREMENTS := $(patsubst \
 $(PYTHON_TARGET_REQUIREMENTS): $(OUT_DIR)/%: $(PYTHON_REQUIREMENTS_DIR)/% | $(OUT_DIR) $(VENV_CFG)
 	@echo "[INFO] Installing python dependencies file: [$(^)]"
 	@source '$(VIRTUALENV_BIN_DIR)/activate' && \
-		pip install -r $(^) | tee $(@)
+		pip install -U -r $(^) | tee $(@)
 install-python-requirements: $(PYTHON_TARGET_REQUIREMENTS)
 .PHONY: install-python-requirements
 

README.md

@@ -10,11 +10,12 @@ visualize the performance and operational metrics of your
 It provides a dashboard that you can use to continuously analyze and improve the
 experience of end-users interacting with your chatbot.
 
-This solution implements metrics and visualizations that helps you identify
-chatbot performance, trends and engagement insights. The solution extracts
+This solution implements metrics and visualizations that help you identify
+chatbot performance, trends and engagement insights. This is done by extracting
 operational data from your Lex V2 chatbot
 [conversation logs](https://docs.aws.amazon.com/lexv2/latest/dg/monitoring-logs.html).
-It presents a unified view of how users are interacting with your chatbot in an
+The solution presents a unified view of how users are interacting with your
+chatbot in an
 [Amazon CloudWatch dashboard](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html).
 
 Features include:
@@ -35,11 +36,11 @@ Features include:
 
 ### Architecture
 
-The solution architecture includes the following AWS Services:
+The solution architecture leverages the following AWS Services and features:
 
-- **CloudWatch Logs** containing your chatbot conversation logs
+- **CloudWatch Logs** to store your chatbot conversation logs
 - **CloudWatch Metric Filters** to create custom metrics from conversation logs
-- **CloudWatch Insights** to query the conversation logs and to create powerful
+- **CloudWatch Log Insights** to query the conversation logs and to create powerful
   aggregations from the log data
 - **CloudWatch Contributor Insights** to identify top contributors and
   outliers in higly variable data such as sessions and utterances
@@ -144,6 +145,25 @@ stack name and bot information (name, ID, locale).
 **NOTE:** You may need to wait a few minutes for data to be reflected in the
 dashboard.
 
+## Update Using SAR
+
+After you've deployed the dashboard from SAR, you may need to update it.
+For example, you may need to change an application setting, or you may want
+to update the application to the latest version that was published.
+
+You can use the same
+[link](https://console.aws.amazon.com/lambda/home#/create/app?applicationId=arn:aws:serverlessrepo:us-east-1:777566285978:applications/lexv2-analytics)
+used to deploy the stack to perform updates. Use the same procedure as
+deploying the application, and provide the same **Application name** that you
+originally used to deploy it.
+
+*NOTE:* SAR prepends `serverlessrepro-` to your stack name. However, to deploy a
+new version of your application, you should provide the original application
+name without the `serverlessrepo-` prefix.
+
+See the [SAR Updating Applications](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/serverlessrepo-how-to-consume-new-version.html)
+documentation for details.
+
 ## Deploy Using SAM
 
 In addition to deploying the project using SAR as shown in the
@@ -233,6 +253,10 @@ Here are more details about the general SAM parameters:
 
 - Pie and bar charts in the dashboard may show not show accurate data for the
   selected time range. We are currently investigating this issue
+- Metrics using CloudWatch Contributor Insights are limited to a 24 hour window
+  within the selected time range. The CloudWatch Contributor Insights feature
+  allows a maximum time range for the report is 24 hours, but you can choose a
+  24-hour window that occurred up to 15 days ago.
 
 ## Development
 

VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

requirements/requirements-dev.txt

@@ -1,7 +1,7 @@
 # development dependencies
 pip~=21.2.4
 black~=21.7b0
-cfn-lint~=0.53.0
+cfn-lint~=0.53.1
 flake8~=3.9.2
 pylint~=2.9.6
 yamllint~=1.26.2

src/lambda_functions/cw_custom_widget_nodejs/widgets/conversationPath.js

@@ -130,6 +130,9 @@ function displaySankey({ data, widgetContext } = {}) {
 function displayConversationPath({ widgetContext, queryResults }) {
   // flatten CloudWatch Insights results into objects
   const results = queryResults.map((x) => x.reduce((a, c) => ({ [c.field]: c.value, ...a }), {}));
+  if (!results?.length) {
+    return '<pre class="error">No data found</pre>';
+  }
   const nodes = [
     ...new Set(results.map((x) => x['@intentName'])),
     // add artificial start intent to have a single entry point