Skip to content

Commit 326f244

Browse files
authored
Merge pull request #1730 from grafana/grafana-beyla-v2.0.x-robbymilo/relref-replace-beyla
[v2.0.x] Remove relref shortcodes
2 parents 215a5b6 + e4507ec commit 326f244

34 files changed

+94
-142
lines changed

docs/sources/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ isn't granted Beyla gracefully degrades its functionality to support only partia
7878

7979
## Get started
8080

81-
- Follow the [setup]({{< relref "./setup/_index.md" >}}) documentation to get started with Beyla either with Docker or Kubernetes.
81+
- Follow the [setup](setup/) documentation to get started with Beyla either with Docker or Kubernetes.
8282

83-
- Follow the [language quickstart guides]({{< relref "./quickstart" >}}) for quick instructions
83+
- Follow the [language quickstart guides](quickstart/) for quick instructions
8484
about how to set up Beyla to instrument applications written in a particular language.
8585

8686
## Learn more about Grafana Beyla

docs/sources/beyla-dashboard.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The dashboard contains the following components:
3737

3838
- A list with the slowest HTTP routes for all instrumented services. Since you only
3939
have a single service, only one entry appears. If you configure Beyla to
40-
[report the HTTP routes]({{< relref "./configure/routes-decorator.md" >}}),
40+
[report the HTTP routes](../configure/routes-decorator/),
4141
many entries could appear there, one for each HTTP path seen by the server.
4242
- A list with the slowest GRPC methods. Since the test service in this tutorial only
4343
serves HTTP, this table is empty.

docs/sources/cardinality.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ keywords:
1313

1414
# Beyla metrics cardinality
1515

16-
The cardinality of [Beyla metrics]({{< relref "./metrics.md" >}}) highly depends on the size and complexity
16+
The cardinality of [Beyla metrics](../metrics/) highly depends on the size and complexity
1717
of the instrumented environment, so there is no way to provide a simple and accurate formula.
1818

1919
This document tries to provide an approximation of the metrics cardinality that might

docs/sources/configure/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ aliases:
1212

1313
# Configure Beyla
1414

15-
You can configure Beyla by setting [export modes]({{< relref "./export-modes.md" >}}), global properties, and component options.
15+
You can configure Beyla by setting [export modes](export-modes/), global properties, and component options.
1616

1717
{{< section menuTitle="true" withDescriptions="true">}}
1818

19-
For information on the metrics Beyla exports, refer to the [exported metrics]({{< relref "../metrics.md" >}}) documentation.
19+
For information on the metrics Beyla exports, refer to the [exported metrics](../metrics/) documentation.
2020

21-
Refer to the [routes decorator]({{< relref "./routes-decorator.md" >}}) documentation to configure the low cardinality routes decorator is very important for optimal results.
21+
Refer to the [routes decorator](routes-decorator/) documentation to configure the low cardinality routes decorator is very important for optimal results.

