Edit config

docs/sources/network/config.md

@@ -49,7 +49,7 @@ Enables network metrics reporting in Beyla.
 
 Specifies which attributes are visible in the metrics.
 Beyla aggregates the metrics by their common visible attributes.
-For example, hiding the `k8s.src.name` and allowing `k8s.src.owner.name` would aggregate the metrics of all the pods under a same owner.
+For example, hiding the `k8s.src.name` and allowing `k8s.src.owner.name` would aggregate the metrics of all the pods under the same owner.
 
 This property won't filter some meta-attributes such as `instance`, `job`, `service.instance.id`, `service_name`, `telemetry.sdk.*`, etc.
 
@@ -72,10 +72,10 @@ BEYLA_NETWORK_ALLOWED_ATTRIBUTES=src.name,dst.name
 
 CIDRs list, to be set as the `src.cidr` and `dst.cidr` attribute with the entry that matches the `src.address` and `dst.address` respectively.
 
-Attribute as a function of the source and destination IP addresses.
-If an IP does not match any address here, the attributes won't be set.
-If an IP matches multiple CIDR definitions, the flow is decorated with the narrowest CIDR.
-As a result, you can safely add a 0.0.0.0/0 entry to group there all the traffic that does not match any of the other CIDRs.
+The attribute as a function of the source and destination IP addresses.
+If an IP address does not match any address here, the attributes won't be set.
+If an IP address matches multiple CIDR definitions, the flow is decorated with the narrowest CIDR.
+As a result, you can safely add a `0.0.0.0/0` entry to group all the traffic that does not match any of the other CIDRs.
 
 If you set this property via environment variable each entry must be separated by a comma, for example:
 
@@ -88,13 +88,13 @@ BEYLA_NETWORK_CIDRS=10.0.0.0/8,192.168.0.0/16
 | `agent_ip` | `BEYLA_NETWORK_AGENT_IP` | string | (not set) |
 
 Allows overriding the reported `beyla.ip` attribute on each metric.
-If not set, Beyla automatically detects its own IP from the specified network interface (see next property).
+If not set, Beyla automatically detects its own IP address from the specified network interface (see next property).
 
 | YAML             | Environment variable           | Type   | Default    |
 | ---------------- | ------------------------------ | ------ | ---------- |
 | `agent_ip_iface` | `BEYLA_NETWORK_AGENT_IP_IFACE` | string | `external` |
 
-Specifies which interface should Beyla use to pick its own IP address to set the value of the `beyla.ip` attribute.
+Specifies which interface Beyla should use to pick its own IP address to set the value of the `beyla.ip` attribute.
 Accepted values are: `external` (default), `local`, or `name:<interface name>` (e.g. `name:eth0`).
 
 If the `agent_ip` configuration property is set, this property has no effect.
@@ -103,36 +103,35 @@ If the `agent_ip` configuration property is set, this property has no effect.
 | --------------- | ----------------------------- | ------ | ------- |
 | `agent_ip_type` | `BEYLA_NETWORK_AGENT_IP_TYPE` | string | `any`   |
 
-Specifies which type of IP address (IPv4 or IPv6 or both) should the Beyla report in the `beyla.ip` field of each flow.
+Specifies which type of IP address (IPv4 or IPv6 or both) Beyla should report in the `beyla.ip` field of each flow.
 Accepted values are: `any` (default), `ipv4`, `ipv6`.
 If the `agent_ip` configuration property is set, this property has no effect.
 
 | YAML         | Environment variable       | Type     | Default |
 | ------------ | -------------------------- | -------- | ------- |
 | `interfaces` | `BEYLA_NETWORK_INTERFACES` | []string | (empty) |
 
-Contains the interface names from where flows are collected from.
-If empty, Beyla fetches all the interfaces in the system, excepting the ones listed in `excluded_interfaces`
-(see below).
+The interface names where flows are collected from.
+If empty, Beyla fetches all the interfaces in the system, excepting the ones listed in `excluded_interfaces` (see below).
 If an entry is enclosed by slashes (e.g. `/br-/`), it is matched as regular expression, otherwise it is matched as a case-sensitive string.
 
 If you set this property via environment variable each entry must be separated by a comma, for example:
 
-```
+```sh
 BEYLA_NETWORK_INTERFACES=eth0,eth1,/^veth/
 ```
 
 | YAML                 | Environment variable               | Type     | Default |
 | -------------------- | ---------------------------------- | -------- | ------- |
 | `exclude_interfaces` | `BEYLA_NETWORK_EXCLUDE_INTERFACES` | []string | `lo`    |
 
-Contains the interface names to be excluded from network flow tracing.
+The interface names to be excluded from network flow tracing.
 Default: `lo` (loop-back).
 If an entry is enclosed by slashes (e.g. `/br-/`), it is matched as a regular expression, otherwise it is matched as a case-sensitive string.
 
 If you set this property via environment variable each entry must be separated by a comma, for example:
 
-```
+```sh
 BEYLA_NETWORK_EXCLUDE_INTERFACES=lo,/^veth/
 ```
 
@@ -157,21 +156,22 @@ Specifies the maximum duration that flows are kept in the accounting cache befor
 Allows selecting which flows to trace according to its direction in the interface where they are captured from.
 Accepted values are `ingress`, `egress`, or `both` (default).
 
-It's important to emphasize that, in this context, _ingress_ or _egress_ are not related to incoming/outgoing
-traffic from outside the node or the cluster, but the network interface.
+{{% admonition type="note" %}}
+In this context, _ingress_ or _egress_ are not related to incoming/outgoing traffic from outside the node or the cluster, but the network interface.
 This means that the same network packet could be seen as "ingress" in a virtual network device and as "egress" in the backing physical network interface.
+{{% /admonition %}}
 
 | YAML       | Environment variable     | Type    | Default        |
 | ---------- | ------------------------ | ------- | -------------- |
 | `sampling` | `BEYLA_NETWORK_SAMPLING` | integer | `0` (disabled) |
 
-Sampling holds the rate at which packets should be sampled and sent to the target collector.
-E.g. if set to 100, one out of 100 packets, on average, are sent to the target collector.
+The rate at which packets should be sampled and sent to the target collector.
+For example, if set to 100, one out of 100 packets, on average, are sent to the target collector.
 
 
 | YAML          | Environment variable        | Type    | Default |
 | ------------- | --------------------------- | ------- | ------- |
 | `print_flows` | `BEYLA_NETWORK_PRINT_FLOWS` | boolean | `false` |
 
-If set to `true`, Beyla prints each Network flow in the standard output.
-It might generate a lot of output.
+If set to `true`, Beyla prints each network flow to standard output.
+Note, this might generate a lot of output.