Skip to content

[v1.8.x] Remove relref shortcodes #1732

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 12, 2025
Merged

[v1.8.x] Remove relref shortcodes #1732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/sources/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ Beyla offers the following features:

## Get started

- Follow the [language quickstart guides]({{< relref "./quickstart" >}}) for quick instructions
- Follow the [language quickstart guides](quickstart/) for quick instructions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'quickstart/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

about how to set up Beyla to instrument applications written in a particular language.

- Follow the [setup]({{< relref "./setup/_index.md" >}}) documentation to get started with Beyla either as a standalone
- Follow the [setup](setup/) documentation to get started with Beyla either as a standalone
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'setup/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

service, with Docker or with Kubernetes.

- Follow the [tutorials]({{< relref "./tutorial/_index.md" >}}) to get a complete guide to instrument an application with Beyla and data to Grafana Cloud.
- Follow the [tutorials](tutorial/) to get a complete guide to instrument an application with Beyla and data to Grafana Cloud.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'tutorial/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


## Learn more about Grafana Beyla

Expand Down
8 changes: 4 additions & 4 deletions docs/sources/configure/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ aliases:

Beyla can be configured in the following ways:

1. By setting [configuration options]({{< relref "./options" >}}) in a number of ways.
2. By changing [export modes]({{< relref "./export-modes.md" >}}) between direct or agent mode.
1. By setting [configuration options](options/) in a number of ways.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

2. By changing [export modes](export-modes/) between direct or agent mode.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'export-modes/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


For information on the metrics Beyla exports, see the [exported metrics]({{< relref "../metrics.md" >}}) documentation.
For information on the metrics Beyla exports, see the [exported metrics](../metrics/) documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../metrics/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