docs/sources/configure/export-data.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Beyla uses lowercase fields for YAML configuration and uppercase names for envir
3737
| `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"]` |
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 | `["*"]` |
40-
| `buckets` | Sets how you can override bucket boundaries of diverse histograms, refer to [override histogram buckets]({{< relref "./metrics-histograms.md" >}}). | (n/a) | Object |
40+
| `buckets` | Sets how you can override bucket boundaries of diverse histograms, refer to [override histogram buckets](../metrics-histograms/). | (n/a) | Object |
4141
| `histogram_aggregation`<br>`OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION` | Sets the default aggregation Beyla uses for histogram instruments. Accepted values [`explicit_bucket_histogram`](https://opentelemetry.io/docs/specs/otel/metrics/sdk/#explicit-bucket-histogram-aggregation) or [`base2_exponential_bucket_histogram`](https://opentelemetry.io/docs/specs/otel/metrics/sdk/#base2-exponential-bucket-histogram-aggregation). | `string` | `explicit_bucket_histogram` |
4242

4343
### Metrics export protocol
@@ -49,7 +49,7 @@ If you don't set a protocol Beyla sets the protocol as follows:
4949

5050
### Metrics export features
5151

52-
The Beyla metrics exporter can export the following metrics data groups for processes matching entries in the [metrics discovery]({{< relref "./export-data.md" >}}) configuration.
52+
The Beyla metrics exporter can export the following metrics data groups for processes matching entries in the [metrics discovery](./) configuration.
5353

5454
- `application`: Application-level metrics
5555
- `application_span` Application-level trace span metrics
@@ -193,7 +193,7 @@ The purpose of this value is to avoid reporting indefinitely finished applicatio
193193
| `buckets` | (n/a) | Object |
194194

195195
The `buckets` object allows overriding the bucket boundaries of diverse histograms. See
196-
[Overriding histogram buckets]({{< relref "./metrics-histograms.md" >}}) section for more details.
196+
[Overriding histogram buckets](../metrics-histograms/) section for more details.
197197

198198
| YAML | Environment variable | Type | Default |
199199
| ---------- | --------------------------- | --------------- | ----------------- |
@@ -218,7 +218,7 @@ of Beyla: application-level metrics or network metrics.
218218
run the instrumented application.
219219
- If the list contains `network`, the Beyla Prometheus exporter exports network-level
220220
metrics; but only if the Prometheus `port` property is defined. For network-level metrics options visit the
221-
[network metrics]({{< relref "../network" >}}) configuration documentation.
221+
[network metrics](../../network/) configuration documentation.
222222

223223
| YAML | Environment variable | Type | Default |
224224
| ------------------------------------- | ------------------------------------------------------ | ------- | ------- |

docs/sources/configure/export-modes.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ The OTLP endpoint authentication credentials are provided by using the following
3636
- `OTEL_EXPORTER_OTLP_HEADERS`
3737

3838
To run in Direct mode by using the Prometheus scrape endpoint, please refer to the
39-
[configuration documentation]({{< relref "./options.md" >}}).
39+
[configuration documentation](../options/).
4040

4141
## Alloy mode
4242

4343
> ℹ️ This tutorial assumes that both Alloy and the auto-instrumentation tool are installed
4444
> as local Linux OS executables. For further examples on downloading and running the
4545
> auto-instrumentation tool as an OCI container, you can check the documentation sections on
46-
> [running the Beyla as a Docker container]({{< relref "../setup/docker.md" >}})
47-
> or [running Beyla in Kubernetes]({{< relref "../setup/kubernetes.md" >}}).
46+
> [running the Beyla as a Docker container](../../setup/docker/)
47+
> or [running Beyla in Kubernetes](../../setup/kubernetes/).
4848
4949
First, locally install and configure [Grafana Alloy, according to the latest documentation](/docs/alloy/).
5050
Alloy facilitates the ingestion of OpenTelemetry metrics and traces from the auto-instrumentation tool,
@@ -153,7 +153,7 @@ This tutorial assumes Beyla and Alloy are running on the same host, so there is
153153

154154
You can configure the auto-instrumentation tool both via environment variables or via
155155
a configuration YAML file, which is what we will use in this example.
156-
Please refer to the complete [Configuration documentation]({{< relref "./options.md" >}}) for
156+
Please refer to the complete [Configuration documentation](../options/) for
157157
more detailed description of each configuration option.
158158

159159
You can download the whole [example configuration file](https://github.com/grafana/beyla/blob/main/docs/sources/configure/resources/instrumenter-config.yml),

docs/sources/configure/filter-metrics-traces.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ filter:
2626
```
2727

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

3131
Each `application` and `network` filter section is a map where each key is an attribute
3232
name (either in Prometheus or OpenTelemetry format), with either the `match` or the `not_match` property. Both properties accept a

docs/sources/configure/internal-metrics-reporter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Specifies the internal metrics exporter. Accepted values are `disabled`, `promet
4242
Specifies the HTTP port for the Prometheus scrape endpoint. If unset or 0,
4343
no Prometheus endpoint is open and no metrics are accounted.
4444

45-
Its value can be the same as [`prometheus_export.port`]({{< relref "./export-data.md#prometheus-http-endpoint" >}}) (both metric families
45+
Its value can be the same as [`prometheus_export.port`](../export-data/#prometheus-http-endpoint) (both metric families
4646
share the same HTTP server, though they can be accessed in different paths),
4747
or a different value (two different HTTP servers for the different metric families).
4848

@@ -51,7 +51,7 @@ or a different value (two different HTTP servers for the different metric famili
5151
| `path` | `BEYLA_INTERNAL_METRICS_PROMETHEUS_PATH` | string | `/internal/metrics` |
5252

5353
Specifies the HTTP query path to fetch the list of Prometheus metrics.
54-
If [`prometheus_export.port`]({{< relref "./export-data.md#prometheus-http-endpoint" >}}) and `internal_metrics.prometheus.port` have the
54+
If [`prometheus_export.port`](../export-data/#prometheus-http-endpoint) and `internal_metrics.prometheus.port` have the
5555
same values, this `internal_metrics.prometheus.path` value can be
5656
different from `prometheus_export.path`, to keep both metric families separated,
5757
or the same (both metric families are listed in the same scrape endpoint).

docs/sources/configure/metrics-histograms.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@ For Prometheus, [native histograms](https://prometheus.io/docs/concepts/metric_t
6060
For OpenTelemetry you can use [exponential histograms](https://opentelemetry.io/docs/specs/otel/metrics/data-model/#exponentialhistogram)
6161
for the predefined histograms instead of defining the buckets manually. You need to set up the standard
6262
[OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION](https://opentelemetry.io/docs/specs/otel/metrics/sdk_exporters/otlp/#additional-configuration)
63-
environment variable. See the `histogram_aggregation` section in the [OTEL metrics exporter]({{< relref "./export-data.md" >}}) section
63+
environment variable. See the `histogram_aggregation` section in the [OTEL metrics exporter](../export-data/) section
6464
for more information.

docs/sources/configure/metrics-traces-attributes.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Grafana Beyla allows configuring how some attributes for metrics and traces
1414
are decorated. Under the `attributes` top YAML sections, you can enable
1515
other subsections configure how some attributes are set.
1616

17-
The [Beyla exported metrics]({{< relref "../metrics.md" >}}) document lists the attributes
17+
The [Beyla exported metrics](../../metrics/) document lists the attributes
1818
that can be reported with each metric. Some of the attributes are reported by default while
1919
others are hidden to control the cardinality.
2020

@@ -24,7 +24,7 @@ and each metric has two more sub-properties: `include` and `exclude`.
2424

2525
* `include` is a list of attributes that need to be reported. Each attribute can be an attribute
2626
name or a wildcard (for example, `k8s.dst.*` to include all the attributes starting with `k8s.dst`).
27-
If no `include` list is provided, the default attribute set is reported (check [Beyla exported metrics]({{< relref "../metrics.md" >}})
27+
If no `include` list is provided, the default attribute set is reported (check [Beyla exported metrics](../../metrics/)
2828
for more information about the default attributes for a given metric).
2929
* `exclude` is a list to of attribute names/wildcards containing the attributes to remove from the
3030
`include` list (or the default attribute set).
@@ -83,7 +83,7 @@ Beyla to propagate any incoming context to downstream services. This context pro
8383
support works for any programming language and it's implemented by using Linux Traffic Control
8484
(TC). Because Linux Traffic Control is sometimes used by other eBPF programs, this option
8585
requires that the other eBPF programs chain correctly with Beyla. For more information on
86-
this topic, see our documentation related to [Cilium CNI]({{< relref "../cilium-compatibility.md" >}}).
86+
this topic, see our documentation related to [Cilium CNI](../../cilium-compatibility/).
8787
This context propagation support is fully compatible with any OpenTelemetry
8888
distributed tracing library.
8989

@@ -99,7 +99,7 @@ following configuration must be specified:
9999
gRPC and HTTP2 are not supported at the moment.
100100

101101
For an example of how to configure distributed traces in Kubernetes, see our
102-
[Distributed traces with Beyla]({{< relref "../distributed-traces.md" >}}) guide.
102+
[Distributed traces with Beyla](../../distributed-traces/) guide.
103103

104104
| YAML | Environment variable | Type | Default |
105105
| ----------------------- | --------------------------------- | ------- | ------- |
@@ -191,7 +191,7 @@ attributes:
191191

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

196196
| YAML | Environment variable | Type | Default |
197197
| -------- | ---------------------------- | ------- | ------- |

docs/sources/configure/options.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ or
2929
$ BEYLA_OPEN_PORT=8080 BEYLA_CONFIG_PATH=/path/to/config.yaml beyla
3030
```
3131

32-
Refer to the [example YAML configuration file]({{< relref "./example.md" >}}) for configuration file template.
32+
Refer to the [example YAML configuration file](../example/) for configuration file template.
3333

3434
Currently, Beyla consist of a pipeline of components which
3535
generate, transform, and export traces from HTTP and GRPC applications. In the
3636
YAML configuration, each component has its own first-level section.
3737

3838
Optionally, Beyla also provides network-level metrics, which are documented in the
39-
[Network metrics section of the Beyla documentation]({{< relref "../network/_index.md" >}}).
39+
[Network metrics section of the Beyla documentation](../../network/).
4040

4141
The following sections explain the global configuration properties, as well as
4242
the options for each component.
@@ -56,7 +56,7 @@ where the executable resides on the file system.
5656

5757
This property is used to select a single process to instrument, or a group of processes of
5858
similar characteristics. For more fine-grained process selection and grouping, you can
59-
follow the instructions in the [service discovery section]({{< relref "./service-discovery.md" >}}).
59+
follow the instructions in the [service discovery section](../service-discovery/).
6060

6161
If the `open_port` property is set, the executable to be selected needs to match both properties.
6262

@@ -94,7 +94,7 @@ Would make Beyla to select any executable that opens port 80, 443, or any of the
9494
9595
This property is used to select a single process to instrument, or a group of processes of
9696
similar characteristics. For more fine-grained process selection and grouping, you can
97-
follow the instructions in the [service discovery section]({{< relref "./service-discovery.md" >}}).
97+
follow the instructions in the [service discovery section](../service-discovery/).
9898
9999
If the `executable_name` property is set, the executable to be selected needs to match both properties.
100100

@@ -108,36 +108,36 @@ owning one of the ports in the range.
108108

109109
| YAML | Environment variable | Type | Default |
110110
|----------------| ------------------------------------------- | ------ |---------------------------------------------------------------------------------|
111-
| `service_name` | `BEYLA_SERVICE_NAME` | string | (refer to [service discovery]({{< relref "./service-discovery.md" >}}) section) |
111+
| `service_name` | `BEYLA_SERVICE_NAME` | string | (refer to [service discovery](../service-discovery/) section) |
112112

113113
**Deprecated**
114114

115115
Overrides the name of the instrumented service to be reported by the metrics exporter.
116116
Defining this property is equivalent to add a `name` entry into the [`discovery.services` YAML
117-
section]({{< relref "./service-discovery.md" >}}).
117+
section](../service-discovery/).
118118

119119
This configuration option is deprecated. If a single instance of Beyla is instrumenting multiple instances of different processes,
120120
they will share the same service name even if they are different. If you need that a
121121
single instance of Beyla report different service names, follow the instructions on how to
122-
[override the service name and namespace]({{< relref "./service-discovery.md" >}}) in the service discovery documentation
122+
[override the service name and namespace](../service-discovery/) in the service discovery documentation
123123
to enable automatic configuration of service name and namespace from diverse metadata sources.
124124

125125
| YAML | Environment variable | Type | Default |
126126
| ------------------- | ------------------------- | ------ |---------------------------------------------------------------------------------|
127-
| `service_namespace` | `BEYLA_SERVICE_NAMESPACE` | string | (refer to [service discovery]({{< relref "./service-discovery.md" >}}) section) |
127+
| `service_namespace` | `BEYLA_SERVICE_NAMESPACE` | string | (refer to [service discovery](../service-discovery/) section) |
128128

129129
**Deprecated**
130130

131131
Optionally, allows assigning a namespace for the service selected from the `executable_name`
132132
or `open_port` properties.
133133

134134
Defining this property is equivalent to add a `name` entry into the [`discovery.services` YAML
135-
section]({{< relref "./service-discovery.md" >}}).
135+
section](../service-discovery/).
136136

137137
This configuration option is deprecated, as it assumes a single namespace for all the services instrumented
138138
by Beyla. If you need that a single instance of Beyla groups multiple services
139139
into different namespaces, follow the instructions on how to
140-
[override the service name and namespace]({{< relref "./service-discovery.md" >}}) in the service discovery documentation
140+
[override the service name and namespace](../service-discovery/) in the service discovery documentation
141141
to enable automatic configuration of service name and namespace from diverse metadata sources.
142142

143143
| YAML | Environment variable | Type | Default |

0 commit comments

Comments
 (0)