Merge pull request #287 from ASFHyP3/develop

Release: v0.7.5

.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: Changelog updated?
+on:
+  pull_request:
+    types:
+      - opened
+      - labeled
+      - unlabeled
+      - synchronize
+    branches:
+      - master
+      - develop
+jobs:
+  changelog-udated:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Changelog check
+        uses: Zomzog/[email protected]
+        with:
+          fileName: CHANGELOG.md
+          noChangelogLabel: bumpless
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+
+## [0.7.5]
+### Added
+- Api and processing errors will now post to a SNS topic
+
+### Changed
+* Parameters for `INSAR_GAMMA` jobs have been updated to reflect hyp3-insar-gamma [v2.2.0](https://github.com/ASFHyP3/hyp3-insar-gamma/blob/develop/CHANGELOG.md#220).
+
 ## [0.7.4]
 ### Changed
 - API behavior for different job types is now defined exclusively in `job_types.yml`.  Available parameter types must still be defined in `apps/api/src/hyp3_api/api-sec/job_parameters.yml.j2`, and available validation rules must still be defined in `apps/api/src/hyp3_api/validation.py`.

apps/api/api-cf.yml

@@ -26,6 +26,9 @@ Outputs:
   Url:
     Value: !Sub "https://${CustomDomainName}/ui"
 
+  ApiId:
+    Value: !Ref Api
+
 Resources:
 
   Api:

apps/api/src/hyp3_api/api-spec/job_parameters.yml.j2

@@ -95,6 +95,11 @@ components:
       default: false
       type: boolean
 
+    include_look_vectors:
+      description: Include the look vector theta and phi files in the product package
+      default: false
+      type: boolean
+
     looks:
       description: Number of looks to take in range and azimuth
       type: string

apps/main-cf.yml

@@ -101,6 +101,14 @@ Resources:
         ImageTag: !Ref ImageTag
       TemplateURL: workflow-cf.yml
 
+  Monitoring:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      Parameters:
+        StepFunctionArn: !GetAtt StepFunction.Outputs.StepFunctionArn
+        ApiId: !GetAtt Api.Outputs.ApiId
+      TemplateURL: monitoring-cf.yml
+
   LogBucket:
     Type: AWS::S3::Bucket
     Properties:

apps/monitoring-cf.yml

@@ -0,0 +1,50 @@
+AWSTemplateFormatVersion: 2010-09-09
+
+Parameters:
+  StepFunctionArn:
+    Type: String
+
+  ApiId:
+    Type: String
+
+Resources:
+
+  AlarmTopic:
+    Type: AWS::SNS::Topic
+
+  StepFunctionAlarm:
+    Type: AWS::CloudWatch::Alarm
+    Properties:
+      AlarmActions:
+        - !Ref AlarmTopic
+      AlarmDescription: Hyp3 processing failures
+      ComparisonOperator: GreaterThanThreshold
+      Period: 60
+      EvaluationPeriods: 1
+      Threshold: 0
+      Dimensions:
+        - Name: StateMachineArn
+          Value: !Ref StepFunctionArn
+      MetricName: ExecutionsFailed
+      Namespace: AWS/States
+      Statistic: Sum
+      Unit: Count
+      TreatMissingData: notBreaching
+
+  ApiAlarm:
+    Type: AWS::CloudWatch::Alarm
+    Properties:
+      AlarmActions:
+        - !Ref AlarmTopic
+      AlarmDescription: Hyp3 api HTTP 500 errors
+      ComparisonOperator: GreaterThanThreshold
+      Period: 60
+      EvaluationPeriods: 1
+      Threshold: 0
+      Dimensions:
+        - Name: ApiId
+          Value: !Ref ApiId
+      MetricName: 5xx
+      Namespace: AWS/ApiGateway
+      Statistic: Sum
+      TreatMissingData: notBreaching

apps/workflow-cf.yml.j2

@@ -24,6 +24,10 @@ Parameters:
   TaskRoleArn:
     Type: String
 
+Outputs:
+  StepFunctionArn:
+    Value: !Ref StepFunction
+
 Resources:
   {% for job_type, job_spec in  job_types.items() %}
   {{ job_type }}:

job_types.yml

@@ -30,7 +30,6 @@ RtcGamma:
       api_schema_location: "#/components/schemas/include_inc_map"
   required_parameters:
     - granules
-
   command:
     - ++entrypoint
     - hyp3_rtc_gamma_v2
@@ -70,9 +69,9 @@ InsarGamma:
       api_schema_location: "#/components/schemas/insar_granules"
     bucket_prefix:
       default:  '""'
-    include_inc_map:
+    include_look_vectors:
       default:  false
-      api_schema_location: "#/components/schemas/include_inc_map"
+      api_schema_location: "#/components/schemas/include_look_vectors"
     include_los_displacement:
       default:  false
       api_schema_location: "#/components/schemas/los_displacement"
@@ -82,8 +81,6 @@ InsarGamma:
   required_parameters:
     - granules
   command:
-    - ++entrypoint
-    - hyp3_insar_gamma_v2
     - --username
     - '!Ref EDLUsername'
     - --password
@@ -92,8 +89,8 @@ InsarGamma:
     - '!Ref Bucket'
     - --bucket-prefix
     - Ref::bucket_prefix
-    - --include-inc-map
-    - Ref::include_inc_map
+    - --include-look-vectors
+    - Ref::include_look_vectors
     - --include-los-displacement
     - Ref::include_los_displacement
     - --looks