Skip to content

Commit

Permalink
remove future tenses
Browse files Browse the repository at this point in the history
  • Loading branch information
@mariomac
mariomac committed Mar 7, 2024
1 parent 3937c68 commit bca44ed
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/sources/network/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ Enables network metrics reporting in Beyla.
|----------------------|------------------------------------|----------|---------|
| `allowed_attributes` | `BEYLA_NETWORK_ALLOWED_ATTRIBUTES` | []string | (empty) |

Specifies which attributes are visible in the metrics. Beyla will aggregate the metrics
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.

This property won't filter some meta-attributes such as
`instance`, `job`, `service.instance.id`, `service_name`, `telemetry.sdk.*`, etc.

⚠️If left empty, Beyla will report all the attributes; which might increase greatly
⚠️If left empty, Beyla reports all the attributes; which might increase greatly
the cardinality of your metrics. Setting this value to list only the attributes you
really need is highly recommended.

Expand All @@ -77,7 +77,7 @@ 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 will be decorated with the
If an IP matches multiple CIDR definitions, the flow is decorated with the
narrowest CIDR. By this reason, 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.

Check failure on line 82 in docs/sources/network/config.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Grafana.Spelling] Did you really mean 'CIDRs'? For product names, the Grafana dictionary might not know of it yet. You need to add an entry to https://github.com/grafana/writers-toolkit/tree/main/vale/dictionaries/en_US-grafana.wordlist to add a product name to the dictionary. Alternatively, raise an [issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%3A%3CWORD%!E(string= )) and a maintainer will add it for you. For UI elements, use [bold formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use [code formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with code formatting. 

If the rule is incorrect or needs improving, [report an issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%20%3A%20%3CISSUE%3E).

If you have reason to diverge from the style guidance, to skip a rule, refer to [Skip rules](https://grafana.com/docs/writers-toolkit/review/lint-prose/#skip-rules).

Raw Output:
{"message": "[Grafana.Spelling] Did you really mean 'CIDRs'? For product names, the Grafana dictionary might not know of it yet. You need to add an entry to https://github.com/grafana/writers-toolkit/tree/main/vale/dictionaries/en_US-grafana.wordlist to add a product name to the dictionary. Alternatively, raise an [issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%3A%3CWORD%!E(string= )) and a maintainer will add it for you. For UI elements, use [bold formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use [code formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with code formatting. \n\nIf the rule is incorrect or needs improving, [report an issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%20%3A%20%3CISSUE%3E).\n\nIf you have reason to diverge from the style guidance, to skip a rule, refer to [Skip rules](https://grafana.com/docs/writers-toolkit/review/lint-prose/#skip-rules).", "location": {"path": "docs/sources/network/config.md", "range": {"start": {"line": 82, "column": 54}}}, "severity": "ERROR"}

Expand All @@ -92,8 +92,8 @@ BEYLA_NETWORK_GROUP_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 will
automatically detect its own IP from the specified network interface (see next property).
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).

| YAML | Environment variable | Type | Default |
|------------------|--------------------------------|--------|------------|
Expand All @@ -117,10 +117,10 @@ If the `agent_ip` configuration property is set, this property has no effect.
|--------------|----------------------------|----------|---------|
| `interfaces` | `BEYLA_NETWORK_INTERFACES` | []string | (empty) |

Contains the interface names from where flows will be collected from. If empty, Beyla
will fetch 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 will match as regular expression,
otherwise it will be matched as a case-sensitive string.
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). 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:
Expand All @@ -133,9 +133,9 @@ BEYLA_NETWORK_INTERFACES=eth0,eth1,/^veth/
|----------------------|------------------------------------|----------|---------|
| `exclude_interfaces` | `BEYLA_NETWORK_EXCLUDE_INTERFACES` | []string | `lo` |

Contains the interface names that will be excluded from network flow tracing. Default:
`lo` (loopback). If an entry is enclosed by slashes (e.g. `/br-/`), it will match as regular expression,
otherwise it will be matched as a case-sensitive string.
Contains 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:
Expand Down Expand Up @@ -176,13 +176,13 @@ backing phisical network interface.
| `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, will be sent to the target collector.
E.g. 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` |

Check failure on line 184 in docs/sources/network/config.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Grafana.Spelling] Did you really mean 'boolean'? For product names, the Grafana dictionary might not know of it yet. You need to add an entry to https://github.com/grafana/writers-toolkit/tree/main/vale/dictionaries/en_US-grafana.wordlist to add a product name to the dictionary. Alternatively, raise an [issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%3A%3CWORD%!E(string= )) and a maintainer will add it for you. For UI elements, use [bold formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use [code formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with code formatting. 

If the rule is incorrect or needs improving, [report an issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%20%3A%20%3CISSUE%3E).

If you have reason to diverge from the style guidance, to skip a rule, refer to [Skip rules](https://grafana.com/docs/writers-toolkit/review/lint-prose/#skip-rules).

Raw Output:
{"message": "[Grafana.Spelling] Did you really mean 'boolean'? For product names, the Grafana dictionary might not know of it yet. You need to add an entry to https://github.com/grafana/writers-toolkit/tree/main/vale/dictionaries/en_US-grafana.wordlist to add a product name to the dictionary. Alternatively, raise an [issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%3A%3CWORD%!E(string= )) and a maintainer will add it for you. For UI elements, use [bold formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with bold formatting. For paths; configuration; user input; code; class, method, and variable names; statuscodes; and console output, use [code formatting](https://grafana.com/docs/writers-toolkit/write/style-guide/style-conventions/#bold). The spell checker doesn't check words with code formatting. \n\nIf the rule is incorrect or needs improving, [report an issue](https://github.com/grafana/writers-toolkit/issues/new?title=Grafana.Spelling%20%3A%20%3CISSUE%3E).\n\nIf you have reason to diverge from the style guidance, to skip a rule, refer to [Skip rules](https://grafana.com/docs/writers-toolkit/review/lint-prose/#skip-rules).", "location": {"path": "docs/sources/network/config.md", "range": {"start": {"line": 184, "column": 49}}}, "severity": "ERROR"}

If set to `true`, Beyla will print each Network flow in the standard output.
If set to `true`, Beyla prints each Network flow in the standard output.
It might generate a lot of output.

0 comments on commit bca44ed

Please sign in to comment.