Skip to content

Commit 241e11f

Browse files
mariomacmariomac
authoredFeb 27, 2025··
Documenting inter-zone traffic (#1696)
* Documenting inter-zone traffic * reverting unwanted table autoformats * Make vale happy * Nikola and Sean corrections
·
v2.1.0v2.1-alloy.0
1 parent 2ded441 commit 241e11f

File tree

3 files changed

+111
-7
lines changed

3 files changed

+111
-7
lines changed
 

‎docs/sources/configure/export-data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Beyla uses lowercase fields for YAML configuration and uppercase names for envir
3434
| `OTEL_EXPORTER_OTLP_PROTOCOL` | Similar to the shared endpoint, the protocol for metrics and traces. | string | Inferred from port usage |
3535
| `insecure_skip_verify`<br>`BEYLA_OTEL_INSECURE_SKIP_VERIFY` | If `true`, Beyla skips verifying and accepts any server certificate. Only override this setting for non-production environments. | boolean | `false` |
3636
| `interval`<br>`BEYLA_METRICS_INTERVAL` | The duration between exports. | Duration | `60s` |
37-
| `features`<br>`BEYLA_OTEL_METRICS_FEATURES` | The list of metric groups Beyla exports data for, refer to [metrics export features](#metrics-export-features). Accepted values `application`, `application_span`, `application_service_graph`, `application_process`, and `network`. | list of strings | `["application"]` |
37+
| `features`<br>`BEYLA_OTEL_METRICS_FEATURES` | The list of metric groups Beyla exports data for, refer to [metrics export features](#metrics-export-features). Accepted values `application`, `application_span`, `application_service_graph`, `application_process`, `network` and `network_inter_zone`. | list of strings | `["application"]` |
3838
| `allow_service_graph_self_references`<br>`BEYLA_OTEL_ALLOW_SERVICE_GRAPH_SELF_REFERENCES` | Does Beyla include self-referencing service in service graph generation, for example a service that calls itself. Self referencing isn't useful service graphs and increases data cardinality. | boolean | `false` |
3939
| `instrumentations`<br>`BEYLA_OTEL_METRICS_INSTRUMENTATIONS` | The list of metrics instrumentation Beyla collects data for, refer to [metrics instrumentation](#metrics-instrumentation) section. | list of strings | `["*"]` |
4040
| `buckets` | Sets how you can override bucket boundaries of diverse histograms, refer to [override histogram buckets]({{< relref "./metrics-histograms.md" >}}). | (n/a) | Object |
@@ -217,7 +217,7 @@ of Beyla: application-level metrics or network metrics.
217217
discovery is the best choice for service graph metrics.
218218
- If the list contains `application_process`, the Beyla Prometheus exporter exports metrics about the processes that
219219
run the instrumented application.
220-
- If the list contains `network`, the Beyla Prometheus exporter exports network-level
220+
- If the list contains `network` or `network_inter_zone`, the Beyla Prometheus exporter exports network-level
221221
metrics; but only if the Prometheus `port` property is defined. For network-level metrics options visit the
222222
[network metrics]({{< relref "../network" >}}) configuration documentation.
223223

‎docs/sources/network/_index.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,22 @@ To get started using Beyla networking metrics, consult the [quickstart setup doc
1919

2020
## Metric attributes
2121

22-
Network metrics provides a single metric:
22+
Beyla provides two families of network metrics:
2323

24-
- `beyla.network.flow.bytes`, if it is exported via OpenTelemetry.
25-
- `beyla_network_flow_bytes_total`, if it is exported by a Prometheus endpoint.
24+
* **Network flow bytes** as the number of bytes observed between two network endpoints.
25+
- `beyla.network.flow.bytes`, if it is exported via OpenTelemetry.
26+
- `beyla_network_flow_bytes_total`, if it is exported by a Prometheus endpoint.
27+
- To enable it, add the `network` option to the [BEYLA_OTEL_METRICS_FEATURES or BEYLA_PROMETHEUS_FEATURES]({{< relref "../configure/export-data.md" >}}) configuration option.
28+
* **Inter-zone bytes** as the number of bytes observed between two network endpoints in different Cloud Availability Zones.
29+
- `beyla.network.inter.zone.bytes`, if it is exported via OpenTelemetry.
30+
- `beyla_network_inter_zone_bytes_total`, if it is exported by a Prometheus endpoint.
31+
- More information about how to enable it in the [Measuring traffic between Cloud availability zones]({{< relref "./inter-az.md" >}}) documentation.
2632

27-
The metric represents a counter of the Number of bytes observed between two network endpoints, and can have the attributes in the following table.
33+
Network metric can have the attributes in the following table.
2834

29-
By default, only the following attributes are reported: `k8s.src.owner.name`, `k8s.src.namespace`, `k8s.dst.owner.name`, `k8s.dst.namespace`, and `k8s.cluster.name`.
35+
By default, only the following attributes are reported for network flow bytes: `k8s.src.owner.name`, `k8s.src.namespace`, `k8s.dst.owner.name`, `k8s.dst.namespace`, and `k8s.cluster.name`.
36+
37+
For the inter-zone bytes metric, the default attributes are `k8s.cluster.name`, `src.zone` and `dst.zone`.
3038

3139
| Attribute name (OpenTelemetry / Prometheus) | Description |
3240
|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -55,6 +63,8 @@ By default, only the following attributes are reported: `k8s.src.owner.name`, `k
5563
| `k8s.src.node.name` / `k8s_src.node_name` | Name of the source Node |
5664
| `k8s.dst.node.name` / `k8s_dst.node_name` | Name of the destination Node |
5765
| `k8s.cluster.name` / `k8s_cluster_name` | Name of the Kubernetes cluster. Beyla can auto-detect it on Google Cloud, Microsoft Azure, and Amazon Web Services. For other providers, set the `BEYLA_KUBE_CLUSTER_NAME` property |
66+
| `src.zone` / `src_zone` | Name of the source Cloud Availability Zone |
67+
| `dsg.zone` / `dst_zone` | Name of the destination Cloud Availability Zone |
5868

5969
### How to specify reported attributes
6070

‎docs/sources/network/inter-az.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: Measure traffic between Cloud availability zones
3+
menuTitle: Measure traffic between Cloud availability zones
4+
description: How to measure the network traffic between different Cloud availability zones
5+
weight: 1
6+
keywords:
7+
- Beyla
8+
- eBPF
9+
- Network
10+
---
11+
12+
# Measure traffic between Cloud availability zones
13+
14+
{{< admonition type="note" >}}
15+
This feature is currently only available in Kubernetes clusters.
16+
{{< /admonition >}}
17+
18+
Traffic between Cloud Availability Zones might incur additional costs. Beyla is able to measure it either by
19+
adding `src.zone` and `dst.zone` attributes to regular network metrics,
20+
or by providing a separate `beyla.network.inter.zone.bytes` (OTEL) / `beyla_network_inter_zone_bytes_total` (Prometheus)
21+
metric.
22+
23+
## Add `src.zone` and `dst.zone` attributes to regular network metrics
24+
25+
Source and destination availability zone attributes are disabled by default in Beyla. To enable it, explicitly add them to the list of
26+
included network attributes in the Beyla YAML configuration:
27+
28+
```
29+
attributes:
30+
select:
31+
beyla_network_flow_bytes:
32+
include:
33+
- k8s.src.owner.name
34+
- k8s.src.namespace
35+
- k8s.dst.owner.name
36+
- k8s.dst.namespace
37+
- k8s.cluster.name
38+
- src.zone
39+
- dst.zone
40+
```
41+
42+
This configuration makes inter-zone traffic visible for each `beyla_network_flow_bytes_total` metric
43+
with different `src_zone` and `dst_zone` attributes.
44+
45+
If you require higher granularity in your inter-zone traffic measurement (for example, source/destination pods or nodes),
46+
adding zone attributes would impact the cardinality of the metric, even for traffic within the same availability zone.
47+
48+
## Use the `beyla.network.inter.zone` metric
49+
50+
Using a separate metric for inter-zone traffic reduces the metric cardinality impact of collecting this data,
51+
because the `src.zone` and `dst.zone` attributes are not added to the regular network metrics.
52+
53+
To enable the `beyla.network.inter.zone` metric, add the `network_inter_zone` option to the
54+
[BEYLA_OTEL_METRICS_FEATURES or BEYLA_PROMETHEUS_FEATURES]({{< relref "../configure/export-data.md" >}}) configuration option,
55+
or its equivalent YAML options. For example, if Beyla is configured to export metrics via OpenTelemetry:
56+
57+
```yaml
58+
otel_metrics_export:
59+
features:
60+
- network
61+
- network_inter_zone
62+
```
63+
64+
## PromQL queries to measure inter-zone traffic
65+
66+
Assuming that both `network` and `network_inter_zone` metric families are enabled, you can use the following PromQL queries
67+
to measure inter-zone traffic:
68+
69+
Overall inter-zone traffic throughput:
70+
71+
```
72+
sum(rate(beyla_network_inter_zone_bytes_total[$__rate_interval]))
73+
```
74+
75+
Inter-zone traffic throughput, summarized by source and destination zones:
76+
```
77+
sum(rate(beyla_network_inter_zone_bytes_total[$__rate_interval])) by(src_zone,dst_zone)
78+
```
79+
80+
Overall same-zone traffic throughput:
81+
82+
```
83+
sum(rate(beyla_network_flow_bytes_total[$__rate_interval]))
84+
- sum(rate(beyla_network_inter_zone_bytes_total[$__rate_interval]))
85+
```
86+
87+
Percentage of inter-zone traffic from the total:
88+
89+
```
90+
100 * sum(rate(beyla_network_inter_zone_bytes_total[$__rate_interval]))
91+
/ sum(rate(beyla_network_flow_bytes_total[$__rate_interval]))
92+
```
93+
94+

0 commit comments

Comments
 (0)
Please sign in to comment.