Skip to content

Commit

Permalink
Fix docs links and build warnings (#636)
Browse files Browse the repository at this point in the history
* Fix link
* Image alt text
  • Loading branch information
grafsean authored Feb 21, 2024
1 parent fcdf9db commit 2cc40cc
Show file tree
Hide file tree
Showing 11 changed files with 16 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/sources/configure/export-modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Beyla can export data in two modes:
(using the OpenTelemetry/OTEL protocols) or expose a Prometheus HTTP endpoint ready to be scraped (i.e. **pull** mode).
In the direct OTEL push mode, the auto-instrumentation tool needs to be configured with the authentication credentials.

![](https://grafana.com/media/docs/grafana-cloud/beyla/agent-vs-direct.png)
![Beyla architecture agent vs direct](https://grafana.com/media/docs/grafana-cloud/beyla/agent-vs-direct.png)

<center><i>Beyla running in Agent mode (left) vs. Direct mode (right)</i></center>

Expand Down Expand Up @@ -56,9 +56,9 @@ to the different Grafana product endpoints (Mimir and/or Tempo).
### Configuring the Agent pipeline

Next, you'll need to specify the following nodes by using the
[River configuration language](/docs/agent/latest/flow/config-language/):
[River configuration language](/docs/agent/latest/flow/):

![](https://grafana.com/media/docs/grafana-cloud/beyla/nodes.png)
![Beyla nodes](https://grafana.com/media/docs/grafana-cloud/beyla/nodes.png)

You can download the [example of the whole River configuration file](/docs/beyla/latest/configure/resources/agent-config.river), which will be explained in the rest of this section.

Expand Down
6 changes: 0 additions & 6 deletions docs/sources/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ This section shows how to quickly instrument your applications for different pro
- [Quickstart: instrument a Rust service with Beyla]({{< relref "./rust.md" >}})
- [Quickstart: instrument a Java service with Beyla]({{< relref "./java.md" >}})

<!-- TODO: uncomment as long as we create new entries
* [Quickstart: instrument a .NET service with Beyla]({{< relref "./dotnet.md" >}})
* [Quickstart: instrument a Nginx server with Beyla]({{< relref "./nginx.md" >}})
* [Quickstart: instrument an Apache HTTP server with Beyla]({{< relref "./apache.md" >}})
-->

For more information about the different ways you can deploy Beyla (standalone Linux process, Docker container,
Kubernetes Pod or DaemonSet), refer to the [Set up Beyla]({{< relref "../setup" >}}) section.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/golang.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/quickstart/rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The above trace shows:

After a few minutes traces will appear in Grafana Cloud. For example, in the traces explorer:

![](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)
![Beyla traces explorer](https://grafana.com/media/docs/grafana-cloud/beyla/quickstart/trace-generic.png)

## 6. Configure routing

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/requesttime.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ eBPF allows us to overcome the limitations of manual instrumentation tools. Beyl

Beyla reports traces that are divided in different spans:

![](https://grafana.com/media/docs/grafana-cloud/beyla/server-side-trace.png)
![Beyla traces and spans](https://grafana.com/media/docs/grafana-cloud/beyla/server-side-trace.png)

The above image shows the typical structure of a trace as reported by Beyla:

Expand Down
10 changes: 5 additions & 5 deletions docs/sources/tutorial/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ After being the eBPF binaries have been verified they are compiled with a Just-I

The eBPF code is loaded from ordinary applications running in user space. The kernel and the user space applications can share information through a set of well defined communication mechanisms, which are provided by the eBPF specification. For example: ring buffers, arrays, hash maps, etc.

![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/ebpf-arch.svg)
![Beyla eBPF architecture](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/ebpf-arch.svg)

## Running an instrumented service

Expand Down Expand Up @@ -188,7 +188,7 @@ There are two ways to forward your OpenTelemetry traces to Grafana Cloud:
In your Grafana Cloud Portal, click on the "Details" button in the "OpenTelemetry" box. Next,
copy your Grafana OTLP Endpoint and Instance ID, as in the image below.

![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/otlp-connection-details.png)
![Beyla OTLP connection details](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/otlp-connection-details.png)

Also generate a Password/API token with metrics push privileges.

Expand Down Expand Up @@ -223,7 +223,7 @@ To verify that metrics are properly received by Grafana, you can go to the left
choose the Explore tab and your Prometheus data source. Next, write `http_` in the
Metrics Browser input field and you should see the available metric names in the auto-complete drop-down.

![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/dropdown-metrics-v1.0.png)
![Beyla metrics](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/dropdown-metrics-v1.0.png)

## Add the Beyla RED Metrics Dashboard

Expand All @@ -234,7 +234,7 @@ your auto-instrumented RED metrics; to save you time, we provide a sample
To import the sample dashboard into your Grafana instance, choose "Dashboards" in the Grafana left panel.
Next, in the Dashboards page, click on the "New" drop-down menu and select "Import":

![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/import-dashboard.png)
![Beyla import dashboard](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/import-dashboard.png)

In the "Import via grafana.com" textbox, copy the Grafana ID from the
[Beyla RED Metrics](/grafana/dashboards/19923-beyla-red-metrics/)
Expand All @@ -245,7 +245,7 @@ data source in the `prometheus-data-source` drop-down at the bottom.

And _voilà!_ you can see some of your test RED metrics:

![](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/beyla-dashboard-screenshot-v1.0.png)
![Beyla RED metrics](https://grafana.com/media/docs/grafana-cloud/beyla/tutorial/beyla-dashboard-screenshot-v1.0.png)

The dashboard contains the following components:

Expand Down

0 comments on commit 2cc40cc

Please sign in to comment.