Docs: Create network metrics docs #675
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #675 +/- ##
==========================================
- Coverage 77.40% 76.95% -0.45%
==========================================
Files 96 96
Lines 8016 8016
==========================================
- Hits 6205 6169 -36
- Misses 1470 1507 +37
+ Partials 341 340 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
docs/sources/network/_index.md
Outdated
|
|
||
| ## Metric attributes | ||
|
|
||
| Network metrics provides a single **OpenTelemetry** metric `beyla.network.flow.bytes`, a counter of the total bytes sent of network flows observed by the eBPF probe since its launch, with the following attributes: |
There was a problem hiding this comment.
I edited the sentence but kept the wording, "total bytes sent of network flows observed by the eBPF probe since its launch", but it feels a little unclear. Could someone explain this phrase in another way so I can make sure we capture the description?
There was a problem hiding this comment.
Maybe we can just say "a counter of the number of bytes observed between two network endpoints"?
docs/sources/network/_index.md
Outdated
|
|
||
| Network metrics provides a single **OpenTelemetry** metric `beyla.network.flow.bytes`, a counter of the total bytes sent of network flows observed by the eBPF probe since its launch, with the following attributes: | ||
|
|
||
| - `beyla.ip`: the local IP address of the Beyla instance that emitted the metric |
There was a problem hiding this comment.
Are the attribute pairs mutually exclusive or can they both occur? Could we separate them to their own lines, even better can we use a table?
There was a problem hiding this comment.
They can Both occur. I will use a table, thanks for the suggestion!
| name: grafana-secret | ||
| ``` | ||
|
|
||
| ## Select metrics attributes to reduce cardinality |
There was a problem hiding this comment.
Are we going to add content for these two sections?
There was a problem hiding this comment.
Yes, this is a WIP PR.
grafsean
changed the title
grafsean
changed the title
mariomac
changed the title
| ### Allowed attributes | ||
|
|
||
| If the metric with all the attributes is reported it might lead to a cardinality explosion, especially when including external traffic in the `src.address`/`dst.address` attributes. | ||
|
|
||
| You can specify which attributes are allowed in the Beyla configuration. Allowed attributes and aggregates the metrics by them. For example: | ||
|
|
||
| ```yaml | ||
| network: | ||
| enable: true | ||
| allowed_attributes: | ||
| - k8s.src.owner.name | ||
| - k8s.src.namespace | ||
| - k8s.dst.owner.name | ||
| - k8s.dst.namespace | ||
| ``` |
There was a problem hiding this comment.
This should be the default set while others can enabled explicitly by the user.
There was a problem hiding this comment.
Working on it on another PR and later I'll amend this.
No description provided.