Updates aggregation/explore to fit user settings

User settings must be loaded before the sketch to transmit the new parameter to POST /sketches/{id}/aggregation/explore/.
google · Feb 5, 2025 · 91be24c · 91be24c
1 parent 9495773
commit 91be24c
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 13 deletions.
diff --git a/timesketch/api/v1/resources/aggregation.py b/timesketch/api/v1/resources/aggregation.py
@@ -465,10 +465,15 @@ def post(self, sketch_id):
                 "Not able to run aggregation on an archived sketch.",
             )
 
+        include_processing_timelines = form.include_processing_timelines.data
+        allowed_statuses = ["ready"]
+        if include_processing_timelines:
+            allowed_statuses.append("processing")
+
         sketch_indices = {
             t.searchindex.index_name
             for t in sketch.timelines
-            if t.get_status.status.lower() in ["ready", "processing"]
+            if t.get_status.status.lower() in allowed_statuses
         }
 
         aggregation_dsl = form.aggregation_dsl.data
@@ -492,7 +497,9 @@ def post(self, sketch_id):
                 aggregator_parameters = {}
 
             indices = aggregator_parameters.pop("index", sketch_indices)
-            indices, timeline_ids = lib_utils.get_validated_indices(indices, sketch)
+            indices, timeline_ids = lib_utils.get_validated_indices(
+                indices, sketch, form.include_processing_timelines.data
+            )
 
             if not (indices or timeline_ids):
                 abort(HTTP_STATUS_CODE_BAD_REQUEST, "No indices to aggregate on")

diff --git a/timesketch/frontend-ng/src/components/Explore/AggregateDialog.vue b/timesketch/frontend-ng/src/components/Explore/AggregateDialog.vue
@@ -556,7 +556,8 @@ export default {
         aggregator_parameters: {
           field: this.eventKey,
           field_query_string: this.eventValue
-        }
+        },
+        include_processing_timelines: !!this.settings.showProcessingTimelineEvents,
       }).then((response) => {
         this.stats = response.data.objects[0].field_summary.buckets[0]
         this.statsReady = true
@@ -570,7 +571,8 @@ export default {
         aggregator_parameters: {
           field: this.eventKey,
           date_interval: this.selectedDistributionInterval
-        }
+        },
+        include_processing_timelines: !!this.settings.showProcessingTimelineEvents,
       }).then((response) => {
         this.eventDistributionData = response.data.objects[0].datefield_summary.buckets[0]
         this.eventDistributionReady = true
@@ -624,7 +626,8 @@ export default {
           supported_intervals: supportedIntervals,
           start_time: startTime.toISOString().slice(0, -1),
           end_time: endTime.toISOString().slice(0, -1),
-        }
+        },
+        include_processing_timelines: !!this.settings.showProcessingTimelineEvents,
       }).then((response) => {
         this.data = response.data.objects[0].date_histogram.buckets[0]
         this.recentHistogramSeries = [{

diff --git a/timesketch/frontend-ng/src/components/Visualization/SavedVisualization.vue b/timesketch/frontend-ng/src/components/Visualization/SavedVisualization.vue
@@ -15,9 +15,9 @@ limitations under the License.
 -->
 <template>
   <v-card class="mx-3" outlined>
-    <ts-chart-card 
+    <ts-chart-card
       v-if="aggregationId"
-        :chartSeries="chartSeries" 
+        :chartSeries="chartSeries"
         :chartLabels="chartLabels"
         :chartTitle="chartTitle"
         :chartType="chartType"
@@ -70,6 +70,9 @@ export default {
     sketch() {
       return this.$store.state.sketch
     },
+    settings() {
+      return this.$store.state.settings
+    },
   },
   methods: {
     loadAggregationData(savedAggregationId) {
@@ -80,7 +83,8 @@ export default {
           const agg = response.data.objects[0]
           this.aggregationType = agg.agg_type
           this.parameters = JSON.parse(agg.parameters)
-
+          this.parameters['include_processing_timelines'] = !!this.settings.showProcessingTimelineEvents
+
           ApiClient.runAggregator(
             this.sketch.id, this.parameters
           ).then(
@@ -112,7 +116,7 @@ export default {
           console.error('Error requesting aggregation parameters: ' + e)
         }
       )
-    }, 
+    },
   },
   watch: {
     aggregationId: function (newAggregationId) {

diff --git a/timesketch/frontend-ng/src/components/Visualization/VisualizationEditor.vue b/timesketch/frontend-ng/src/components/Visualization/VisualizationEditor.vue
@@ -314,6 +314,9 @@ export default {
       }
       return undefined
     },
+    settings() {
+      return this.$store.state.settings
+    },
   },
   methods: {
     rename() {
@@ -438,7 +441,8 @@ export default {
             xTitle: this.selectedXTitle,
             yTitle: this.selectedYTitle,
           },
-        }
+        },
+        include_processing_timelines: !!this.settings.showProcessingTimelineEvents,
       }
     },
     loadAggregationData() {

diff --git a/timesketch/frontend-ng/src/store.js b/timesketch/frontend-ng/src/store.js
@@ -265,6 +265,7 @@ export default new Vuex.Store({
           field: 'tag',
           limit: '1000',
         },
+        include_processing_timelines: !!state.settings.showProcessingTimelineEvents,
       }
       return ApiClient.runAggregator(payload.sketchId, formData)
         .then((response) => {
@@ -292,6 +293,7 @@ export default new Vuex.Store({
           field: 'data_type',
           limit: '1000',
         },
+        include_processing_timelines: !!state.settings.showProcessingTimelineEvents,
       }
       return ApiClient.runAggregator(sketchId, formData)
         .then((response) => {

diff --git a/timesketch/frontend-ng/src/views/Sketch.vue b/timesketch/frontend-ng/src/views/Sketch.vue
@@ -417,15 +417,15 @@ export default {
   mounted() {
     this.loadingSketch = true
     this.showLeftPanel = false
-    this.$store.dispatch('updateSketch', this.sketchId).then(() => {
+    this.$store.dispatch('updateUserSettings').then(() =>
+      this.$store.dispatch('updateSketch', this.sketchId)).then(() => {
       this.$store.dispatch('updateSearchHistory', this.sketchId)
       this.$store.dispatch('updateScenarioTemplates', this.sketchId)
       this.$store.dispatch('updateSavedGraphs', this.sketchId)
       this.$store.dispatch('updateGraphPlugins')
       this.$store.dispatch('updateContextLinks')
       this.$store.dispatch('updateAnalyzerList', this.sketchId)
-      this.$store.dispatch('updateSystemSettings')
-      this.$store.dispatch('updateUserSettings').then(() => {
+      this.$store.dispatch('updateSystemSettings').then(() => {
         if (this.userSettings.showLeftPanel) {
           this.toggleDrawer()
         }

diff --git a/timesketch/lib/forms.py b/timesketch/lib/forms.py
@@ -223,6 +223,9 @@ class AggregationExploreForm(BaseForm):
     aggregator_parameters = StringField(
         "Aggregator Parameters", validators=[Optional()]
     )
+    include_processing_timelines = BooleanField(
+        "Include processing timelines", validators=[Optional()], default=False
+    )
 
 
 class AggregationLegacyForm(ExploreForm):