Jaeger (jaeger)
Receives the OTLP traces of the collector, stores them in memory, in OpenSearch or in the Elasticsearch of the client and serves the query interface and API.
Generated from catalog/services/jaeger.yaml: do not edit by hand.
Summary
| Version | 2.22.0 |
| Use | install and configure |
| Layer | infrastructure (shown apart) |
| Category | Observability |
| Installation methods | binary, podman |
| External connection | no |
| Sandbox only | no |
Licence
| SPDX identifier | Apache-2.0 |
| Licence policy | core licence (MIT or Apache-2.0) |
| Licence exception | - |
| Platform component | jaeger |
Packages and artifacts
A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.
| Kind | Package | Version | Licence | Details |
|---|---|---|---|---|
| container image | docker.io/jaegertracing/jaeger | 2.22.0 | Apache-2.0 | image key jaeger, used by jaeger, digest sha256:836b967b5abcf1f7758066aa6b348619267a2f1459f72d472840570f9bd88a17 |
| binary archive | jaeger-2.22.0-linux-amd64.tar.gz | 2.22.0 | Apache-2.0 | https://github.com/jaegertracing/jaeger/releases/download/v2.22.0/jaeger-2.22.0-linux-amd64.tar.gz, x86_64, checksum sha256 |
Images are pinned by tag in the descriptor, and by digest when the descriptor declares one (the offline bundle then refuses a pulled image that does not carry it); the digest is recorded in the mirror of the Manager when the offline bundle is imported, and every pull or load is checked against it.
Supported systems and architectures
| Method | Operating systems | Architectures |
|---|---|---|
binary | RHEL family (dnf), Debian family (apt), Arch Linux (pacman) | x86_64 (architecture of the artifacts of the descriptor) |
podman | RHEL family (dnf), Debian family (apt), Arch Linux (pacman) | x86_64, aarch64 (not restricted by the descriptor) |
Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.
Prerequisites
Host
The descriptor declares no host preflight check.
Network and ports
| Component | Port name | Port | Opened in the host firewall |
|---|---|---|---|
jaeger | otlp_grpc | 4417/tcp | yes |
jaeger | query | 16686/tcp | yes |
jaeger | metrics | 8889/tcp | yes |
jaeger | health | 13134/tcp | no |
Services and connections needed
opensearch:opensearch(optional).elasticsearch:elasticsearch(optional).
Details and resolution: see Dependencies.
Installation methods and modes
| Method | Default | What the method uses |
|---|---|---|
binary | yes | the binary archives of the descriptor, unpacked under the service directory |
podman | - | the container images of the descriptor, run by Podman under systemd |
Components
| Component | Kind | Installation methods | Ports |
|---|---|---|---|
Jaeger (jaeger) | master | binary, podman | 4417/tcp, 16686/tcp, 8889/tcp, 13134/tcp |
Single (single) (default)
One Jaeger process: collector, storage and query.
What the mode deploys:
| Component | Placement |
|---|---|
jaeger | min 1, max 1 |
Replicated (replicated)
Stateless Jaeger processes sharing the OpenSearch storage.
What the mode deploys:
| Component | Placement |
|---|---|
jaeger | min 2, recommended 2 |
Install this service
The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.
-
Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.
-
Choose the service. On the Service step, select Jaeger. The card shows the licence
Apache-2.0and the dependencies the installation needs. Pick the Method amongbinary,podman(defaultbinary). -
Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode:
single(default),replicated. Each mode deploys the components listed in Installation methods and modes. -
Bind the dependencies. On the Bindings step, choose for each dependency (
opensearch,elasticsearch) Install with the platform or Use an existing connection; an optional dependency can stay on No binding. -
Configure. On the Configure step, review the parameters (see Configuration parameters). Passwords left empty with a generated default are generated and sealed by the Manager.
-
Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.
-
Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.
High availability
| Cluster | replicas (replication) |
| High availability | external (external) |
| Failover | load balancer (load-balancer) |
| Replication | shared store (shared-store) |
| Quorum | none (none) |
| Discovery | none (none) |
| Entry point | load balancer (load-balancer) |
| Official documentation | https://www.jaegertracing.io/docs/2.22/storage/ |
Prerequisites
| Prerequisite | Must be highly available | Modes | Description |
|---|---|---|---|
opensearch | yes | modes of level ha or cluster | Highly available OpenSearch shared by every instance; the memory storage cannot be shared. |
Topology per mode
| Modes | Highest catalog level | Distribution | Quorum component | Fault domains | Description |
|---|---|---|---|---|---|
single | standalone (standalone) | single (single) | - | 1 | One process; without the OpenSearch binding the traces stay in memory. |
replicated | ha (ha) | active-active (active-active) | - | 2 | Stateless processes sharing the OpenSearch storage, behind the load balancer. |
Configuration parameters
General
| Parameter | Type | Default | Allowed values | Required | Secret | Restart | Description |
|---|---|---|---|---|---|---|---|
OTLP gRPC port (otlp_grpc_port) | port | 4417 | - | no | no | no | Port of the OTLP gRPC receiver (the collector of the same host keeps 4317). |
Query port (query_port) | port | 16686 | - | no | no | no | Port of the interface and of the query API. |
Metrics port (metrics_port) | port | 8889 | - | no | no | no | Port of the Jaeger own metrics. |
Health port (health_port) | port | 13134 | - | no | no | no | Port of the health check extension. |
TLS (tls_enabled) | bool | false | - | no | no | yes | Serve the OTLP receiver, the query interface and API (HTTP and gRPC) and the metrics over TLS with a certificate issued by the manager CA. |
Internal metrics port (self_metrics_port) | port | 4419 | - | no | no | no | Loopback port receiving the Jaeger own metrics when TLS is on, before they are served in TLS on the metrics port (the built-in Prometheus reader has no TLS). (advanced) |
Traces in memory (memory_max_traces) | int | 100000 | min 1000, max 10000000 | no | no | no | Traces kept by the memory store (without OpenSearch or Elasticsearch). |
Dependencies
For each active dependency the Manager takes the first of: the binding chosen in the wizard; a service of the same installation that provides it; a service already installed in the cluster; the only connection of the expected type. Otherwise an optional dependency stays unbound, and a required one is added to the installation in its default mode (the column below names the catalog service added).
| Binding | Provided by | Connection type | Endpoint | Optional | When nothing is bound | Description |
|---|---|---|---|---|---|---|
opensearch | opensearch | - | http | yes | stays unbound (optional) | OpenSearch storing the spans (indices jaeger-jaeger-span-*: Jaeger joins the prefix jaeger to its index names); in memory without it. |
elasticsearch | - (versions >= 8.12, < 9) | elasticsearch | - | yes | stays unbound (optional) | Elasticsearch the client already runs, declared as a connection and never installed by Navin: it stores the spans (indices eai-jaeger-span-* and eai-jaeger-service-*) and takes precedence over OpenSearch when both are bound. |
Endpoints
| Endpoint | Scheme | Component | Port | Path | TLS parameter | Binding parameters | Binding secrets | Provisioning command |
|---|---|---|---|---|---|---|---|---|
otlp_grpc | grpc | jaeger | 4417 (otlp_grpc_port) | - | tls_enabled | tls | - | - |
query | http | jaeger | 16686 (query_port) | - | tls_enabled | - | - | - |
Health checks
Liveness (per instance)
| Component | Check | Details |
|---|---|---|
jaeger | HTTP http://127.0.0.1:{{ config.health_port }}/status | Expected 200; 60 retries; interval 2 s; timeout 3 s |
Readiness (service check)
| Check | Details |
|---|---|
HTTP {{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.query_port }}/api/v3/services | Expected 200; Expected services |
Preflight checks
| Check | Type | Meaning | Severity | Components |
|---|---|---|---|---|
query_free | port_free {"param": "query_port"} | port 16686 free on the host | blocking | every component |
Uninstall
Paths removed when the data is purged: {{ paths.log }}.
Quick links
- Jaeger:
{{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn }}:{{ config.query_port }}/
Upstream documentation
- Homepage: https://www.jaegertracing.io
- Source: https://github.com/jaegertracing/jaeger
- High availability: https://www.jaegertracing.io/docs/2.22/storage/