Skip to content

Commit

Permalink
chore(examples): Updating vendor examples (#3966)
Browse files Browse the repository at this point in the history 
* chore(examples): Updating vendor examples

* updating new relic example

* updating new relic example

* updating new relic example

* updating datadog example

* updating dynatrace example

* updating honeycomb example

* updating signoz example

* updating signoz example

* PR suggestions updates

* updating recipes

* PR comments update
  • Loading branch information
@xoscar
xoscar authored Aug 15, 2024
1 parent 82a7f09 commit 182c468
Show file tree
Hide file tree
Showing 80 changed files with 1,227 additions and 2,780 deletions.
300 changes: 84 additions & 216 deletions docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,33 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v1.3.0`

## Prerequisites

You will need [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine to run this sample app! Additionally, you will need a Datadog account and an API. Sign up to Datadog on their [homepage](https://www.datadoghq.com/) by clicking on `Get Started Free`.
**Tracetest Account**:

- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs.
- Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token).

**Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine.

## Run This Quckstart Example

The example below is provided as part of the Tracetest project. You can download and run the example by following these steps:

Clone the Tracetest project and go to the example folder:

```bash
git clone https://github.com/kubeshop/tracetest
cd tracetest/examples/tracetest-datadog
```

Follow these instructions to run the quick start:

1. Copy the `.env.template` file to `.env`.
2. Fill out the [TRACETEST_TOKEN and ENVIRONMENT_ID](https://app.tracetest.io/retrieve-token) details by editing your `.env` file.
3. Fill out the [DATADOG_API_KEY](https://www.datadoghq.com/) details by editing your `.env` file.
4. Run `docker compose run tracetest-run`.
5. Follow the links in the output to view the test results.

Follow the sections below for a detailed breakdown of what the example you just ran did and how it works.

## Project Structure

Expand All @@ -36,16 +62,9 @@ The project is built with Docker Compose. It contains two distinct `docker-compo

The `docker-compose.yaml` file and `.env` file in the root directory are for the OpenTelemetry Demo.

### 2. Tracetest

The `docker-compose.yaml` file, `collector.config.yaml`, `tracetest-provision.yaml`, and `tracetest-config.yaml` in the `tracetest` directory are for setting up Tracetest and the OpenTelemetry Collector.

The `tracetest` directory is self-contained and will run all the prerequisites for enabling OpenTelemetry traces and trace-based testing with Tracetest, as well as routing all traces the OpenTelemetry Demo generates to Datadog.

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network, defined by the `networks` section on each file, and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where port `4317` is the port where Tracetest accepts traces.

All `services` in the `docker-compose.yaml` are on the same network, defined by the `networks` section on each file, and will be reachable by hostname from within other services. E.g. `tracetest-agent:4317` in the `collector.config.yaml` will map to the `tracetest-agent` service, where port `4317` is the port where Tracetest Agent accepts traces.

## OpenTelemetry Demo

Expand All @@ -63,153 +82,11 @@ docker compose up

This will start the OpenTelemetry Demo. Open up `http://localhost:8084` to make sure it's working. But, you're not sending the traces anywhere.

Let's fix this by configuring Tracetest and the OpenTelemetry Collector to forward trace data to both Lightstep and Tracetest.

## Tracetest

The `docker-compose.yaml` in the `tracetest` directory is configured with three services.

- **Postgres** - Postgres is a prerequisite for Tracetest to work. It stores trace data when running trace-based tests.
- [**OpenTelemetry Collector**](https://opentelemetry.io/docs/collector/) - A vendor-agnostic implementation of how to receive, process and export telemetry data. To support sending traces to Datadog, we are using the [`contrib` version](https://github.com/open-telemetry/opentelemetry-collector-contrib), which contains vendor-related code.
- [**Tracetest**](https://tracetest.io/) - Trace-based testing that generates end-to-end tests automatically from traces.

```yaml
version: "3.9"

networks:
default:
name: opentelemetry-demo
driver: bridge

services:
tracetest:
restart: unless-stopped
image: kubeshop/tracetest:${TAG:-latest}
container_name: tracetest
platform: linux/amd64
ports:
- 11633:11633
extra_hosts:
- "host.docker.internal:host-gateway"
volumes:
- type: bind
source: ./tracetest-config.yaml
target: /app/tracetest.yaml
- type: bind
source: ./tracetest-provision.yaml
target: /app/provisioning.yaml
command: --provisioning-file /app/provisioning.yaml
healthcheck:
test: ["CMD", "wget", "--spider", "localhost:11633"]
interval: 1s
timeout: 3s
retries: 60
depends_on:
tt-postgres:
condition: service_healthy
otel-collector:
condition: service_started
environment:
TRACETEST_DEV: ${TRACETEST_DEV}

tt-postgres:
image: postgres:14
container_name: tt-postgres
environment:
POSTGRES_PASSWORD: postgres
POSTGRES_USER: postgres
healthcheck:
test: pg_isready -U "$$POSTGRES_USER" -d "$$POSTGRES_DB"
interval: 1s
timeout: 5s
retries: 60

otel-collector:
image: otel/opentelemetry-collector-contrib:0.68.0
container_name: otel-collector
restart: unless-stopped
command:
- "--config"
- "/otel-local-config.yaml"
volumes:
- ./tracetest/collector.config.yaml:/otel-local-config.yaml

```

Tracetest depends on both Postgres and the OpenTelemetry Collector. Both Tracetest and the OpenTelemetry Collector require config files to be loaded via a volume. The volumes are mapped from the root directory into the `tracetest` directory and the respective config files.

To start both the OpenTelemetry Demo and Tracetest we will run this command:

```bash
docker-compose -f docker-compose.yaml -f tracetest/docker-compose.yaml up
```

The `tracetest-config.yaml` file contains the basic setup of connecting Tracetest to the Postgres instance and telemetry exporter. The exporter is set to the OpenTelemetry Collector.

```yaml
# tracetest-config.yaml

---
postgres:
host: postgres
user: postgres
password: postgres
port: 5432
dbname: postgres
params: sslmode=disable

telemetry:
exporters:
collector:
serviceName: tracetest
sampling: 100
exporter:
type: collector
collector:
endpoint: otel-collector:4317

server:
telemetry:
exporter: collector
applicationExporter: collector
```
The `tracetest-provision.yaml` file contains the setup of the demo APIs that Tracetest can use as an example for tests, the polling profiles that say how Tracetest should fetch traces from the data store and the configuration for the data store, in our case, Datadog.

```yaml
---
type: Demo
spec:
name: "OpenTelemetry Shop"
enabled: true
type: otelstore
opentelemetryStore:
frontendEndpoint: http://frontend:8084
productCatalogEndpoint: productcatalogservice:3550
cartEndpoint: cartservice:7070
checkoutEndpoint: checkoutservice:5050
---
type: PollingProfile
spec:
name: Default
strategy: periodic
default: true
periodic:
retryDelay: 5s
timeout: 180s
---
type: DataStore
spec:
name: datadog
type: datadog
```
Let's fix this by configuring Tracetest and the OpenTelemetry Collector to forward trace data to both Datadog and Tracetest.

**Sending Traces to Tracetest and Datadog**

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:4317` in one pipeline, and to Datadog in another.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's Agent OTLP endpoint `tracetest-agent:4317` in one pipeline, and to Datadog in another.

Make sure to add your Datadog API Key to the `datadog` exporter.

Expand All @@ -219,6 +96,35 @@ receivers:
protocols:
http:
grpc:
# The hostmetrics receiver is required to get correct infrastructure metrics in Datadog.
hostmetrics:
collection_interval: 10s
scrapers:
paging:
metrics:
system.paging.utilization:
enabled: true
cpu:
metrics:
system.cpu.utilization:
enabled: true
disk:
filesystem:
metrics:
system.filesystem.utilization:
enabled: true
load:
memory:
network:
processes:
# The prometheus receiver scrapes metrics needed for the OpenTelemetry Collector Dashboard.
prometheus:
config:
scrape_configs:
- job_name: 'otelcol'
scrape_interval: 10s
static_configs:
- targets: ['0.0.0.0:8888']

processors:
batch: # this configuration is needed to guarantee that the data is sent correctly to Datadog
Expand All @@ -229,18 +135,16 @@ processors:
exporters:
# OTLP for Tracetest
otlp/tracetest:
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest-agent:4317
tls:
insecure: true
# Datadog exporter
# One example on how to set up a collector configuration for Datadog can be seen here:
# https://docs.datadoghq.com/opentelemetry/otel_collector_datadog_exporter/?tab=onahost
datadog:
api:
site: datadoghq.com
key: ${DATADOG_API_KEY} # Add here you API key for Datadog
# One example on how to set up a collector configuration for Datadog can be seen here:
# https://docs.datadoghq.com/opentelemetry/otel_collector_datadog_exporter/?tab=onahost
key: ${env:DATADOG_API_KEY} # Add here you API key for Datadog

service:
pipelines:
Expand All @@ -252,52 +156,20 @@ service:
receivers: [otlp]
processors: [batch]
exporters: [datadog]
metrics:
receivers: [hostmetrics, otlp]
processors: [batch]
exporters: [datadog]
```
## Run Both the OpenTelemetry Demo App and Tracetest

To start both OpenTelemetry and Tracetest, run this command:

```bash
docker-compose -f docker-compose.yaml -f tracetest/docker-compose.yaml up
```

This will start your Tracetest instance on `http://localhost:11633/`.

Open the URL and [start creating tests in the Web UI](https://docs.tracetest.io/web-ui/creating-tests)! Make sure to use the endpoints within your Docker network like `http://frontend:8084/` when creating tests.

This is because your OpenTelemetry Demo and Tracetest are in the same network.

> Note: View the `demo` section in the `tracetest.config.yaml` to see which endpoints from the OpenTelemetry Demo are available for running tests.

Here's a sample of a failed test run, which happens if you add this assertion:

```css
attr:tracetest.span.duration < 10ms
```

![](../img/datadog-recipe-failed-test.png)

Increasing the duration to a more reasonable `500ms` will make the test pass.

![](../img/datadog-recipe-successful-test.png)
## Running the Tests
## Run Tracetest Tests with the Tracetest CLI
### The Test File
First, [install the CLI](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli).
Then, configure the CLI:

```bash
tracetest configure --server-url http://localhost:11633
```

Once configured, you can run a test against the Tracetest instance via the terminal.

Check out the `http-test.yaml` file.
Check out the `resources/test.yaml` file.

```yaml
# http-test.yaml
# resources/test.yaml
type: Test
spec:
id: JBYAfKJ4R
Expand Down Expand Up @@ -325,32 +197,28 @@ spec:
- attr:rpc.grpc.status_code = 0
```

This file defines a test the same way you would through the Web UI.

To run the test, run this command in the terminal:

```bash
tracetest run test -f ./http-test.yaml
docker compose run tracetest-run
```

This test will fail just like the sample above due to the `attr:tracetest.span.duration < 10ms` assertion.
This test will fail just like the sample above due to the `attr:tracetest.span.duration < 50ms` assertion.

```bash
✘ OpenTelemetry Shop - List Products (http://localhost:11633/test/JBYAfKJ4R/run/3/test)
✘ span[tracetest.span.type="general" name="Tracetest trigger"]
✘ #2d1b0dcbd75b3a42
✔ attr:tracetest.response.status = 200 (200)
✘ attr:tracetest.span.duration < 10ms (24ms) (http://localhost:11633/test/JBYAfKJ4R/run/3/test?selectedAssertion=0&selectedSpan=2d1b0dcbd75b3a42)
✔ span[tracetest.span.type="rpc" name="grpc.hipstershop.ProductCatalogService/ListProducts"]
✔ #90aeab1e9db4617b
✔ attr:rpc.grpc.status_code = 0 (http://localhost:11633/test/JBYAfKJ4R/run/3/test?selectedAssertion=1)
✔ span[tracetest.span.type="rpc" name="hipstershop.ProductCatalogService/ListProducts" rpc.system="grpc" rpc.method="ListProducts" rpc.service="hipstershop.ProductCatalogService"]
✔ #44b836b092b4d708
✔ attr:rpc.grpc.status_code = 0 (http://localhost:11633/test/JBYAfKJ4R/run/3/test?selectedAssertion=2)
✘ Otel - List Products (http://localhost:11633/test/YJmFC7hVg/run/9/test)
✘ span[tracetest.span.type="http" name="API HTTP GET" http.target="/api/products" http.method="GET"]
✘ #cb68ccf586956db7
✔ attr:http.status_code = 200 (200)
✘ attr:tracetest.span.duration < 50ms (72ms) (http://localhost:11633/test/YJmFC7hVg/run/9/test?selectedAssertion=0&selectedSpan=cb68ccf586956db7)
✔ span[tracetest.span.type="rpc" name="grpc.hipstershop.ProductCatalogService/ListProducts"]
✔ #634f965d1b34c1fd
✔ attr:rpc.grpc.status_code = 0 (0)
✔ span[tracetest.span.type="rpc" name="hipstershop.ProductCatalogService/ListProducts" rpc.system="grpc" rpc.method="ListProducts" rpc.service="hipstershop.ProductCatalogService"]
✔ #33a58e95448d8b22
✔ attr:rpc.grpc.status_code = 0 (0)
```

If you edit the duration as in the Web UI example above, the test will pass!

## View Trace Spans Over Time in Datadog

To access a historical overview of all the trace spans the OpenTelemetry Demo generates, jump over to your Datadog account on `APM > Traces` area.
Expand Down
Loading

0 comments on commit 182c468

Please sign in to comment.