Skip to content

Commit

Permalink
adding readme instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbdias committed Oct 9, 2024
1 parent 7b137c1 commit ab724fd
Showing 1 changed file with 24 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,40 @@

### Overview

TBD
This example demonstrates how to test context propagation with automatic instrumentation. It consists of a simple application that uses a backend service to store data. The application is instrumented with OpenTelemetry and sends traces to an Jaeger backend.

```mermaid
graph LR
User -- POST /sendData --> ServiceA
ServiceA -- POST /augmentData --> ServiceB
```

### Requirements

- Docker
- Tracetest CLI
To run it you need:

- [Docker](https://www.docker.com/get-started/)
- [Tracetest CLI](https://docs.tracetest.io/getting-started/overview)

You will need to have a Tracetest.io account and an environment to run this example. Once that you created it, add an `.env` file with the following content:

```bash
TRACETEST_ENVIRONMENT_ID=...
TRACETEST_API_KEY=...
```

You can get the values for both `TRACETEST_ENVIRONMENT_ID` and `TRACETEST_API_KEY` on the page: https://app.tracetest.io/retrieve-token

### Running the Example

After setting up the environment, you can run the example with the following commands:

```bash
docker compose up
```

And to run the test you can execute the following commands:

```bash
tracetest configure ## connect to your environment

Expand Down

0 comments on commit ab724fd

Please sign in to comment.