Skip to content

Commit 6a9f509

Browse files
authored
jaeger docs update (#1698)
Updates to the jaeger instructions for self hosted customers on helm Associated to sourcegraph/deploy-sourcegraph-helm#841
1 parent b83028e commit 6a9f509

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/self-hosted/deploy/kubernetes/index.mdx

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -395,6 +395,37 @@ jaeger:
395395
enabled: true
396396
```
397397

398+
#### Customize Jaeger configuration
399+
400+
Starting with Sourcegraph 7.1.0, the bundled Jaeger instance uses an [OpenTelemetry Collector-style YAML configuration](https://www.jaegertracing.io/docs/2.16/configuration/) instead of CLI flags. Common settings are exposed through the `jaeger.config` Helm value.
401+
402+
You can override these settings in your Helm values override file. For example, to increase the maximum number of in-memory traces:
403+
404+
```yaml
405+
jaeger:
406+
enabled: true
407+
config:
408+
maxTraces: 50000
409+
```
410+
411+
Or using `--set` on the command line:
412+
413+
```bash
414+
helm upgrade sourcegraph sourcegraph/sourcegraph \
415+
--set jaeger.config.maxTraces=50000
416+
```
417+
418+
The available configuration options are:
419+
420+
| Value | Default | Description |
421+
| --- | --- | --- |
422+
| `jaeger.config.maxTraces` | `20000` | Maximum number of traces stored in memory |
423+
| `jaeger.config.logLevel` | `info` | Log level (`debug`, `info`, `warn`, `error`) |
424+
| `jaeger.config.samplingDefaultProbability` | `1.0` | Default sampling probability (0.0–1.0) returned to services that query Jaeger for sampling config |
425+
| `jaeger.config.existingConfigMap` | `""` | Name of a pre-existing ConfigMap containing a `jaeger-config.yaml` key. When set, the chart skips creating its own ConfigMap and uses yours instead |
426+
427+
For advanced customization beyond these options, set `jaeger.config.existingConfigMap` to the name of your own ConfigMap containing a full `jaeger-config.yaml` key. See the [Jaeger v2 configuration reference](https://www.jaegertracing.io/docs/2.16/configuration/) for all available options.
428+
398429
#### Configure OpenTelemetry Collector to use an external tracing backend
399430

400431
To configure the bundled otel-collector to export traces to an external OTEL-compatible backend, you you can customize the otel-collector's config file directly in your Helm values `override.yaml` file.

docs/self-hosted/observability/tracing.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ To deploy our bundled Jaeger backend, follow the instructions for your deploymen
2020
- [Kubernetes with Kustomize](/self-hosted/deploy/kubernetes/configure#deploy-the-bundled-opentelemetry-collector-and-jaeger)
2121
- [Docker Compose](/self-hosted/deploy/docker-compose/configuration#deploy-the-bundled-jaeger)
2222

23+
For Helm deployments, you can also [customize the Jaeger configuration](/self-hosted/deploy/kubernetes#customize-jaeger-configuration) (e.g., `max_traces`, sampling, log level) directly through Helm values.
24+
2325
Then configure your Site Configuration:
2426

2527
1. Ensure your `externalURL` is configured

0 commit comments

Comments
 (0)