Skip to content

Commit

Permalink
Add example of passing a config file (#835)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
- https://github.com/orgs/jaegertracing/discussions/6623

Signed-off-by: Yuri Shkuro <[email protected]>
  • Loading branch information
yurishkuro authored Jan 27, 2025
1 parent a989b70 commit af008c9
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
2 changes: 1 addition & 1 deletion content/docs/next-release-v2/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ children:
url: terminology
---

Jaeger v2 is designed to be a versatile and flexible tracing platform. It can be deployed as a single binary that can be configured to perform different roles within the Jaeger architecture, such as:
Jaeger v2 is designed to be a versatile and flexible tracing platform. It can be deployed as a single binary that can be configured to perform different **roles** within the Jaeger architecture, such as:
* **collector**: Receives incoming trace data from applications and writes it into a storage backend.
* **query**: Serves the APIs and the user interface for querying and visualizing traces.
* **ingester**: Ingests spans from Kafka and writes them into a storage backend; useful when running in a [split collector-Kafka-ingester configuration](./#via-kafka).
Expand Down
14 changes: 13 additions & 1 deletion content/docs/next-release-v2/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,19 @@ children:
url: security
---

Jaeger backend is released as a single binary or container image (see [Downloads](../../../download/)). Despite that, it can be configured to operate in different roles, such as all-in-one, collector, query, and ingester (see [Architecture](../architecture/)).
Jaeger backend is released as a single binary or container image (see [Downloads](../../../download/)). Despite that, it can be configured to operate in different **roles**, such as all-in-one, collector, query, and ingester (see [Architecture](../architecture/)). An explicit configuration file can be provided via the `--config` command line argument. When running in a container, the path to the config file must be mapped into the container file system (the `-v ...` mapping below):

```
docker run --rm --name jaeger \
-p 16686:16686 \
-p 4317:4317 \
-p 4318:4318 \
-p 5778:5778 \
-p 9411:9411 \
-v /path/to/local/config.yaml:/jaeger/config.yaml \
jaegertracing/jaeger:{{< currentVersion >}} \
--config /jaeger/config.yaml
```

## Management Ports

Expand Down
16 changes: 15 additions & 1 deletion content/docs/next-release-v2/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ docker run --rm --name jaeger \

This runs the **all-in-one** configuration of Jaeger ([see Architecture](../architecture/)) that combines collector and query components in a single process and uses a transient in-memory storage for trace data. You can navigate to `http://localhost:16686` to access the Jaeger UI. See the [APIs page](../apis/) for a full list of exposed ports.

In order to run Jaeger in other roles ([see Architecture](../architecture/)), an explicit configuration file ([see Configuration](../configuration/)) must be provided via the `--config` command line argument. When running in a container, the path to the config file must be mapped into the container file system (the `-v ...` mapping below):

```
docker run --rm --name jaeger \
-p 16686:16686 \
-p 4317:4317 \
-p 4318:4318 \
-p 5778:5778 \
-p 9411:9411 \
-v /path/to/local/config.yaml:/jaeger/config.yaml \
jaegertracing/jaeger:{{< currentVersion >}} \
--config /jaeger/config.yaml
```

{{< warning >}}
Your applications must be instrumented before they can send tracing data to Jaeger. We recommend using the [OpenTelemetry](https://opentelemetry.io/) instrumentation and SDKs.
{{< /warning >}}
Expand All @@ -37,7 +51,7 @@ Using this application you can:
- Find sources of latency and lack of concurrency.
- Explore highly contextualized logging.
- Use baggage propagation to diagnose inter-request contention (queueing) and time spent in a service.
- Use open source libraries from `opentelemetry-contrib` to get vendor-neutral instrumentation
- Use open source libraries from `opentelemetry-contrib` to get vendor-neutral instrumentation
for free.

We recommend running Jaeger and HotROD together via `docker compose`:
Expand Down

0 comments on commit af008c9

Please sign in to comment.