Skip to content

Commit 33fc950

Browse files
author
bowler
committed
- module 3 lab 3 updates
- module 4 labs 1 and 2 updates
1 parent e1e738a commit 33fc950

File tree

5 files changed

+140
-31
lines changed

5 files changed

+140
-31
lines changed

docs/class1/module3/lab3.rst

+4
Original file line numberDiff line numberDiff line change
@@ -143,3 +143,7 @@ Available Metrics include:
143143
.. note:: One of the *best* ways to ensure you're in the know as it relates to the **F5 AST** is by having a conversation with *your F5 account team* and voicing your interest, thoughts, and opinions.
144144

145145
Unsure who's on your account team? No problem. Head over to `Get F5 <https://www.f5.com/products/get-f5>`_ and submit an inquiry mentioning the **F5 Application Study Tool**.
146+
147+
But wait, THERE'S MORE! We've added a bonus section to the UDF lab environment and this guide: **the F5 Local API Discovery Tool**.
148+
149+
Select **Next** below for a preview of this extension to the **F5 AST!**
Loading
Loading

docs/class1/module4/lab1.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ System Overview
2121
The F5 LADT relies on a specially-crafted iRule to export per-request metadata to the analysis system, running on-prem. The analysis system consists of:
2222

2323
- Opentelemetry Collector: For receiving incoming logs, processing, and forwarding them to storage system
24-
- Clickhouse Database: For storing log data and running analysis queries
24+
- ClickHouse Database: For storing log data and running analysis queries
2525
- Analysis Job: Runs periodically to generate results
2626
- Grafana: For visualizing results, and system component states
2727

docs/class1/module4/lab2.rst

+135-30
Original file line numberDiff line numberDiff line change
@@ -43,34 +43,139 @@ Accessing F5 LADT Grafana Instance
4343
API Detection Dashboard
4444
-----------------------
4545

46-
#. The **API Detection Dashboard** has three sections, as outlined below. Contract the *System Overview* and *System State Detail* sections by selecting the **v** next to each section title, as we're more interested in the *Detection Results*.
47-
48-
* System Overview
49-
* Clickhouse Service Status
50-
* OTel Service Status
51-
* Log Analyzer Status
52-
* Last Analysis Time
53-
* Logs Analyzed Last Time
54-
* New Logs Since Last Analysis
55-
- System State Detail
56-
- Analysis Settings
57-
- Logs Last Processed by Host
58-
- Logs Received
59-
- Logs Processed at Last Analysis
60-
- Last Analysis Duration
61-
- CPU Utilization
62-
- Memory Usage
63-
- Detection Results
64-
- Application Name
65-
- HTTP Method
66-
- Path
67-
- Authentication Detected
68-
- Sensitive Headers Present
69-
- Sensitive Body Present
70-
- Sensitive Data Types
71-
- # of Requests
72-
73-
.. image:: images/api_detection_dashboard.png
74-
:width: 800
46+
The **API Detection Dashboard** has three sections, as outlined below. Contract the *System Overview* and *System State Detail* sections by selecting the **v** next to each section title, as we're more interested in the *Detection Results*.
47+
48+
* System Overview
49+
50+
* Clickhouse Service Status
51+
52+
* OTel Service Status
53+
54+
* Log Analyzer Status
55+
56+
* Last Analysis Time
57+
58+
* Logs Analyzed Last Time
59+
60+
* New Logs Since Last Analysis
61+
62+
* System State Detail
63+
64+
* Analysis Settings
65+
66+
* Logs Last Processed by Host
67+
68+
* Logs Received
69+
70+
* Logs Processed at Last Analysis
71+
72+
* Last Analysis Duration
73+
74+
* CPU Utilization
75+
76+
* Memory Usage
77+
78+
* Detection Results
79+
80+
* Application Name
81+
82+
* HTTP Method
83+
84+
* Path
85+
86+
* Authentication Detected
87+
88+
* Sensitive Headers Present
89+
90+
* Sensitive Body Present
91+
92+
* Sensitive Data Types
93+
94+
* # of Requests
95+
96+
.. image:: images/api_detection_dashboard.png
97+
:width: 800
98+
99+
As detailed above, **Detection Results** is where all of the API endpoints and their detected properties will be listed. Straight away, you will be able to get a view of the number of requests an API resource has seen for a given method and whether or not sensitive data or headers have been detected.
100+
101+
ClickHouse Dashboard
102+
--------------------
103+
104+
**ClickHouse** is the software used to store logs and perform analysis queries. Its dashboard has 12 sections, which are listed below. This is not necessarily an aspect of the tool we expect students and administrators to interact with on a regular basis. However, it's a good idea to understand the scope of which metrics are captured and represented here in the event troubleshooting is required.
105+
106+
* System Metrics
107+
108+
* Nodes
109+
110+
* Memory
111+
112+
* Connections
113+
114+
* Read backoff
115+
116+
* Slow reads
117+
118+
* Queries
119+
120+
* Insert
121+
122+
* Select
123+
124+
* IO
125+
126+
* Replicas
127+
128+
* Merge
129+
130+
* Cache
131+
132+
* Parts
133+
134+
* Distributed
135+
136+
* Background pool
137+
138+
* Zookeeper
139+
140+
.. note:: Many (if not all) of the metrics found within this dashboard may be foreign and daunting if you're not already familiar with **ClickHouse** and/or databases in general.
75141

76-
As detailed above, **Detection Results** is where all of the API endpoints and their detected properties will be listed. Straight away, you will be able to get a view of the number of requests an API resource has seen for a given method and whether or not sensitive data or headers have been detected.
142+
If you would like to get a better understanding of their role, contextual information is available via the *information icon* to the right of each metric label. Hover over the icon to view tooltip details.
143+
144+
.. attention:: References to *clickhouse:9126* indicate the default port upon which the **ClickHouse** runs: *9126*
145+
146+
.. image:: images/clickhouse_dashboard.png
147+
:width: 800
148+
149+
OpenTelemetry Collector Dashboard
150+
---------------------------------
151+
152+
The **OpenTelemetry Collector Dashboard** contains all information pertaining to the *OTel Collector* employed in receiving, processing, and forwarding incoming logs to the storage system (ClickHouse). This dashboard contains the following eight sections:
153+
154+
There's a section dedicated to *documentation*, should you have the desire to learn more about telemetry metrics collection!
155+
156+
* Receivers
157+
158+
* Processors
159+
160+
* Exporters
161+
162+
* Collector
163+
164+
* Signal Flows
165+
166+
* RPC server/client
167+
168+
* Kubernetes
169+
170+
* Documentation
171+
172+
.. note:: As mentioned within the **ClickHouse Dashboards** portion above, you may obtain a better understanding of OTel Collector metric roles via the *information icon* to the right of each metric label. Hover over the icon to view tooltip details.
173+
174+
.. image:: images/otel_collector_dashboard.png
175+
:width: 800
176+
177+
That's a wrap for the **F5 Application Study Tool Introduction** class, folks. Check back often for updates to the guide, as we have exciting plans for future labs!
178+
179+
Our **appreciation** for *your* **time** and **energy** goes *beyond what words can convey*.
180+
181+
.. attention:: We would like to encourage you to provide feedback through your account team and also the GitHub repos, should you encounter issues or have enhancement requests!

0 commit comments

Comments
 (0)