Add docs for egress related metrics

Signed-off-by: terashima <[email protected]>
cybozu-go · Dec 20, 2024 · f3978dc · f3978dc
1 parent c5f03a4
commit f3978dc
Showing 1 changed file with 57 additions and 0 deletions.
diff --git a/docs/cmd-coil-egress.md b/docs/cmd-coil-egress.md
@@ -37,3 +37,60 @@ This is the number of client pods which use the egress.
 | ----------- | ----------------------------- |
 | `namespace` | The egress resource namespace |
 | `egress`    | The egress resource name      |
+
+### `coil_egress_client_pod`
+
+This is the client pod information.
+
+| Label       | Description                   |
+| ----------- | ----------------------------- |
+| `namespace` | The egress resource namespace |
+| `egress`    | The egress resource name      |
+| `pod`       | The pod name                  |
+| `pod_ip`    | The pod's IP address          |
+| `interface` | The interface for the pod     |
+
+### `coil_egress_nf_conntrack_entries_limit`
+
+This is the limit of conntrack entries in the kernel.
+This value is from `/proc/sys/net/netfilter/nf_conntrack_max`.
+
+| Label       | Description                   |
+| ----------- | ----------------------------- |
+| `namespace` | The egress resource namespace |
+| `egress`    | The egress resource name      |
+| `pod`       | The pod name                  |
+
+
+### `coil_egress_nf_conntrack_entries`
+
+This is the number of conntrack entries in the kernel.
+This value is from `/proc/sys/net/netfilter/nf_conntrack_count`.
+
+| Label       | Description                   |
+| ----------- | ----------------------------- |
+| `namespace` | The egress resource namespace |
+| `egress`    | The egress resource name      |
+| `pod`       | The pod name                  |
+
+### `coil_egress_masqueraded_packets_total`
+
+This is the total number of packets masqueraded by iptables in a egress NAT pod.
+This value is from the result of `iptables -t nat -L POSTROUTING -vn`.
+
+| Label       | Description                   |
+| ----------- | ----------------------------- |
+| `namespace` | The egress resource namespace |
+| `egress`    | The egress resource name      |
+| `pod`       | The pod name                  |
+
+### `coil_egress_masqueraded_bytes_total`
+
+This is the total bytes of masqueraded packets by iptables in a egress NAT pod.
+This value is from the result of `iptables -t nat -L POSTROUTING -vn`.
+
+| Label       | Description                   |
+| ----------- | ----------------------------- |
+| `namespace` | The egress resource namespace |
+| `egress`    | The egress resource name      |
+| `pod`       | The pod name                  |