feat(probe): Fortiswitch port stats #219

Jurka007 · 2023-05-10T09:19:05Z

bluecmd · 2023-07-17T12:46:37Z

@Jurka007 can you rebase and fix the check errors?

bluecmd

Some metric naming and label comments

bluecmd · 2023-07-24T07:08:22Z

README.md

+   * `fortiswitch_port_receive_drops_total`
+   * `fortiswitch_port_receive_oversized_packets_total`   
+ * _SwitchController/ManageSwitch/Health_
+   * `fortiswitch_health_summary_cpu`


Avoid using words like mem when memory works

These health metrics names have no unit in them (e.g. add _celsius tofortiswitch_health_temperature

Actually the unit label is part of the metric
fortiswitch_health_temperature{VDOM="root", fortiswitch="FSS123456789", module="sensor1(CPU Board Temp)", unit="celsius"} 45

bluecmd · 2023-07-24T07:11:33Z

pkg/probe/fortiswitch_health.go

+		VDOM    string
+	}
+	var r swResponse
+	//var r map[string]swResponse


Remove dead code

bluecmd · 2023-07-24T07:13:21Z

pkg/probe/fortiswitch_health.go

+		mSumCPU = prometheus.NewDesc(
+			"fortiswitch_health_summary_cpu",
+			"Summary CPU health",
+			[]string{"rating", "fortiswitch", "VDOM"}, nil,


Lowercase all labels

bluecmd · 2023-07-24T07:17:34Z

pkg/probe/fortiswitch_health.go

+	//for _, sw := range r {
+	for fswitch, hr := range r.Results {
+
+		m = append(m, prometheus.MustNewConstMetric(mSumCPU, prometheus.GaugeValue, hr.Summary.CPU.Value, hr.Summary.CPU.Rating, fswitch, r.VDOM))


The rating likely shouldn't be a level ä label but rather a metric like "xxx_is_good". That, or an enum label on a _rating metric. Otherwise it's really hard to use it in alerts.

Right, we don't care about the numbers as there is no documentations what those really means. The fortios has own logic to either return good or not good, but no idea what are the other ratings.
Perhaps the alert should be based on any other than good value.

wait, prometheus has only numeric metrics.. 🤔

bluecmd · 2023-07-24T07:19:03Z

pkg/probe/fortiswitch_health.go

+		)
+		mSumUpTime = prometheus.NewDesc(
+			"fortiswitch_health_summary_uptime",
+			"Summary Uptime",


If you have the documentation it would be really great if these descriptions could be made more verbose so I for example have any idea what these means. But if you don't, it's fine - sometimes we simply don't know

Unfortunately there is nothing in the docs :( I have no idea either, we can only guess..

Seems to be a summary of the overall status, good or not good 🤷

bluecmd · 2023-07-24T07:21:52Z

pkg/probe/fortiswitch_port_stats.go

+			}
+			m = append(m, prometheus.MustNewConstMetric(mPortStatus, prometheus.GaugeValue, pStatus, swr.VDOM, swr.Name, pi.Interface, pi.Vlan, pi.Duplex))
+			m = append(m, prometheus.MustNewConstMetric(mPortSpeed, prometheus.GaugeValue, pi.Speed*1000*1000, swr.VDOM, swr.Name, pi.Interface, pi.Vlan, pi.Duplex))
+


Having duplex as a label seems a bit off to me. Why not have it as a separate metric?

The value is either half or full. I am fine with that.
No big deal to add, but what values would you expect? 1 for full and 0.5 for half

bluecmd · 2023-07-24T07:23:21Z

pkg/probe/fortiswitch_port_stats.go

+		if swr.Status == "Connected" {
+			swStatus = 1.0
+		}
+		m = append(m, prometheus.MustNewConstMetric(mSwitchStatus, prometheus.GaugeValue, swStatus, swr.VDOM, swr.Name, swr.FgPeerIntfName, swr.Connection, swr.State))


The state label here should likely be an enum label if the possible values of state is limited and known. It's hard to use it for anything useful otherwise.

State: Authorization state of the FortiSwitch

Discovered, DeAuthorized, Authorized

bluecmd · 2023-07-24T07:24:45Z

pkg/probe/fortiswitch_port_stats.go

+		mPortStatus = prometheus.NewDesc(
+			"fortiswitch_port_status",
+			"Whether the switch port is up or not",
+			[]string{"vdom", "name", "interface", "vlan", "duplex"}, nil,


Can a port only have one VLAN on a
Fortiswitch? That seems odd. What happens when the port is a VLAN trunk?

These values seems to correspond to port switch view https://<fg-ip>:<fg-port>/ng/switchctrl/portsso the vlan is Native VLAN per single port. There is no info about trunk ports.

bluecmd · 2023-07-24T07:25:59Z

pkg/probe/fortiswitch_port_stats.go

+		mSwitchStatus = prometheus.NewDesc(
+			"fortiswitch_status",
+			"Whether the switch is connected or not",
+			[]string{"vdom", "name", "fgt_peer_intf_name", "connection_from", "state"}, nil,


This meric is not like the rest. The fgt_peer_intf_name and connection_from is not clear to me what this metric is. Care to add it to the description or as a comment in code?

Jurka007 · 2025-03-05T14:37:07Z

I am back baby. I don't remember what I have done here :) Will try to update asap so we can merge this.

Jurka007 · 2025-03-06T10:14:46Z

🤦
GET api/v2/monitor/switch-controller/managed-switch is deprecated. It will be removed in 7.2. It's replaced by /api/v2/monitor/switch-controller/managed-switch/status for faster performance.

GET api/v2/monitor/switch-controller/managed-switch/health to be deprecated in FortiOS v7.6.0, replaced by /api/v2/monitor/switch-controller/managed-switch/health-status.

Jurka007 · 2025-03-06T16:29:33Z

Btw the #215 has the same api call. didn't notice until now
so it's kinda duplicate 🤦

Jurka007 · 2025-03-07T09:11:45Z

Ok, this should be it. Added support for new api changes. Didn't test yet, don't have any firewall with os 7.6

Also maybe worth to merge the managed_switch probe and this one.

Signed-off-by: jiri <[email protected]>

* fix(BGP Info): Added support for bgp session state as value next to label * test(bgp): Updated tests to account for new value * test(bgp): Also change metric description in tests --------- Co-authored-by: Gianni Stubbe <[email protected]> Signed-off-by: jiri <[email protected]>

* docs: Updated descriptions of metrics to be self-explanatory * test(interface): Fixed tests for system and ipsec interfaces --------- Co-authored-by: Gianni Stubbe <[email protected]> Signed-off-by: jiri <[email protected]>

* feat(ippool): Added support for ippool info This merge adds support for ippool information. This closes prometheus-community#231 * fix(naming): Updated metric names to be in line with prometheus conventions * test(ippool): Added tests for the firewall ippool feature * style: Updated tests and readme to align for new naming * style: Changed metric name to match other percentage metrics * fix(ippool): Updated value percentage to be 0-1.0 --------- Co-authored-by: Gianni Stubbe <[email protected]>

…nity#255) Co-authored-by: Joel Norberg <[email protected]>

….0 (prometheus-community#250) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

Signed-off-by: Christian Svensson <[email protected]> Signed-off-by: jiri <[email protected]>

Signed-off-by: jiri <[email protected]>

…ool types (prometheus-community#267) * feat: Added pba_per_ip return for ippool to differentiate between types of ippools * docs: Updated readme --------- Co-authored-by: Gianni Stubbe <[email protected]>

….0 (prometheus-community#263) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

…ty#260) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

Signed-off-by: jiri <[email protected]>

In order for this project to be adopted by the Prometheus Community update the license to Apache Version 2.0. Signed-off-by: SuperQ <[email protected]> Signed-off-by: jiri <[email protected]>

* Update for Prometheus Community Update various files for Prometheus Community * Use Prometheus common Makefile setup. * Add license headers in Go files. * Update Go module path. * Enable dependabot. * Update GitHub Actions. * Fixup golangci-lint errors. --------- Signed-off-by: SuperQ <[email protected]>

Signed-off-by: jiri <[email protected]>

Signed-off-by: Jiri Manak <[email protected]>

bluecmd changed the title ~~Fortiswitch port stats~~ feat(probe): Fortiswitch port stats Jul 18, 2023

Jurka007 force-pushed the fortiswitch_port_stats branch from 4d6c403 to 9d0a753 Compare July 24, 2023 06:13

bluecmd requested changes Jul 24, 2023

View reviewed changes

Jurka007 force-pushed the fortiswitch_port_stats branch from f31a005 to d1fbc91 Compare March 6, 2025 17:12

Jurka007 requested a review from bluecmd March 7, 2025 07:39

Jurka007 force-pushed the fortiswitch_port_stats branch from e0688f2 to 5ad6d03 Compare March 7, 2025 08:58

Jurka007 and others added 19 commits March 7, 2025 14:22

added fsw_port_stats probe

b99d8ac

Signed-off-by: jiri <[email protected]>

Update README.md

0f115c2

Signed-off-by: jiri <[email protected]>

Update README.md

fd1da11

Signed-off-by: jiri <[email protected]>

fortiswitch_health probe

d52dba9

Signed-off-by: jiri <[email protected]>

Update README.md

80f4880

Signed-off-by: jiri <[email protected]>

formatting

57d4fe8

Signed-off-by: jiri <[email protected]>

Implement fixes and fortiOS 7 api changes

9ea139d

Signed-off-by: jiri <[email protected]>

Test fixes

d31b720

Signed-off-by: jiri <[email protected]>

Remove debug code

d6ae32e

Signed-off-by: jiri <[email protected]>

Fix formating

fcce77d

Signed-off-by: jiri <[email protected]>

feat: added OSPF metrics and corresponding testcase (prometheus-commu…

5979f3c

…nity#255) Co-authored-by: Joel Norberg <[email protected]>

fix(deps): update module github.com/prometheus/client_golang to v1.17…

946bbe4

….0 (prometheus-community#250) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

chore(ci): bump actions versions

d02870b

Signed-off-by: Christian Svensson <[email protected]> Signed-off-by: jiri <[email protected]>

fix(probe): correct OSPF state enum

db2cd36

Signed-off-by: jiri <[email protected]>

feat: Added pba_per_ip return for ippool to differentiate between ipp…

2b9f590

…ool types (prometheus-community#267) * feat: Added pba_per_ip return for ippool to differentiate between types of ippools * docs: Updated readme --------- Co-authored-by: Gianni Stubbe <[email protected]>

fix(deps): update module github.com/prometheus/client_golang to v1.18…

4728591

….0 (prometheus-community#263) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

renovate bot and others added 6 commits March 7, 2025 14:29

chore(deps): update actions/setup-go action to v5 (prometheus-communi…

40dad5b

…ty#260) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Signed-off-by: jiri <[email protected]>

Archive this repo

8795d10

Signed-off-by: jiri <[email protected]>

chore: Change project license (prometheus-community#309)

bdc1129

In order for this project to be adopted by the Prometheus Community update the license to Apache Version 2.0. Signed-off-by: SuperQ <[email protected]> Signed-off-by: jiri <[email protected]>

Add license header

57ba0c5

Signed-off-by: jiri <[email protected]>

Update http library path

64575ff

Signed-off-by: jiri <[email protected]>

Jurka007 force-pushed the fortiswitch_port_stats branch from 3f339fd to 64575ff Compare March 7, 2025 13:32

Merge branch 'main' into fortiswitch_port_stats

cf05e02

Signed-off-by: Jiri Manak <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(probe): Fortiswitch port stats #219

feat(probe): Fortiswitch port stats #219

Jurka007 commented May 10, 2023

bluecmd commented Jul 17, 2023

bluecmd left a comment

bluecmd Jul 24, 2023

Jurka007 Mar 5, 2025

bluecmd Jul 24, 2023

bluecmd Jul 24, 2023

bluecmd Jul 24, 2023

Jurka007 Mar 6, 2025

Jurka007 Mar 6, 2025

bluecmd Jul 24, 2023

Jurka007 Mar 5, 2025

Jurka007 Mar 6, 2025

bluecmd Jul 24, 2023

Jurka007 Mar 6, 2025

bluecmd Jul 24, 2023

Jurka007 Mar 6, 2025

bluecmd Jul 24, 2023

Jurka007 Mar 6, 2025

bluecmd Jul 24, 2023

Jurka007 commented Mar 5, 2025

Jurka007 commented Mar 6, 2025

Jurka007 commented Mar 6, 2025

Jurka007 commented Mar 7, 2025

feat(probe): Fortiswitch port stats #219

Are you sure you want to change the base?

feat(probe): Fortiswitch port stats #219

Conversation

Jurka007 commented May 10, 2023

bluecmd commented Jul 17, 2023

bluecmd left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jurka007 commented Mar 5, 2025

Jurka007 commented Mar 6, 2025

Jurka007 commented Mar 6, 2025

Jurka007 commented Mar 7, 2025