Skip to content

Commit

Permalink
add screenshots from running whole OTLP stack (under docker-compose, …
Browse files Browse the repository at this point in the history
…as documented)

Signed-off-by: JuanJo Ciarlante <juanjosec@gmail.com>
  • Loading branch information
jjo committed Feb 5, 2024
1 parent 9e4a081 commit 9353d05
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 14 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/outputs/images/otlp_traces-traces_view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/outputs/images/otlp_traces.png
Binary file not shown.
24 changes: 10 additions & 14 deletions docs/outputs/otlp_traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
- [Table of content](#table-of-content)
- [Configuration](#configuration)
- [Example of config.yaml](#example-of-configyaml)
- [Screenshots](#screenshots)
- [Additional info](#additional-info)
- [Running a whole stack with docker-compose](#running-a-whole-stack-with-docker-compose)

## Configuration

Expand Down Expand Up @@ -51,15 +52,7 @@ otlp:
> **Note**
The OTLP Traces are only available for the source: `syscalls`.

## Screenshots

With Grafana as UI and Tempo as traces backend:

![otlp_traces example](images/otlp_traces.png)

## Additional info

### Running a whole stack with docker-compose
## Running a whole stack with docker-compose

Below `docker-compose` file runs a stack of:

Expand All @@ -69,12 +62,12 @@ Below `docker-compose` file runs a stack of:
- [Tempo](https://grafana.com/oss/tempo/) as OTLP traces backend
- [Grafana](https://grafana.com/oss/grafana/) for visualization

#### Requirements
### Requirements

A local Linux kernel capable of running `falco`--modern-bpf`, see
<https://falco.org/blog/falco-modern-bpf/>.

#### Configuration files
### Configuration files

You need to create these files:

Expand Down Expand Up @@ -223,7 +216,7 @@ storage:
path: /tmp/tempo/blocks
```

#### Run it
### Run it

To bring up the stack, and peek at how Grafana shows it:

Expand All @@ -236,8 +229,11 @@ To bring up the stack, and peek at how Grafana shows it:
1. Navigate to <http://localhost:3000/> to start browsing the local Grafana UI

1. Navigate to [/explore](http://localhost:3000/explore/), choose `Tempo` datasource, and query `{}`, or just click [here](http://localhost:3000/explore?orgId=1&left=%7B%22datasource%22:%22tempo%22,%22queries%22:%5B%7B%22refId%22:%22A%22,%22datasource%22:%7B%22type%22:%22tempo%22,%22uid%22:%22tempo%22%7D,%22queryType%22:%22traceql%22,%22limit%22:20,%22query%22:%22%7B%7D%22%7D%5D) for such already crafted query.
![Grafana explore](images/otlp_traces-grafana_explore.png)

1. Click on any of the shown traces on the left panel.
1. Click on any of the shown traces on the left panel, you should see something
similar to the below attached screenshot.
![Falco traces view](images/otlp_traces-traces_view.png)

1. Bring down the stack

Expand Down

0 comments on commit 9353d05

Please sign in to comment.