Merge pull request #146 from f5devcentral/development

clhain · web-flow · commit ebe28246bc3b · 2025-03-06T15:18:30.000-08:00
Release v0.9.1
diff --git a/COLLECTOR_VERSION b/COLLECTOR_VERSION
@@ -1 +1 @@
-v0.9.0
+v0.9.1
diff --git a/README.md b/README.md
@@ -295,6 +295,15 @@ f5_plane_cpu_utilization_5s{}
 
 This will impact data output in several dashboards/panels (denoted with description fields indicating as such).
 
+You can disable attempts to collect bash information with `enable_bash_collection: false` at the appropriate level (global or device).
+
+```yaml
+bigip/1:
+  endpoint: https://10.0.0.1
+  enable_bash_collection: false
+  #...
+```
+
 ### Configure CA File
 AST expects a valid TLS cert bundle unless `tls.insecure_skip_verify` is
 set to true for each device. In order to mount and use your CA file, you must
@@ -361,7 +370,7 @@ special instructions / breaking changes.
 git stash
 git fetch --tags
 git pull origin main
-git checkout tags/RELEASE_VERSION #(e.g. tags/v0.9.0)
+git checkout tags/RELEASE_VERSION #(e.g. tags/v0.9.1)
 git stash pop
 # <merge any conflicts with your local changes>
 # <re-run config scripts>
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -27,7 +27,7 @@ services:
       - 7lc_network
 
   otel-collector:
-    image: ghcr.io/f5devcentral/application-study-tool/otel_custom_collector:v0.9.0
+    image: ghcr.io/f5devcentral/application-study-tool/otel_custom_collector:v0.9.1
     restart: unless-stopped
     volumes:
       - ./services/otel_collector:/etc/otel-collector-config
