feat: modal implementation for data ingestion table

docs/dashboard.md

@@ -435,3 +435,7 @@ e.g. of globalConfig.json:
 
 the above configuration will create the following filter query:
 `...source=*license_usage.log type=Usage (st IN ("*addon123*","my_custom_condition*"))...`
+
+> Note:
+
+> - In the Data Ingestion table, the first column displays the `View by` options list. When you click on any row in this column, a modal opens, showing detailed information such as `Data volume` and the `Number of events` over time, visualized in charts. The modal allows you to adjust the options via a dropdown to view data for different View by options. This enables dynamic exploration of data trends for various selected inputs.

splunk_add_on_ucc_framework/dashboard.py

@@ -47,6 +47,7 @@
     "data_ingestion_tab": "data_ingestion_tab_definition.json",
     "errors_tab": "errors_tab_definition.json",
     "resources_tab": "resources_tab_definition.json",
+    "data_ingestion_modal_definition": "data_ingestion_modal_definition.json",
 }
 
 data_ingestion = (
@@ -242,6 +243,21 @@ def generate_dashboard_content(
             )
         )
 
+    if (
+        definition_json_name
+        == default_definition_json_filename["data_ingestion_modal_definition"]
+    ):
+        content = (
+            utils.get_j2_env()
+            .get_template(definition_json_name)
+            .render(
+                data_ingestion=data_ingestion.format(
+                    lic_usg_condition=lic_usg_condition, determine_by=determine_by
+                ),
+                events_count=events_count.format(addon_name=addon_name.lower()),
+            )
+        )
+
     return content
 
 

splunk_add_on_ucc_framework/templates/data_ingestion_modal_definition.json

@@ -0,0 +1,150 @@
+{
+  "visualizations": {
+    "data_ingestion_modal_timerange_label_start_viz": {
+      "type": "splunk.singlevalue",
+      "options": {
+        "majorFontSize": 12,
+        "backgroundColor": "transparent",
+        "majorColor": "#9fa4af"
+      },
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_time_label_start_ds"
+      }
+    },
+    "data_ingestion_modal_timerange_label_end_viz": {
+      "type": "splunk.singlevalue",
+      "options": {
+        "majorFontSize": 12,
+        "backgroundColor": "transparent",
+        "majorColor": "#9fa4af"
+      },
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_time_label_end_ds"
+      }
+    },
+    "data_ingestion_modal_data_volume_viz": {
+      "type": "splunk.line",
+      "options": {
+        "xAxisVisibility": "hide",
+        "seriesColors": ["#A870EF"],
+        "yAxisTitleText": "Volume (bytes)",
+        "xAxisTitleText": "Time"
+      },
+      "title": "Data volume",
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_volume_ds"
+      }
+    },
+    "data_ingestion_modal_events_count_viz": {
+      "type": "splunk.line",
+      "options": {
+        "xAxisVisibility": "hide",
+        "xAxisTitleText": "Time",
+        "seriesColors": [
+          "#A870EF"
+        ],
+        "yAxisTitleText": "Number of events"
+      },
+      "title": "Number of events",
+      "dataSources": {
+        "primary": "ds_search_1"
+      }
+    }
+  },
+  "dataSources": {
+    "data_ingestion_modal_data_time_label_start_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "| makeresults | addinfo | eval StartDate = strftime(info_min_time, \"%e %b %Y %I:%M%p\") | table StartDate",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "data_ingestion_modal_data_time_label_end_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "| makeresults | addinfo | eval EndDate = strftime(info_max_time, \"%e %b %Y %I:%M%p\") | table EndDate",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "data_ingestion_modal_data_volume_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "{{data_ingestion}}",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "ds_search_1": {
+      "type": "ds.search",
+      "options": {
+        "query": "{{events_count}}",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      },
+      "name": "Security Score vs Spend"
+    }
+  },
+  "defaults": {},
+  "inputs": {
+    "data_ingestion_modal_time_window": {
+      "options": {
+        "defaultValue": "-24h,now",
+        "token": "data_ingestion_modal_time"
+      },
+      "title": "Time Window",
+      "type": "input.timerange"
+    }
+  },
+  "layout": {
+    "type": "grid",
+    "globalInputs": ["data_ingestion_modal_time_window"],
+    "structure": [
+      {
+        "item": "data_ingestion_modal_timerange_label_start_viz",
+        "position": {
+          "x": 0,
+          "y": 50,
+          "w": 100,
+          "h": 20
+        }
+      },
+      {
+        "item": "data_ingestion_modal_timerange_label_end_viz",
+        "position": {
+          "x": 100,
+          "y": 50,
+          "w": 100,
+          "h": 20
+        }
+      },
+      {
+        "item": "data_ingestion_modal_data_volume_viz",
+        "position": {
+          "x": 0,
+          "y": 80,
+          "w": 300,
+          "h": 400
+        }
+      },
+      {
+        "item": "data_ingestion_modal_events_count_viz",
+        "position": {
+          "x": 0,
+          "y": 500,
+          "w": 300,
+          "h": 400
+        }
+      }
+    ]
+  }
+}

splunk_add_on_ucc_framework/templates/data_ingestion_tab_definition.json

