Skip to content
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

24 feat change tag marker from killercoda to interactive #30

Merged
merged 3 commits into from
Jun 26, 2024
Merged

24 feat change tag marker from killercoda to interactive #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02e6084
feat: Updated parser directive from Killercoda -> INTERACTIVE
Jayclifford345 Jun 26, 2024
b314ea1
Updated docs to use new derective
Jayclifford345 Jun 26, 2024
2109136
Merge branch 'staging' into 24-feat-change-tag-marker-from-killercoda…
jdbaldry Jun 26, 2024
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
72 changes: 36 additions & 36 deletions docs/examples/complete-docs-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ killercoda:
imageid: ubuntu
---

<!-- Killercoda intro.md START -->
<!-- INTERACTIVE intro.md START -->

# Sending OpenTelemetry logs to Loki using Alloy

Expand All @@ -29,11 +29,11 @@ Before you begin, ensure you have the following to run the demo:
- Docker
- Docker Compose

<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->
{{< admonition type="note" >}}
Alternatively, you can try out this example in our online sandbox. Which is a fully configured environment with all the dependencies pre-installed. You can access the sandbox [here](https://killercoda.com/grafana-labs/course/loki/alloy-otel-logs).
{{< /admonition >}}
<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->

## Scenario

Expand All @@ -49,34 +49,34 @@ In this scenario, we have a microservices application called the Carnivourse Gre

Each service generates logs using the OpenTelemetry SDK and exports to Alloy in the OpenTelemetry format. Alloy then ingests the logs and sends them to Loki. We will configure Alloy to ingest OpenTelemetry logs, send them to Loki, and view the logs in Grafana.

<!-- Killercoda intro.md END -->
<!-- INTERACTIVE intro.md END -->

<!-- Killercoda step1.md START -->
<!-- INTERACTIVE step1.md START -->

## Step 1: Environment setup

In this step, we will set up our environment by cloning the repository that contains our demo application and spinning up our observability stack using Docker Compose.

1. To get started, clone the repository that contains our demo application:
<!-- Killercoda exec START -->
<!-- INTERACTIVE exec START -->
```bash
git clone -b microservice-otel https://github.com/grafana/loki-fundamentals.git
```
<!-- Killercoda exec END -->
<!-- INTERACTIVE exec END -->
1. Next we will spin up our observability stack using Docker Compose:

<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->
```bash
docker compose -f loki-fundamentals/docker-compose.yml up -d
```
<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->

<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->

<!-- ```bash -->
<!-- docker-compose -f loki-fundamentals/docker-compose.yml up -d -->
<!-- ```{{exec}} -->
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->

This will spin up the following services:
```bash
Expand All @@ -88,24 +88,24 @@ In this step, we will set up our environment by cloning the repository that cont
We will be access two UI interfaces:
- Alloy at [http://localhost:12345](http://localhost:12345)
- Grafana at [http://localhost:3000](http://localhost:3000)
<!-- Killercoda step1.md END -->
<!-- INTERACTIVE step1.md END -->

<!-- Killercoda step2.md START -->
<!-- INTERACTIVE step2.md START -->

## Step 2: Configure Alloy to ingest OpenTelemetry logs

To configure Alloy to ingest OpenTelemetry logs, we need to update the Alloy configuration file. To start, we will update the `config.alloy` file to include the OpenTelemetry logs configuration.

<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->
<!-- **Note: Killercoda has an inbuilt Code editor which can be accessed via the `Editor` tab.** -->
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->

### OpenTelelmetry Logs Receiver

First, we will configure the OpenTelemetry logs receiver. This receiver will accept logs via HTTP and gRPC.

Open the `config.alloy` file in the `loki-fundamentals` directory and copy the following configuration:
<!-- Killercoda copy START -->
<!-- INTERACTIVE copy START -->

```alloy
otelcol.receiver.otlp "default" {
Expand All @@ -118,90 +118,90 @@ Open the `config.alloy` file in the `loki-fundamentals` directory and copy the f
}
```

<!-- Killercoda copy END -->
<!-- INTERACTIVE copy END -->


### OpenTelemetry Logs Processor

Next, we will configure the OpenTelemetry logs processor. This processor will batch the logs before sending them to the logs exporter.

Open the `config.alloy` file in the `loki-fundamentals` directory and copy the following configuration:
<!-- Killercoda copy START -->
<!-- INTERACTIVE copy START -->
```alloy
otelcol.processor.batch "default" {
output {
logs = [otelcol.exporter.otlphttp.default.input]
}
}
```
<!-- Killercoda copy END -->
<!-- INTERACTIVE copy END -->

### OpenTelemetry Logs Exporter

Lastly, we will configure the OpenTelemetry logs exporter. This exporter will send the logs to Loki.

Open the `config.alloy` file in the `loki-fundamentals` directory and copy the following configuration:
<!-- Killercoda copy START -->
<!-- INTERACTIVE copy START -->
```alloy
otelcol.exporter.otlphttp "default" {
client {
endpoint = "http://loki:3100/otlp"
}
}
```
<!-- Killercoda copy END -->
<!-- INTERACTIVE copy END -->

### Reload the Alloy configuration

Once added, save the file. Then run the following command to request Alloy to reload the configuration:
<!-- Killercoda exec START -->
<!-- INTERACTIVE exec START -->
```bash
curl -X POST http://localhost:12345/-/reload
```
<!-- Killercoda exec END -->
<!-- INTERACTIVE exec END -->

The new configuration will be loaded this can be verified by checking the Alloy UI: [http://localhost:12345](http://localhost:12345).

## Stuck? Need help?

If you get stuck or need help creating the configuration, you can copy and replace the entire `config.alloy` using the completed configuration file:

<!-- Killercoda exec START -->
<!-- INTERACTIVE exec START -->
```bash
cp loki-fundamentals/completed/config.alloy loki-fundamentals/config.alloy
curl -X POST http://localhost:12345/-/reload
```
<!-- Killercoda exec END -->
<!-- INTERACTIVE exec END -->

<!-- Killercoda step2.md END -->
<!-- INTERACTIVE step2.md END -->

<!-- Killercoda step3.md START -->
<!-- INTERACTIVE step3.md START -->

## Step 3: Start the Carnivorous Greenhouse

In this step, we will start the Carnivorous Greenhouse application. To start the application, run the following command:
<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->
{{< admonition type="note" >}}
This docker-compose file relies on the `loki-fundamentals_loki` docker network. If you have not started the observability stack, you will need to start it first.
{{< /admonition >}}
<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->

<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->
<!-- **Note: This docker-compose file relies on the `loki-fundamentals_loki` docker network. If you have not started the observability stack, you will need to start it first.** -->
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->

<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->
```bash
docker compose -f lloki-fundamentals/greenhouse/docker-compose-micro.yml up -d --build
```
<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->

<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->

<!-- ```bash -->
<!-- docker-compose -f loki-fundamentals/greenhouse/docker-compose-micro.yml up -d --build -->
<!-- ```{{exec}} -->
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->

This will start the following services:
```bash
Expand All @@ -224,4 +224,4 @@ Once started, you can access the Carnivorous Greenhouse application at [http://l
Finally to view the logs in Loki, navigate to the Loki Logs Explore view in Grafana at [http://localhost:3000/a/grafana-lokiexplore-app/explore](http://localhost:3000/a/grafana-lokiexplore-app/explore).


<!-- Killercoda step3.md END -->
<!-- INTERACTIVE step3.md END -->
46 changes: 23 additions & 23 deletions docs/transformer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,25 +66,25 @@ Copy directives tell the transform tool to make the contained fenced code block
The start marker is:

```markdown
<!-- Killercoda copy START -->
<!-- INTERACTIVE copy START -->
```

The end marker is:

```markdown
<!-- Killercoda copy END -->
<!-- INTERACTIVE copy END -->
```

#### Examples

````markdown
<!-- Killercoda copy START -->
<!-- INTERACTIVE copy START -->

```bash
echo 'Hello, world!'
```

<!-- Killercoda copy END -->
<!-- INTERACTIVE copy END -->
````

Produces:
Expand All @@ -106,25 +106,25 @@ Exec directives tell the transform tool to make the contained fenced code block
The start marker is:

```markdown
<!-- Killercoda exec START -->
<!-- INTERACTIVE exec START -->
```

The end marker is:

```markdown
<!-- Killercoda exec END -->
<!-- INTERACTIVE exec END -->
```

#### Examples

````markdown
<!-- Killercoda exec START -->
<!-- INTERACTIVE exec START -->

```bash
echo 'Hello, world!'
```

<!-- Killercoda exec END -->
<!-- INTERACTIVE exec END -->
````

Produces:
Expand All @@ -146,13 +146,13 @@ The finish directive specifies the start and end of the section of the file to u
The start marker is:

```markdown
<!-- Killercoda finish.md START -->
<!-- INTERACTIVE finish.md START -->
```

The end marker is:

```markdown
<!-- Killercoda finish.md END -->
<!-- INTERACTIVE finish.md END -->
```

### Ignore
Expand All @@ -162,25 +162,25 @@ The ignore directive tells the transform tool to skip the contents within the ma
The start marker is:

```markdown
<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->
```

The end marker is:

```markdown
<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->
```

#### Examples

```markdown
Information common to both pages.

<!-- Killercoda ignore START -->
<!-- INTERACTIVE ignore START -->

Information unique to the Grafana website page.

<!-- Killercoda ignore END -->
<!-- INTERACTIVE ignore END -->
```

Produces:
Expand All @@ -197,23 +197,23 @@ The HTML comments aren't rendered on the Grafana website.
The start marker is:

```markdown
<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->
```

The end marker is:

```markdown
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->
```

#### Examples

```markdown
Information common to both pages.

<!-- Killercoda include START -->
<!-- INTERACTIVE include START -->
<!-- Information unique to the Killercoda page. -->
<!-- Killercoda include END -->
<!-- INTERACTIVE include END -->
```

Produces:
Expand All @@ -231,13 +231,13 @@ The intro directive specifies the start and end of the section of the file to us
The start marker is:

```markdown
<!-- Killercoda intro.md START -->
<!-- INTERACTIVE intro.md START -->
```

The end marker is:

```markdown
<!-- Killercoda intro.md END -->
<!-- INTERACTIVE intro.md END -->
```

### Step
Expand All @@ -247,13 +247,13 @@ The step directive specifies the start and end of the section of the file to use
The start marker is the following, where _`<N>`_ is the number of the step:

```markdown
<!-- Killercoda step<N>.md START -->
<!-- INTERACTIVE step<N>.md START -->
```

The end marker is the following, where _`<N>`_ is the number of the step:

```markdown
<!-- Killercoda step<N>.md END -->
<!-- INTERACTIVE step<N>.md END -->
```

## Generate a tutorial
Expand Down Expand Up @@ -299,7 +299,7 @@ To generate a tutorial:

Each step starts at the [step](#step) directive start marker and ends at the [step](#step) directive end marker.
Include at least one step.
The first step use the start marker `<!-- Killercoda step1.md START -->` and the end marker `<!-- Killercoda step1.md END -->`
The first step use the start marker `<!-- INTERACTIVE step1.md START -->` and the end marker `<!-- INTERACTIVE step1.md END -->`

1. Configure a finish page.

Expand Down
4 changes: 2 additions & 2 deletions loki/alloy-otel-logs/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"title": "Ingesting OpenTelemetry logs to Loki using Alloy",
"description": "Configuring Grafana Alloy to ingest OpenTelemetry logs to Loki.",
"title": "Sending OpenTelemetry logs to Loki using Alloy",
"description": "Configuring Grafana Alloy to send OpenTelemetry logs to Loki.",
"details": {
"intro": {
"text": "intro.md"
Expand Down
Loading
Loading