diff --git a/pages/components/grafana/grafana.md b/pages/components/grafana/grafana.md
@@ -57,4 +57,25 @@ JSON following these
 [instructions](https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/#export-a-dashboard-as-json).
 
 You can save dashboard files under /services/grafana/provisioning/dashboards from the project root to
-automatically load them when the container is started.
+automatically load them when the container is started.
+
+### Import AST Dashboards into Your Own Grafana Instance
+If you have your own (non-AST) Grafana instance and would like to display AST dashboards from your instance, follow these steps:
+
+#### Connect your Grafana instance to the AST Prometheus instance.
+- In the menu bar on the left, click Connections >> Data sources. 
+- If this is a new instance of Grafana, the “Add data source” button will appear in the middle of the screen. If this is an existing instance with pre-existing data sources, the button will be in the upper-right corner of the screen and will say “Add new data source”. Either way, click on it.
+- Select Prometheus from the list of data sources. You may have to scroll down or enter “prometheus” in the search bar. 
+- Fill in a name (for example, “ast-prometheus”), and the URL/IP address to get to the Prometheus instance. (Unless the port for the AST instance of Prometheus was modified, it will be the default of 9090.) 
+- The “Interval behaviour >> Scrape interval” is set to 15s by default. This will work but, if you want to save connections, you can set it to 60s. 
+- Click the blue "Save & test" button and ensure you get the message, “Successfully queried the Prometheus API.” at the bottom of the screen. 
+
+#### Import the Dashboard Configuration
+- Click on “Dashboards” in the menu on the left. 
+- Click the blue “New” button in the upper-right and, from the drop-down, select "Import". 
+- If you have saved the dashboard you wish to import as a JSON file export, click on "Upload dashboard JSON file" and upload the JSON file you exported. If you just copied the JSON contents, you can paste it in the "Import via dashboard JSON model" box below.
+- Give the dashboard a name (under Name). 
+- Under the Prometheus drop-down, select your Prometheus data source.
+- Click Import.
+
+You will now see the new dashboard in your own Grafana instance.
diff --git a/pages/config/config_helper/config_dns_gtm.md b/pages/config/config_helper/config_dns_gtm.md
@@ -1,18 +1,17 @@
 ---
 layout: page
-title: Configure DNS & GTM (Optional)
+title: Configure Optional Metrics
 parent: Configuration Helper (Recommended)
 grandparent: Configuration Management
 nav_order: 6
 ---
 
-## DNS and GTM Metrics
+## Optional Metrics
 
-By default, settings for the  collection of DNS and GTM metrics are disabled. They add a relatively large number of
+By default, settings for the  collection of some less common module metrics are disabled. They add a relatively large number of
 additional API calls, and since many devices may not have these features enabled, it was determined to
 make them 'opt in'.
 
-
 They can be enabled on a device by device basis (in `/config/bigip_receivers.yaml`),
 or globally (in `/config/ast_defaults.yaml`) as follows:
 
@@ -27,12 +26,32 @@ Edit the `/config/bigip_receivers.yaml` and add the following data_types configs
 bigip/1:
   endpoint: https://10.0.0.1
   # ...
-  # Enable DNS and/or GTM collection for this device:
+  # Enable optional modules by setting any to true
   data_types:
+    f5.apm:
+      enabled: false
+    f5.cgnat:
+      enabled: false
     f5.dns:
-      enabled: true
+      enabled: false
+    f5.dos:
+      enabled: false
+    f5.firewall:
+      enabled: false
     f5.gtm:
-      enabled: true
+      enabled: false
+    f5.policy.api_protection:
+      enabled: false
+    f5.policy.asm:
+      enabled: false
+    f5.policy.firewall:
+      enabled: false
+    f5.policy.ip_intelligence:
+      enabled: false
+    f5.policy.nat:
+      enabled: false
+    f5.profile.dos:
+      enabled: false
   # ...
 ```
 
@@ -42,11 +61,31 @@ Edit the `/config/ast_defaults.yaml` and add the following data_types configs fo
 ```yaml
 bigip_receiver_defaults:
   # ...
-  # Enable DNS and/or GTM collection for all devices:
+  # Enable optional modules for all devices:
   data_types:
+    f5.apm:
+      enabled: false
+    f5.cgnat:
+      enabled: false
     f5.dns:
-      enabled: true
+      enabled: false
+    f5.dos:
+      enabled: false
+    f5.firewall:
+      enabled: false
     f5.gtm:
-      enabled: true
+      enabled: false
+    f5.policy.api_protection:
+      enabled: false
+    f5.policy.asm:
+      enabled: false
+    f5.policy.firewall:
+      enabled: false
+    f5.policy.ip_intelligence:
+      enabled: false
+    f5.policy.nat:
+      enabled: false
+    f5.profile.dos:
+      enabled: false
   # ...
 ```
diff --git a/pages/troubleshooting/troubleshooting.md b/pages/troubleshooting/troubleshooting.md
@@ -179,7 +179,16 @@ hovering) and selecting 'Inspect > Query'
 * Are any queries to the BigIP timing or erroring out? Check the otel collector logs (`docker ps`) and
 the 'BigIP Collector Stats' dashboard at the top level of the Dashboards section in Grafana 
 
-## GTM and DNS Metrics Not Loading
+## GTM, DNS, ASM, APM, Firewall, NAT Metrics Not Loading
 
-Metrics for DNS and GTM are disabled by default. See 
+Metrics for GTM, DNS, ASM, APM, Firewall, NAT are disabled by default. See 
 [Configuration > Configuration Helper (Recommended) > Configure DNS & GTM]({{ site.url }}{{ site.baseurl }}/config/config_helper/config_dns_gtm.html) for instructions to enable.
+
+## Max API Tokens Reached For User
+
+Several BigIP Bugs have been identified which can result in maximum tokens issued errors:
+
+* [ID1787517](https://cdn.f5.com/product/bugtracker/ID1787517.html)
+* [ID1103369](https://cdn.f5.com/product/bugtracker/ID1103369.html)
+
+v0.9.0 should prevent issues in ID1787517 from occuring on most systems. ID1103369 includes workaround steps for user encountering that issue.
diff --git a/services/grafana/provisioning/dashboards/bigip/fleet/fleet-inventory.json b/services/grafana/provisioning/dashboards/bigip/fleet/fleet-inventory.json
@@ -385,14 +385,9 @@
           "mappings": [
             {
               "options": {
-                "0": {
-                  "color": "#434344",
-                  "index": 0,
-                  "text": "Disabled"
-                },
-                "1": {
+                "module-data": {
                   "color": "dark-green",
-                  "index": 1,
+                  "index": 0,
                   "text": "Enabled"
                 }
               },
@@ -405,10 +400,6 @@
               {
                 "color": "green",
                 "value": null
-              },
-              {
-                "color": "#EAB839",
-                "value": 1
               }
             ]
           }
@@ -476,7 +467,7 @@
             "columnField": "f5_module_name",
             "emptyValue": "zero",
             "rowField": "job",
-            "valueField": "Value"
+            "valueField": "dataType"
           }
         },
         {
@@ -668,19 +659,22 @@
     }
   ],
   "refresh": "",
-  "schemaVersion": 40,
+  "schemaVersion": 39,
   "tags": [],
   "templating": {
     "list": [
       {
         "current": {},
+        "hide": 0,
         "includeAll": false,
         "label": "Prometheus",
+        "multi": false,
         "name": "datasource",
         "options": [],
         "query": "prometheus",
         "refresh": 1,
         "regex": "",
+        "skipUrlSync": false,
         "type": "datasource"
       }
     ]
@@ -693,6 +687,6 @@
   "timezone": "browser",
   "title": "Fleet Inventory",
   "uid": "bdpz4za42wnb4a",
-  "version": 2,
+  "version": 9,
   "weekStart": ""
 }

Original file line number	Diff line number	Diff line change
`@@ -385,14 +385,9 @@`
`385`	`385`	`"mappings": [`
`386`	`386`	`{`
`387`	`387`	`"options": {`
`388`		`- "0": {`
`389`		`- "color": "#434344",`
`390`		`- "index": 0,`
`391`		`- "text": "Disabled"`
`392`		`- },`
`393`		`- "1": {`
	`388`	`+ "module-data": {`
`394`	`389`	`"color": "dark-green",`
`395`		`- "index": 1,`
	`390`	`+ "index": 0,`
`396`	`391`	`"text": "Enabled"`
`397`	`392`	`}`
`398`	`393`	`},`
`@@ -405,10 +400,6 @@`
`405`	`400`	`{`
`406`	`401`	`"color": "green",`
`407`	`402`	`"value": null`
`408`		`- },`
`409`		`- {`
`410`		`- "color": "#EAB839",`
`411`		`- "value": 1`
`412`	`403`	`}`
`413`	`404`	`]`
`414`	`405`	`}`
`@@ -476,7 +467,7 @@`
`476`	`467`	`"columnField": "f5_module_name",`
`477`	`468`	`"emptyValue": "zero",`
`478`	`469`	`"rowField": "job",`
`479`		`- "valueField": "Value"`
	`470`	`+ "valueField": "dataType"`
`480`	`471`	`}`
`481`	`472`	`},`
`482`	`473`	`{`
`@@ -668,19 +659,22 @@`
`668`	`659`	`}`
`669`	`660`	`],`
`670`	`661`	`"refresh": "",`
`671`		`- "schemaVersion": 40,`
	`662`	`+ "schemaVersion": 39,`
`672`	`663`	`"tags": [],`
`673`	`664`	`"templating": {`
`674`	`665`	`"list": [`
`675`	`666`	`{`
`676`	`667`	`"current": {},`
	`668`	`+ "hide": 0,`
`677`	`669`	`"includeAll": false,`
`678`	`670`	`"label": "Prometheus",`
	`671`	`+ "multi": false,`
`679`	`672`	`"name": "datasource",`
`680`	`673`	`"options": [],`
`681`	`674`	`"query": "prometheus",`
`682`	`675`	`"refresh": 1,`
`683`	`676`	`"regex": "",`
	`677`	`+ "skipUrlSync": false,`
`684`	`678`	`"type": "datasource"`
`685`	`679`	`}`
`686`	`680`	`]`
`@@ -693,6 +687,6 @@`
`693`	`687`	`"timezone": "browser",`
`694`	`688`	`"title": "Fleet Inventory",`
`695`	`689`	`"uid": "bdpz4za42wnb4a",`
`696`		`- "version": 2,`
	`690`	`+ "version": 9,`
`697`	`691`	`"weekStart": ""`
`698`	`692`	`}`