Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@ We are currently using `gofumpt`, which is installed automatically by `make inst

### Running local build with the UI

For Jaeger v2:
```
$ go run ./cmd/jaeger --config ./cmd/jaeger/config.yaml
```

For legacy Jaeger v1 (all-in-one):
```
$ make run-all-in-one
```
Expand All @@ -80,11 +86,12 @@ $ make run-all-in-one
The `jaeger-ui` submodule, which was added from the Pre-requisites step above, contains
the source code for the UI assets (requires Node.js 6+).

The assets must be compiled first with `make build-ui`, which runs Node.js build and then
packages the assets into a Go file that is `.gitignore`-ed.
For v2, the Jaeger binary runs with the default configuration file (config.yaml) that includes
the UI configuration via the `jaeger_query` extension.

`make run-all-in-one` essentially runs Jaeger all-in-one by combining both of the above
steps into a single `make` command.
For v1, the assets must be compiled first with `make build-ui`, which runs Node.js build and then
packages the assets into a Go file that is `.gitignore`-ed. `make run-all-in-one` essentially
runs Jaeger all-in-one (v1) by combining both of these steps into a single `make` command.

## Project Structure

Expand Down
24 changes: 6 additions & 18 deletions docker-compose/monitor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ This environment supports the following backend components, depending on the cho
- **Common Components**:

- [MicroSim](https://github.com/yurishkuro/microsim): A program to simulate traces.
- [Jaeger All-in-one](https://www.jaegertracing.io/docs/1.24/getting-started/#all-in-one): The full Jaeger stack in a single container image.
- [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/): A vendor-agnostic integration layer for traces and metrics. For the Prometheus option, it receives Jaeger spans, forwards them to Jaeger All-in-one, and aggregates metrics from span data (see [spanmetrics connector documentation][spanmetricsconnectorreadme]).
- [Jaeger](https://www.jaegertracing.io/docs/latest/getting-started/): The full Jaeger stack in a single container image.
- [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/): A vendor-agnostic integration layer for traces and metrics. For the Prometheus option, it receives Jaeger spans, forwards them to Jaeger, and aggregates metrics from span data (see [spanmetrics connector documentation][spanmetricsconnectorreadme]).

- **For Prometheus as metrics backend**:

Expand All @@ -35,13 +35,11 @@ flowchart LR
MG --> ExpMetrics
Batch --> ExpTraces
ExpMetrics -->|metrics| Prometheus[(Prometheus)]
ExpTraces -->|traces| Jaeger[Jaeger
Collector]
ExpTraces -->|traces| Jaeger[Jaeger]
Prometheus -.-> JaegerUI
Jaeger --> Storage[(Storage)]
Storage -.-> JaegerUI[Jaeger
Query
and UI]
UI]

style Prometheus fill:red,color:white
style Jaeger fill:blue,color:white
Expand Down Expand Up @@ -89,11 +87,7 @@ docker compose -f docker-compose-elasticsearch.yml up
docker compose -f docker-compose-opensearch.yml up
```

**Jaeger v1 (Prometheus only)**

```shell
docker compose -f docker-compose-v1.yml up
```

**Tips:**
- Let the application run for a couple of minutes to ensure there is enough time series data to plot in the dashboard.
Expand All @@ -112,12 +106,6 @@ To use an official published image of Jaeger, specify the version via environmen
JAEGER_VERSION=2.0.0 docker compose -f docker-compose.yml up
```

or for Jaeger v1:

```shell
JAEGER_VERSION=1.62.0 docker compose -f docker-compose-v1.yml up
```

## Development

These steps allow for running the system necessary for SPM, built from Jaeger's source.
Expand Down Expand Up @@ -153,7 +141,7 @@ Generate a specific number of traces with:
docker run --env OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="http://jaeger:4318/v1/traces" \
--network monitor_backend \
--rm \
jaegertracing/jaeger-tracegen:1.49 \
jaegertracing/jaeger-tracegen:latest \
-trace-exporter otlp-http \
-traces 1
```
Expand All @@ -164,7 +152,7 @@ Or, emit traces over a period of time with:
docker run --env OTEL_EXPORTER_OTLP_TRACES_ENDPOINT="http://jaeger:4318/v1/traces" \
--network monitor_backend \
--rm \
jaegertracing/jaeger-tracegen:1.49 \
jaegertracing/jaeger-tracegen:latest \
-trace-exporter otlp-http \
-duration 5s
```
Expand Down
6 changes: 3 additions & 3 deletions examples/hotrod/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ As of Jaeger v1.42.0 this application was upgraded to use the OpenTelemetry SDK
* Download `docker-compose.yml` from https://github.com/jaegertracing/jaeger/blob/main/examples/hotrod/docker-compose.yml
* Optional: find the latest Jaeger version (see https://www.jaegertracing.io/download/) and pass it via environment variable `JAEGER_VERSION`. Otherwise `docker compose` will use the `latest` tag, which is fine for the first time you download the images, but once they are in your local registry the `latest` tag is never updated and you may be running stale (and possibly incompatible) verions of Jaeger and the HotROD app.
* Run Jaeger backend and HotROD demo, e.g.:
* `JAEGER_VERSION=1.52 docker compose -f path-to-yml-file up`
* `JAEGER_VERSION=2.0.0 docker compose -f path-to-yml-file up`
* Access Jaeger UI at http://localhost:16686 and HotROD app at http://localhost:8080
* Shutdown / cleanup with `docker compose -f path-to-yml-file down`

Expand All @@ -48,7 +48,7 @@ Access Jaeger UI at http://localhost:16686 and HotROD app at http://localhost:80

### Run Jaeger backend

An all-in-one Jaeger backend is packaged as a Docker container with in-memory storage.
Jaeger backend is packaged as a Docker container with in-memory storage.

```bash
docker run \
Expand All @@ -57,7 +57,7 @@ docker run \
-p4318:4318 \
-p16686:16686 \
-p14268:14268 \
jaegertracing/all-in-one:latest
jaegertracing/jaeger:latest
```

Jaeger UI can be accessed at http://localhost:16686.
Expand Down
Loading