**Note**: If you will be using Beyla to generate traces, please make sure you've read our documentation section on configuring
the [Routes Decorator]({{< relref "../configure/options#routes-decorator" >}}). Since Beyla is auto-instrumenting your application without any
the [Routes Decorator](options/#routes-decorator). Since Beyla is auto-instrumenting your application without any
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'options/#routes-decorator' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

special language level support, configuring the low cardinality routes decorator is very important for optimal results.
10 changes: 5 additions & 5 deletions docs/sources/configure/export-modes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,23 @@ Beyla can export data in two modes:

## Running in Direct mode

You can follow our [getting started tutorial]({{< relref "../tutorial/getting-started.md" >}}) for a quick introduction
You can follow our [getting started tutorial](../../tutorial/getting-started/) for a quick introduction
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../tutorial/getting-started/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

to auto-instrumentation in Direct mode, by using OpenTelemetry. The OTLP endpoint authentication credentials are provided
by using the following environment variables:

- `OTEL_EXPORTER_OTLP_ENDPOINT`
- `OTEL_EXPORTER_OTLP_HEADERS`

To run in Direct mode by using the Prometheus scrape endpoint, please refer to the
[configuration documentation]({{< relref "./options.md" >}}).
[configuration documentation](../options/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


## Running in Alloy mode

> ℹ️ This tutorial assumes that both Alloy and the auto-instrumentation tool are installed
> as local Linux OS executables. For further examples on downloading and running the
> auto-instrumentation tool as an OCI container, you can check the documentation sections on
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../setup/docker/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

> [running the Beyla as a Docker container]({{< relref "../setup/docker.md" >}})
> or [running Beyla in Kubernetes]({{< relref "../setup/kubernetes.md" >}}).
> [running the Beyla as a Docker container](../../setup/docker/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../setup/kubernetes/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

> or [running Beyla in Kubernetes](../../setup/kubernetes/).

First, locally install and configure [Grafana Alloy, according to the latest documentation](/docs/alloy/).
Alloy facilitates the ingestion of OpenTelemetry metrics and traces from the auto-instrumentation tool,
Expand Down Expand Up @@ -155,7 +155,7 @@ This tutorial assumes Beyla and Alloy are running on the same host, so there is

You can configure the auto-instrumentation tool both via environment variables or via
a configuration YAML file, which is what we will use in this example.
Please refer to the complete [Configuration documentation]({{< relref "./options.md" >}}) for
Please refer to the complete [Configuration documentation](../options/) for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

more detailed description of each configuration option.

You can download the whole [example configuration file](https://github.com/grafana/beyla/blob/main/docs/sources/configure/resources/instrumenter-config.yml),
Expand Down
16 changes: 8 additions & 8 deletions docs/sources/configure/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
YAML configuration, each component has its own first-level section.

Optionally, Beyla also provides network-level metrics, which are documented in the
[Network metrics section of the Beyla documentation]({{< relref "../network" >}}).
[Network metrics section of the Beyla documentation](../../network/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../network/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


A quick description of the components:

Expand Down Expand Up @@ -208,7 +208,7 @@
a group of related services.

In some scenarios, Beyla will instrument a big variety of services; for example,
as a [Kubernetes DaemonSet]({{< relref "../setup/kubernetes.md" >}}) that instruments all
as a [Kubernetes DaemonSet](../../setup/kubernetes/) that instruments all
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../setup/kubernetes/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

the services in a node. The `discovery` YAML section will let you specify a higher
differentiation degree in the services that Beyla can instrument.

Expand Down Expand Up @@ -514,7 +514,7 @@

### Selection of metric attributes

The [Beyla exported metrics]({{< relref "../metrics.md" >}}) document lists the attributes
The [Beyla exported metrics](../../metrics/) document lists the attributes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../metrics/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

that can be reported with each metric. Some of the attributes are reported by default while
others are hidden to control the cardinality.

Expand All @@ -524,7 +524,7 @@

* `include` is a list of attributes that need to be reported. Each attribute can be an attribute
name or a wildcard (for example, `k8s.dst.*` to include all the attributes starting with `k8s.dst`).
If no `include` list is provided, the default attribute set is reported (check [Beyla exported metrics]({{< relref "../metrics.md" >}})
If no `include` list is provided, the default attribute set is reported (check [Beyla exported metrics](../../metrics/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../metrics/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

for more information about the default attributes for a given metric).
* `exclude` is a list to of attribute names/wildcards containing the attributes to remove from the
`include` list (or the default attribute set).
Expand Down Expand Up @@ -635,11 +635,11 @@
attributes:
kubernetes:
enable: true
```

Check failure on line 638 in docs/sources/configure/options.md

View workflow job for this annotation

GitHub Actions / doc-validator 

[doc-validator] reported by reviewdog 🐶
The link to the project page '../../setup/kubernetes/' is invalid.
Links to project pages must use a Hugo relref shortcode like `{{< relref "./path/to/page" >}}`.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

Raw Output:
{"message":"The link to the project page '../../setup/kubernetes/' is invalid.\nLinks to project pages must use a Hugo relref shortcode like `{{< relref \"./path/to/page\" >}}`.\n\nLinks to project assets must be made from a bundle (index.md or _index.md file).\nThe asset must be contained within the bundle directory, it must have an extension, and must not have the extension \".md\".","location":{"path":"docs/sources/configure/options.md","range":{"start":{"line":638,"column":4},"end":{"line":638,"column":144}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"project-link-invalid"}}

It is IMPORTANT to consider that enabling this feature requires a previous step of
providing some extra permissions to the Beyla Pod. Consult the
["Configuring Kubernetes metadata decoration section" in the "Running Beyla in Kubernetes"]({{< relref "../setup/kubernetes.md" >}}) page.
["Configuring Kubernetes metadata decoration section" in the "Running Beyla in Kubernetes"](../../setup/kubernetes/) page.

| YAML | Environment variable | Type | Default |
| -------- | ---------------------------- | ------- | ------- |
Expand Down Expand Up @@ -892,7 +892,7 @@
run the instrumented application.
- If the list contains `network`, the Beyla OpenTelemetry exporter exports network-level
metrics; but only if there is an OpenTelemetry endpoint defined. For network-level metrics options visit the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../network/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

[network metrics]({{< relref "../network" >}}) configuration documentation.
[network metrics](../../network/) configuration documentation.

| YAML | Environment variable | Type | Default |
|---------------------------------------|--------------------------------------------------|----------|---------|
Expand Down Expand Up @@ -1149,7 +1149,7 @@
```

For a list of metrics under the application and network family, as well as their
attributes, check the [Beyla exported metrics]({{< relref "../metrics.md" >}}) document.
attributes, check the [Beyla exported metrics](../../metrics/) document.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../metrics/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


Each `application` and `network` filter section is a map where each key is an attribute
name (either in Prometheus or OpenTelemetry format), with either the `match` or the `not_match` property. Both properties accept a
Expand Down Expand Up @@ -1281,7 +1281,7 @@
run the instrumented application.
- If the list contains `network`, the Beyla Prometheus exporter exports network-level
metrics; but only if the Prometheus `port` property is defined. For network-level metrics options visit the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../network/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

[network metrics]({{< relref "../network" >}}) configuration documentation.
[network metrics](../../network/) configuration documentation.

| YAML | Environment variable | Type | Default |
|---------------------------------------|--------------------------------------------------------|----------|---------|
Expand Down
43 changes: 0 additions & 43 deletions docs/sources/configure/resources/alloy-config.river
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions docs/sources/configure/resources/instrumenter-config.yml
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions docs/sources/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ The following table describes the exported metrics in both OpenTelemetry and Pro

Beyla can also export [Span metrics](/docs/tempo/latest/metrics-generator/span_metrics/) and
[Service graph metrics](/docs/tempo/latest/metrics-generator/service-graph-view/), which you can enable via the
[features]({{< relref "./configure/options.md" >}}) configuration option.
[features](../configure/options/) configuration option.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../configure/options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


## Attributes of Beyla metrics

For the sake of brevity, the metrics and attributes in this list use the OTEL `dot.notation`. When using the Prometheus exporter, the metrics use `underscore_notation`.

In order to configure which attributes to show or which attributes to hide, check the `attributes`->`select` section in the [configuration documentation]({{< relref "./configure/options.md" >}}).
In order to configure which attributes to show or which attributes to hide, check the `attributes`->`select` section in the [configuration documentation](../configure/options/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../configure/options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


| Metrics | Name | Default |
|--------------------------------|------------------------------|---------------------------------------------------|
Expand Down Expand Up @@ -116,7 +116,7 @@ In order to configure which attributes to show or which attributes to hide, chec

## Internal metrics

Beyla can be [configured to report internal metrics]({{< relref "./configure/options.md#internal-metrics-reporter" >}}) in Prometheus Format.
Beyla can be [configured to report internal metrics](../configure/options/#internal-metrics-reporter) in Prometheus Format.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../configure/options/#internal-metrics-reporter' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


| Name | Type | Description |
| ------------------------------------- | ----------- | ---------------------------------------------------------------------------------------- |
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/network/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Grafana Beyla can be configured to provide network metrics between different end

## Get started

To get started using Beyla networking metrics, consult the [quickstart setup documentation]({{< relref "./quickstart" >}}), and for advanced configuration, consult the [configuration documentation]({{< relref "./config" >}}).
To get started using Beyla networking metrics, consult the [quickstart setup documentation](quickstart/), and for advanced configuration, consult the [configuration documentation](config/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'quickstart/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'config/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


## Metric attributes

Expand All @@ -42,8 +42,8 @@ By default, only the following attributes are reported: `k8s.src.owner.name`, `k
| `dst.port` / `dst_port` | Destination port of Network flow |
| `src.name` / `src_name` | Name of Network flow source: Kubernetes name, host name, or IP address |
| `dst.name` / `dst_name` | Name of Network flow destination: Kubernetes name, host name, or IP address |
| `src.cidr` / `src_cidr` | If the [`cidrs` configuration section]({{< relref "./config" >}}) is set, the CIDR that matches the source IP address |
| `dst.cidr` / `dst_cidr` | If the [`cidrs` configuration section]({{< relref "./config" >}}) is set, the CIDR that matches the destination IP address |
| `src.cidr` / `src_cidr` | If the [`cidrs` configuration section](config/) is set, the CIDR that matches the source IP address |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'config/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

| `dst.cidr` / `dst_cidr` | If the [`cidrs` configuration section](config/) is set, the CIDR that matches the destination IP address |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'config/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

| `k8s.src.namespace` / `k8s_src_namespace` | Kubernetes namespace of the source of the flow |
| `k8s.dst.namespace` / `k8s_dst_namespace` | Kubernetes namespace of the destination of the flow |
| `k8s.src.name` / `k8s_src_name` | Name of the source Pod, Service, or Node |
Expand Down Expand Up @@ -87,4 +87,4 @@ attributes:
In this example, the bytes metric is the aggregated by the source and destination owners. This is, all the
pods from a given Deployment/StatefulSet/ReplicaSet/DaemonSet.

For more information about the `attributes.select` section, check the [Configuration options]({{< relref "../configure/options" >}}).
For more information about the `attributes.select` section, check the [Configuration options](../configure/options/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../configure/options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

8 changes: 4 additions & 4 deletions docs/sources/network/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Network metrics is an [experimental](/docs/release-life-cycle/) under developmen

# Beyla Network Metrics configuration options

Network metrics are configured under the `network` property of the [Beyla Configuration YAML file]({{< relref "../configure/options" >}}) or with a set of environment variables prefixed as `BEYLA_NETWORK_`.
Network metrics are configured under the `network` property of the [Beyla Configuration YAML file](../../configure/options/) or with a set of environment variables prefixed as `BEYLA_NETWORK_`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../configure/options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


Example YAML:

Expand Down Expand Up @@ -44,7 +44,7 @@ otel_metrics_export:

In addition to the `network` YAML section, Beyla configuration requires an endpoint to export the
network metrics (in the previous example, `otel_metrics_export`, but it also accepts a
[Prometheus endpoint]({{< relref "../configure/options.md" >}})).
[Prometheus endpoint](../../configure/options/)).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../configure/options/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".


## Network metrics configuration properties

Expand All @@ -53,8 +53,8 @@ network metrics (in the previous example, `otel_metrics_export`, but it also acc
| `enable` | `BEYLA_NETWORK_METRICS` | boolean | `false` |

Explicitly enables network metrics reporting in Beyla. You can also enable network metrics reporting
by adding `network` to the list of `features` for [otel_metrics_export]({{< relref "../configure/options.md#otel-metrics-exporter" >}}))
or [prometheus_export]({{< relref "../configure/options.md#prometheus-http-endpoint" >}})).
by adding `network` to the list of `features` for [otel_metrics_export](../../configure/options/#otel-metrics-exporter))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page '../../configure/options/#otel-metrics-exporter' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension ".md".

or [prometheus_export](../../configure/options/#prometheus-http-endpoint)).

| YAML | Environment variable | Type | Default |
| -------------------- | ---------------------------------- | -------- | ------------------- |
Expand Down
8 changes: 4 additions & 4 deletions docs/sources/network/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Network metrics is an [experimental](/docs/release-life-cycle/) under developmen

{{% admonition type="note" %}}
This tutorial describes how to deploy Beyla in Kubernetes from scratch.
To use Helm, consult the [Deploy Beyla in Kubernetes with Helm]({{< relref "../setup/kubernetes-helm" >}}) documentation.
To use Helm, consult the [Deploy Beyla in Kubernetes with Helm](../../setup/kubernetes-helm/) documentation.
{{% /admonition %}}

# Beyla network metrics quickstart
Expand Down Expand Up @@ -56,7 +56,7 @@ Finally, network metrics requires administrative `sudo` privileges with the foll
- Full privileged access, `root`, `sudo`, or `privileged: true` for Kubernetes
- The following capabilities: `BPF`, `PERFMON`, `NET_ADMIN`, `SYS_RESOURCE`

To learn more about Beyla configuration, consult the [Beyla configuration documentation]({{< relref "../configure/options.md" >}}).
To learn more about Beyla configuration, consult the [Beyla configuration documentation](../../configure/options/).

## Example configuration

Expand Down Expand Up @@ -159,7 +159,7 @@ k8s.src.owner.name=local-path-provisioner k8s.src.owner.type=Deployment
k8s.dst.type=Service k8s.dst.owner.name=kubernetes
```

For further information on the attributes used, consult the [network metrics documentation]({{< relref "./_index.md" >}}).
For further information on the attributes used, consult the [network metrics documentation](./).

## Export OpenTelemetry metrics

Expand Down Expand Up @@ -213,7 +213,7 @@ Also Add `OTEL_EXPORTER_OTLP_ENDPOINT` and its value as an environment variable

## Select metrics attributes to reduce cardinality

Be default, Beyla includes the following [attributes]({{< relref "./_index.md" >}}) in the `beyla.network.flow.bytes` metric:
Be default, Beyla includes the following [attributes](./) in the `beyla.network.flow.bytes` metric:

- `k8s.src.owner.name`
- `k8s.src.namespace`
Expand Down
Loading
Loading