@@ -103,7 +103,12 @@
           }
         },
         "count": 10
-      }
+      },
+      "eventHandlers": [
+        {
+          "type": "table.click.handler"
+        }
+      ]
     }
   },
   "dataSources": {

tests/testdata/expected_addons/expected_files_conflict_test/expected_log.json

@@ -27,6 +27,7 @@
   "appserver/static/js/build/globalConfig.json                                     created\u001b[0m": "INFO",
   "appserver/static/openapi.json                                                   created\u001b[0m": "INFO",
   "metadata/default.meta                                                           created\u001b[0m": "INFO",
+  "appserver/static/js/build/custom/data_ingestion_modal_definition.json           created\u001b[0m": "INFO",
   "appserver/static/js/build/custom/data_ingestion_tab_definition.json             created\u001b[0m": "INFO",
   "appserver/static/js/build/custom/errors_tab_definition.json                     created\u001b[0m": "INFO",
   "appserver/static/js/build/custom/overview_definition.json                       created\u001b[0m": "INFO",

tests/unit/expected_results/data_ingestion_modal_definition.json

@@ -0,0 +1,150 @@
+{
+  "visualizations": {
+    "data_ingestion_modal_timerange_label_start_viz": {
+      "type": "splunk.singlevalue",
+      "options": {
+        "majorFontSize": 12,
+        "backgroundColor": "transparent",
+        "majorColor": "#9fa4af"
+      },
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_time_label_start_ds"
+      }
+    },
+    "data_ingestion_modal_timerange_label_end_viz": {
+      "type": "splunk.singlevalue",
+      "options": {
+        "majorFontSize": 12,
+        "backgroundColor": "transparent",
+        "majorColor": "#9fa4af"
+      },
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_time_label_end_ds"
+      }
+    },
+    "data_ingestion_modal_data_volume_viz": {
+      "type": "splunk.line",
+      "options": {
+        "xAxisVisibility": "hide",
+        "seriesColors": ["#A870EF"],
+        "yAxisTitleText": "Volume (bytes)",
+        "xAxisTitleText": "Time"
+      },
+      "title": "Data volume",
+      "dataSources": {
+        "primary": "data_ingestion_modal_data_volume_ds"
+      }
+    },
+    "data_ingestion_modal_events_count_viz": {
+      "type": "splunk.line",
+      "options": {
+        "xAxisVisibility": "hide",
+        "xAxisTitleText": "Time",
+        "seriesColors": [
+          "#A870EF"
+        ],
+        "yAxisTitleText": "Number of events"
+      },
+      "title": "Number of events",
+      "dataSources": {
+        "primary": "ds_search_1"
+      }
+    }
+  },
+  "dataSources": {
+    "data_ingestion_modal_data_time_label_start_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "| makeresults | addinfo | eval StartDate = strftime(info_min_time, \"%e %b %Y %I:%M%p\") | table StartDate",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "data_ingestion_modal_data_time_label_end_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "| makeresults | addinfo | eval EndDate = strftime(info_max_time, \"%e %b %Y %I:%M%p\") | table EndDate",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "data_ingestion_modal_data_volume_ds": {
+      "type": "ds.search",
+      "options": {
+        "query": "{{data_ingestion}}",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      }
+    },
+    "ds_search_1": {
+      "type": "ds.search",
+      "options": {
+        "query": "{{events_count}}",
+        "queryParameters": {
+          "earliest": "$data_ingestion_modal_time.earliest$",
+          "latest": "$data_ingestion_modal_time.latest$"
+        }
+      },
+      "name": "Security Score vs Spend"
+    }
+  },
+  "defaults": {},
+  "inputs": {
+    "data_ingestion_modal_time_window": {
+      "options": {
+        "defaultValue": "-24h,now",
+        "token": "data_ingestion_modal_time"
+      },
+      "title": "Time Window",
+      "type": "input.timerange"
+    }
+  },
+  "layout": {
+    "type": "grid",
+    "globalInputs": ["data_ingestion_modal_time_window"],
+    "structure": [
+      {
+        "item": "data_ingestion_modal_timerange_label_start_viz",
+        "position": {
+          "x": 0,
+          "y": 50,
+          "w": 100,
+          "h": 20
+        }
+      },
+      {
+        "item": "data_ingestion_modal_timerange_label_end_viz",
+        "position": {
+          "x": 100,
+          "y": 50,
+          "w": 100,
+          "h": 20
+        }
+      },
+      {
+        "item": "data_ingestion_modal_data_volume_viz",
+        "position": {
+          "x": 0,
+          "y": 80,
+          "w": 300,
+          "h": 400
+        }
+      },
+      {
+        "item": "data_ingestion_modal_events_count_viz",
+        "position": {
+          "x": 0,
+          "y": 500,
+          "w": 300,
+          "h": 400
+        }
+      }
+    ]
+  }
+}

tests/unit/expected_results/data_ingestion_tab_definition.json

@@ -103,7 +103,12 @@
           }
         },
         "count": 10
-      }
+      },
+      "eventHandlers": [
+        {
+          "type": "table.click.handler"
+        }
+      ]
     }
   },
   "dataSources": {