This is a cache of https://docs.openshift.com/container-platform/4.5/jaeger/jaeger_install/rhbjaeger-deploying.html. It is a snapshot of the page at 2024-11-23T00:54:20.199+0000.
Configuring Jaeger - Jaeger installation | Jaeger | OpenShift Container Platform 4.5
    OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history
×

Configuring and Deploying Jaeger

The Jaeger Operator includes a custom resource definition (CRD) file that defines the architecture and configuration settings for the Jaeger resources. You can either install the default configuration or modify the file to better suit your business requirements.

Jaeger has predefined deployment strategies. You specify a deployment strategy in the custom resource file. When you create a Jaeger instance the Operator uses this configuration file to create the objects necessary for the deployment.

Jaeger custom resource file showing deployment strategy
apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production (1)
1 The Jaeger Operator currently supports the following deployment strategies:

  • allInOne (Default) - This strategy is intended for development, testing, and demo purposes. The main backend components, Agent, Collector and Query service, are all packaged into a single executable which is configured (by default) to use in-memory storage.

    In-memory storage is not persistent, which means that if the Jaeger instance shuts down, restarts, or is replaced, that your trace data will be lost. And in-memory storage cannot be scaled, since each pod has its own memory. For persistent storage, you must use the production or streaming strategies, which use Elasticsearch as the default storage.

  • production - The production strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required. Each of the backend components is therefore deployed separately. The Agent can be injected as a sidecar on the instrumented application or as a daemonset. The Query and Collector services are configured with a supported storage type - currently Elasticsearch. Multiple instances of each of these components can be provisioned as required for performance and resilience purposes.

  • streaming - The streaming strategy is designed to augment the production strategy by providing a streaming capability that effectively sits between the Collector and the backend storage (Elasticsearch). This provides the benefit of reducing the pressure on the backend storage, under high load situations, and enables other trace post-processing capabilities to tap into the real time span data directly from the streaming platform (AMQ Streams/ Kafka).

    The streaming strategy requires an additional Red Hat subscription for AMQ Streams.

There are two ways to install Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you must configure and deploy Jaeger as part of the ServiceMeshControlPlane.

Deploying the default Jaeger strategy from the web console

The custom resource definition (CRD) defines the configuration used when you deploy an instance of Jaeger. The default CR for Jaeger is named jaeger-all-in-one-inmemory and it is configured with minimal resources to ensure that you can successfully install it on a default OpenShift Container Platform installation. You can use this default configuration to create a Jaeger instance that uses the AllInOne deployment strategy, or you can define your own custom resource file.

In-memory storage is not persistent, which means that if the Jaeger pod shuts down, restarts, or is replaced, that your trace data will be lost. For persistent storage, you must use the production or streaming strategies, which use Elasticsearch as the default storage.
Prerequisites

  • The Jaeger Operator must be installed.

  • Review the instructions for how to customize the Jaeger installation.

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

  2. Create a new project, for example jaeger-system.

    1. Navigate to Home → Projects.

    2. Click Create Project.

    3. Enter jaeger-system in the Name field.

    4. Click Create.

  3. Navigate to Operators → Installed Operators.

  4. If necessary, select jaeger-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.

  5. Click the OpenShift Jaeger Operator. On the Overview tab, under Provided APIs, the Operator provides a single link.

  6. Under Jaeger click Create Instance.

  7. On the Create Jaeger page, to install using the defaults, click Create to create the Jaeger instance.

  8. On the Jaegers page, click the name of the Jaeger instance, for example, jaeger-all-in-one-inmemory.

  9. On the Jaeger Details page, click the Resources tab. Wait until the Pod has a status of "Running" before continuing.

Deploying default Jaeger from the CLI

Follow this procedure to create an instance of Jaeger from the command line.

Prerequisites

  • An installed, verified OpenShift Jaeger Operator.

  • Access to the OpenShift CLI (oc) that matches your OpenShift Container Platform version.

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform CLI as a user with the cluster-admin role.

    $ oc login https://{HOSTNAME}:8443

  2. Create a new project named jaeger-system.

    $ oc new-project jaeger-system

  3. Create a custom resource file named jaeger.yaml that contains the following text:

    Example jaeger-all-in-one.yaml
    apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-all-in-one-inmemory

  4. Run the following command to deploy Jaeger:

    $ oc create -n jaeger-system -f jaeger.yaml

  5. Run the following command to watch the progress of the pods during the installation process:

    $ oc get pods -n jaeger-system -w

    Once the installation process has completed, you should see output similar to the following:

    NAME                                         READY   STATUS    RESTARTS   AGE
jaeger-all-in-one-inmemory-cdff7897b-qhfdx   2/2     Running   0          24s

Deploying the Jaeger production strategy from the web console

The production deployment strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required.

Prerequisites

  • The Elasticsearch Operator must be installed.

  • The Jaeger Operator must be installed.

  • Review the instructions for how to customize the Jaeger installation.

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

  2. Create a new project, for example jaeger-system.

    1. Navigate to Home → Projects.

    2. Click Create Project.

    3. Enter jaeger-system in the Name field.

    4. Click Create.

  3. Navigate to Operators → Installed Operators.

  4. If necessary, select jaeger-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.

  5. Click the Jaeger Operator. On the Overview tab, under Provided APIs, the Operator provides a single link.

  6. Under Jaeger click Create Instance.

  7. On the Create Jaeger page, replace the default all-in-one yaml text with your production YAML configuration, for example:

    Example jaeger-production.yaml file with Elasticsearch
    apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-production
  namespace:
spec:
  strategy: production
  ingress:
    security: oauth-proxy
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 3
      redundancyPolicy: SingleRedundancy
    esIndexCleaner:
      enabled: true
      numberOfDays: 7
      schedule: 55 23 * * *
    esRollover:
      schedule: '*/30 * * * *'

  8. Click Create to create the Jaeger instance.

  9. On the Jaegers page, click the name of the Jaeger instance, for example, jaeger-prod-elasticsearch.

  10. On the Jaeger Details page, click the Resources tab. Wait until all the pods have a status of "Running" before continuing.

Deploying Jaeger production from the CLI

Follow this procedure to create an instance of Jaeger from the command line.

Prerequisites

  • An installed, verified OpenShift Jaeger Operator.

  • Access to the OpenShift CLI (oc).

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform CLI as a user with the cluster-admin role.

    $ oc login https://{HOSTNAME}:8443

  2. Create a new project named jaeger-system.

    $ oc new-project jaeger-system

  3. Create a custom resource file named jaeger-production.yaml that contains the text of the example file in the previous procedure.

  4. Run the following command to deploy Jaeger:

    $ oc create -n jaeger-system -f jaeger-production.yaml

  5. Run the following command to watch the progress of the pods during the installation process:

    $ oc get pods -n jaeger-system -w

    Once the installation process has completed, you should see output similar to the following:

    NAME                                                              READY   STATUS    RESTARTS   AGE
elasticsearch-cdm-jaegersystemjaegerproduction-1-6676cf568gwhlw   2/2     Running   0          10m
elasticsearch-cdm-jaegersystemjaegerproduction-2-bcd4c8bf5l6g6w   2/2     Running   0          10m
elasticsearch-cdm-jaegersystemjaegerproduction-3-844d6d9694hhst   2/2     Running   0          10m
jaeger-production-collector-94cd847d-jwjlj                        1/1     Running   3          8m32s
jaeger-production-query-5cbfbd499d-tv8zf                          3/3     Running   3          8m32s

Deploying the Jaeger streaming strategy from the web console

The streaming deployment strategy is intended for production environments, where long term storage of trace data is important, as well as a more scalable and highly available architecture is required.

The streaming strategy provides a streaming capability that sits between the collector and the storage (Elasticsearch). This reduces the pressure on the storage under high load situations, and enables other trace post-processing capabilities to tap into the real time span data directly from the streaming platform (Kafka).

The streaming strategy requires an additional Red Hat subscription for AMQ Streams. If you do not have an AMQ Streams subscription, contact your sales representative for more information.
Prerequisites

  • The AMQ Streams Operator must be installed. If using version 1.4.0 or higher you can use self-provisioning. If otherwise, you need to create the Kafka instance.

  • The Jaeger Operator must be installed.

  • Review the instructions for how to customize the Jaeger installation.

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform web console as a user with the cluster-admin role.

  2. Create a new project, for example jaeger-system.

    1. Navigate to Home → Projects.

    2. Click Create Project.

    3. Enter jaeger-system in the Name field.

    4. Click Create.

  3. Navigate to Operators → Installed Operators.

  4. If necessary, select jaeger-system from the Project menu. You may have to wait a few moments for the Operators to be copied to the new project.

  5. Click the Jaeger Operator. On the Overview tab, under Provided APIs, the Operator provides a single link.

  6. Under Jaeger click Create Instance.

  7. On the Create Jaeger page, replace the default all-in-one yaml text with your streaming YAML configuration, for example:

Example jaeger-streaming.yaml file
apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-streaming
spec:
  strategy: streaming
  collector:
    options:
      kafka:
        producer:
          topic: jaeger-spans
          #Note: If brokers are not defined,AMQStreams 1.4.0+ will self-provision Kafka.
          brokers: my-cluster-kafka-brokers.kafka:9092
  storage:
    type: elasticsearch
  ingester:
    options:
      kafka:
        consumer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092

  1. Click Create to create the Jaeger instance.

  2. On the Jaegers page, click the name of the Jaeger instance, for example, jaeger-streaming.

  3. On the Jaeger Details page, click the Resources tab. Wait until all the pods have a status of "Running" before continuing.

Deploying Jaeger streaming from the CLI

Follow this procedure to create an instance of Jaeger from the command line.

Prerequisites

  • An installed, verified OpenShift Jaeger Operator.

  • Access to the OpenShift CLI (oc).

  • An account with the cluster-admin role.

Procedure

  1. Log in to the OpenShift Container Platform CLI as a user with the cluster-admin role.

    $ oc login https://{HOSTNAME}:8443

  2. Create a new project named jaeger-system.

    $ oc new-project jaeger-system

  3. Create a custom resource file named jaeger-streaming.yaml that contains the text of the example file in the previous procedure.

  4. Run the following command to deploy Jaeger:

    $ oc create -n jaeger-system -f jaeger-streaming.yaml

  5. Run the following command to watch the progress of the pods during the installation process:

    $ oc get pods -n jaeger-system -w

    Once the installation process has completed, you should see output similar to the following:

    NAME                                                              READY   STATUS    RESTARTS   AGE
elasticsearch-cdm-jaegersystemjaegerstreaming-1-697b66d6fcztcnn   2/2     Running   0          5m40s
elasticsearch-cdm-jaegersystemjaegerstreaming-2-5f4b95c78b9gckz   2/2     Running   0          5m37s
elasticsearch-cdm-jaegersystemjaegerstreaming-3-7b6d964576nnz97   2/2     Running   0          5m5s
jaeger-streaming-collector-6f6db7f99f-rtcfm                       1/1     Running   0          80s
jaeger-streaming-entity-operator-6b6d67cc99-4lm9q                 3/3     Running   2          2m18s
jaeger-streaming-ingester-7d479847f8-5h8kc                        1/1     Running   0          80s
jaeger-streaming-kafka-0                                          2/2     Running   0          3m1s
jaeger-streaming-query-65bf5bb854-ncnc7                           3/3     Running   0          80s
jaeger-streaming-zookeeper-0                                      2/2     Running   0          3m39s

Customizing Jaeger deployment

Jaeger default configuration options

The Jaeger custom resource (CR) defines the architecture and settings to be used when creating the Jaeger resources. You can modify these parameters to customize your Jaeger implementation to your business needs.

Jaeger generic YAML example
apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: name
spec:
  strategy: <deployment_strategy>
  allInOne:
    options: {}
    resources: {}
  agent:
    options: {}
    resources: {}
  collector:
    options: {}
    resources: {}
  sampling:
    options: {}
  storage:
    type:
    options: {}
  query:
    options: {}
    resources: {}
  ingester:
    options: {}
    resources: {}
  options: {}
Table 1. Jaeger parameters
Parameter Description Values Default value

apiVersion:

Version of the Application Program Interface to use when creating the object.

jaegertracing.io/v1

jaegertracing.io/v1

kind:

Defines the kind of Kubernetes object to create.

jaeger

metadata:

Data that helps uniquely identify the object, including a name string, UID, and optional namespace.

OpenShift automatically generates the UID and completes the namespace with the name of the project where the object is created.

name:

Name for the object.

The name of your Jaeger instance.

jaeger-all-in-one-inmemory

spec:

Specification for the object to be created.

Contains all of the configuration parameters for your Jaeger instance. When a common definition (for all Jaeger components) is required, it is defined under the spec node. When the definition relates to an individual component, it is placed under the spec/<component> node.

N/A

strategy:

Jaeger deployment strategy

allInOne, production, or streaming

allInOne

allInOne:

Because the allInOne image deploys the agent, collector, query, ingester, Jaeger UI in a single pod, configuration for this deployment should nest component configuration under the allInOne parameter.

agent:

Configuration options that define the Jaeger agent.

collector:

Configuration options that define the Jaeger Collector.

sampling:

Configuration options that define the sampling strategies for tracing.

storage:

Configuration options that define the storage. All storage related options should be placed under storage, rather than under the allInOne or other component options.

query:

Configuration options that define the Query service.

ingester:

Configuration options that define the Ingester service.

The following example YAML is the minimum required to create a Jaeger instance using the default settings.

Example minimum required jaeger-all-in-one.yaml
apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger-all-in-one-inmemory

Jaeger Collector configuration options

The Jaeger Collector is the component responsible for receiving the spans that were captured by the tracer and writing them to a persistent storage (Elasticsearch) when using the production strategy, or to AMQ Streams when using the streaming strategy.

The collectors are stateless and thus many instances of Jaeger Collector can be run in parallel. Collectors require almost no configuration, except for the location of the Elasticsearch cluster.

Table 2. Jaeger Collector parameters used by the Operator
Parameter Description Values 
collector:
  num-workers:

The number of workers pulling from the queue.

Integer, for example, 50

 
collector:
  queue-size:

The size of the Collector queue.

Integer, for example, 2000

 
collector:
  replicas:

Specifies the number of Collector replicas to create.

Integer, for example, 5
Table 3. Jaeger parameters passed to the Collector
Parameter Description Values 
spec:
 collector:
  options: {}

Configuration options that define the Jaeger Collector.

 
options:
  kafka:
    producer:
      topic: jaeger-spans

The topic parameter identifies the Kafka configuration used by the collector to produce the messages, and the ingester to consume the messages.

Label for the producer

 
options:
  kafka:
    producer:
      brokers: my-cluster-kafka-brokers.kafka:9092

Identifies the Kafka configuration used by the Collector to produce the messages. If brokers are not specified, and you have AMQ Streams 1.4.0+ installed, Jaeger will self-provision Kafka.

 
options:
  log-level:

Logging level for the collector.

trace, debug, info, warning, error, fatal, panic

Jaeger sampling configuration options

The Operator can be used to define sampling strategies that will be supplied to tracers that have been configured to use a remote sampler.

While all traces are generated, only a few are sampled. Sampling a trace marks the trace for further processing and storage.

This is not relevant if a trace was started by the Istio proxy as the sampling decision is made there. The Jaeger sampling decision is only relevant when the trace is started by an application using the Jaeger tracer.

When a service receives a request that contains no trace context, the Jaeger tracer will start a new trace, assign it a random trace ID, and make a sampling decision based on the currently installed sampling strategy. The sampling decision is propagated to all subsequent requests in the trace, so that other services are not making the sampling decision again.

Jaeger libraries support the following samplers:

  • Constant - The sampler always makes the same decision for all traces. It either samples all traces (sampling.param=1) or none of them (sampling.param=0).

  • Probabilistic - The sampler makes a random sampling decision with the probability of sampling equal to the value of the sampling.param property. For example, with sampling.param=0.1 approximately 1 in 10 traces will be sampled.

  • Rate Limiting - The sampler uses a leaky bucket rate limiter to ensure that traces are sampled with a certain constant rate. For example, when sampling.param=2.0 it will sample requests with the rate of 2 traces per second.

  • Remote - The sampler consults the Jaeger agent for the appropriate sampling strategy to use in the current service. This allows controlling the sampling strategies in the services from a central configuration in the Jaeger backend.

Table 4. Jaeger sampling parameters
Parameter Description Values Default value 
spec:
 sampling:
  options: {}

Configuration options that define the sampling strategies for tracing.

 
sampling:
  type:

Sampling strategy to use. (See descriptions above.)

Valid values are const, probabilistic, ratelimiting, and remote.

remote

 
sampling:
  options:
    type:
    param:

Parameters for the selected sampling strategy. (See examples above.)

Decimal and integer values (0, .1, 1, 10)

N/A

This example defines a default sampling strategy that is probabilistic, with a 50% chance of the trace instances being sampled.

Probabilistic sampling example
apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: with-sampling
spec:
  strategy: allInOne
  sampling:
    options:
      default_strategy:
        type: probabilistic
        param: 50

Jaeger storage configuration options

You configure storage for the Collector, Ingester, and Query services under spec:storage. Multiple instances of each of these components can be provisioned as required for performance and resilience purposes.

Restrictions

  • There can be only one Jaeger with self-provisioned Elasticsearch instance per namespace.

  • There can be only one Elasticsearch per namespace.

  • You cannot share or reuse a OpenShift Jaeger logging Elasticsearch instance with Jaeger. The Elasticsearch cluster is meant to be dedicated for a single Jaeger instance.

If you already have installed Elasticsearch as part of OpenShift logging, the Jaeger Operator can use the installed Elasticsearch Operator to provision storage.
Table 5. Jaeger general storage parameters
Parameter Description Values Default value 
spec:
 storage:
  options: {}

Configuration options that define the storage.

 
storage:
  type:

Type of storage to use for the deployment.

memory or elasticsearch. Memory storage is only appropriate for development, testing, demonstrations, and proof of concept environments as the data does not persist if the pod is shut down. For production environments Jaeger supports Elasticsearch for persistent storage.

memory
Table 6. Elasticsearch configuration parameters
Parameter Description Values Default value 
General Elasticsearch configuration settings
 
elasticsearch:
  server-urls:

URL of the Elasticsearch instance.

The fully-qualified domain name of the Elasticsearch server. If you have specified spec:storage:type= elasticsearch but have not specified a value for server-urls parameter, the Jaeger Operator will use the Elasticsearch Operator to create an Elasticsearch cluster using the configuration in the spec:storage:elasticsearch section of the custom resource file.

http://elasticsearch.<namespace>.svc:9200

 
es:
  max-num-spans:

The maximum number of spans to fetch at a time, per query, in Elasticsearch.

10000

 
es:
  max-span-age:

The maximum lookback for spans in Elasticsearch.

72h0m0s

 
elasticsearch:
  secretname:

Name of the secret, for example jaeger-secret.

N/A

 
es:
  sniffer:

The sniffer configuration for Elasticsearch. The client uses the sniffing process to find all nodes automatically. Disabled by default.

true/ false

false

 
es:
  timeout:

Timeout used for queries. When set to zero there is no timeout.

0s

 
es:
  username:

The username required by Elasticsearch. The basic authentication also loads CA if it is specified. See also es.password.

 
es:
  password:

The password required by Elasticsearch. See also, es.username.

 
es:
  version:

The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.

0

 
Elasticsearch resource configuration settings
 
elasticsearch:
  nodeCount:

Number of Elasticsearch nodes. For high availability use at least 3 nodes. Do not use 2 nodes as “split brain” problem can happen.

Integer value. For example, Proof of concept = 1, Minimum deployment =3

3

 
elasticsearch:
  resources:
    requests:
      cpu:

Number of central processing units for requests, based on your environment’s configuration.

Specified in cores or millicores (for example, 200m, 0.5, 1). For example, Proof of concept = 500m, Minimum deployment =1

1

 
elasticsearch:
  resources:
    requests:
      memory:

Available memory for requests, based on your environment’s configuration.

Specified in bytes (for example, 200Ki, 50Mi, 5Gi). For example, Proof of concept = 1Gi, Minimum deployment = 16Gi*

16Gi

 
elasticsearch:
  resources:
    limits:
      cpu:

Limit on number of central processing units, based on your environment’s configuration.

Specified in cores or millicores (for example, 200m, 0.5, 1). For example, Proof of concept = 500m, Minimum deployment =1

 
elasticsearch:
  resources:
    limits:
      memory:

Available memory limit based on your environment’s configuration.

Specified in bytes (for example, 200Ki, 50Mi, 5Gi). For example, Proof of concept = 1Gi, Minimum deployment = 16Gi*

 




*Each Elasticsearch node can operate with a lower memory setting though this is NOT recommended for production deployments. For production use, you should have no less than 16Gi allocated to each Pod by default, but preferably allocate as much as you can, up to 64Gi per Pod.








Elasticsearch data replication options






elasticsearch:
  redundancyPolicy:




Data replication policy defines how Elasticsearch shards are replicated across data nodes in the cluster. If not specified,the Jaeger Operator automatically determines the most appropriate replication based on number of nodes.






ZeroRedundancy(no replica shards), SingleRedundancy(one replica shard), MultipleRedundancy(each index is spread over half of the Data nodes), FullRedundancy (each index is fully replicated on every Data node in the cluster).










es:
  num-replicas:




The number of replicas per index in Elasticsearch.








1








es:
  num-shards:




The number of shards per index in Elasticsearch.








5








Elasticsearch index and index cleaner configuration options






es:
  create-index-templates:




Automatically create index templates at application startup when set to true. When templates are installed manually, set to false.






true/ false






true








es:
  index-prefix:




Optional prefix for Jaeger indices. For example, setting this to "production" creates indices named "production-jaeger-*".












esIndexCleaner:
  enabled:




When using Elasticsearch storage, by default a job is created to clean old traces from the index.  This parameter enables or disables the index cleaner job.






true/ false






true








esIndexCleaner:
  numberOfDays:




Number of days to wait before deleting an index.






Integer value






7








esIndexCleaner:
  schedule:




Defines the schedule for how often to clean the Elasticsearch index.






Cron expression






"55 23 * * *"








esRollover:
  schedule:




Defines the schedule for how often to rollover to a new Elasticsearch index.






Cron expression






'*/30 * * * *'








Configuration settings for Elasticsearch bulk processor






es:
  bulk:
    actions:




The number of requests that can be added to the queue before the bulk processor decides to commit updates to disk.








1000








es:
  bulk:
    flush-interval:




A time.Duration after which bulk requests are committed, regardless of other thresholds.  To disable the bulk processor flush interval, set this to zero.








200ms








es:
  bulk:
    size:




The number of bytes that the bulk requests can take up before the bulk processor decides to commit updates to disk.








5000000








es:
  bulk:
    workers:




The number of workers that are able to receive and commit bulk requests to Elasticsearch.








1








Elasticsearch TLS configuration settings






es:
  tls:
    ca:




Path to a TLS Certification Authority (CA) file used to verify the remote server(s).








Will use the system truststore by default.








es:
  tls:
    cert:




Path to a TLS Certificate file, used to identify this process to the remote server(s).












es:
  tls:
    enabled:




Enable transport layer security (TLS) when talking to the remote server(s). Disabled by default.






true/ false






false








es:
  tls:
    key:




Path to a TLS Private Key file, used to identify this process to the remote server(s).












es:
  tls:
    server-name:




Override the expected TLS server name in the certificate of the remote server(s).












es:
  token-file:




Path to a file containing the bearer token. This flag also loads the Certification Authority (CA) file if it is specified.












Elasticsearch archive configuration settings






es-archive:
  bulk:
    actions:




The number of requests that can be added to the queue before the bulk processor decides to commit updates to disk.








0








es-archive:
  bulk:
    flush-interval:




A time.Duration after which bulk requests are committed, regardless of other thresholds.  To disable the bulk processor flush interval, set this to zero.








0s








es-archive:
  bulk:
    size:




The number of bytes that the bulk requests can take up before the bulk processor decides to commit updates to disk.








0








es-archive:
  bulk:
    workers:




The number of workers that are able to receive and commit bulk requests to Elasticsearch.








0








es-archive:
  create-index-templates:




Automatically create index templates at application startup when set to true. When templates are installed manually, set to false.






true/ false






false








es-archive:
  enabled:




Enable extra storage.






true/ false






false








es-archive:
  index-prefix:




Optional prefix for Jaeger indices. For example, setting this to "production" creates indices named "production-jaeger-*".












es-archive:
  max-num-spans:




The maximum number of spans to fetch at a time, per query, in Elasticsearch.








0








es-archive:
  max-span-age:




The maximum lookback for spans in Elasticsearch.








0s








es-archive:
  num-replicas:




The number of replicas per index in Elasticsearch.








0








es-archive:
  num-shards:




The number of shards per index in Elasticsearch.








0








es-archive:
  password:




The password required by Elasticsearch.   See also, es.username.












es-archive:
  server-urls:




The comma-separated list of Elasticsearch servers.  Must be specified as fully qualified URLs, for example, http://localhost:9200.












es-archive:
  sniffer:




The sniffer configuration for Elasticsearch.  The client uses the sniffing process to find all nodes automatically. Disabled by default.






true/ false






false








es-archive:
  timeout:




Timeout used for queries. When set to zero there is no  timeout.








0s








es-archive:
  tls:
    ca:




Path to a TLS Certification Authority (CA) file used to verify the remote server(s).








Will use the system truststore by default.








es-archive:
  tls:
    cert:




Path to a TLS Certificate file, used to identify this process to the remote server(s).












es-archive:
  tls:
    enabled:




Enable transport layer security (TLS) when talking to the remote server(s). Disabled by default.






true/ false






false








es-archive:
  tls:
    key:




Path to a TLS Private Key file, used to identify this process to the remote server(s).












es-archive:
  tls:
    server-name:




Override the expected TLS server name in the certificate of the remote server(s).












es-archive:
  token-file:




Path to a file containing the bearer token. This flag also loads the Certification Authority (CA) file if it is specified.












es-archive:
  username:




The username required by Elasticsearch. The basic authentication also loads CA if it is specified.  See also es-archive.password.












es-archive:
  version:




The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.








0











Production storage example




apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 3
      resources:
        requests:
          cpu: 1
          memory: 16Gi
        limits:
          memory: 16Gi








Storage example with volume mounts




apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: https://quickstart-es-http.default.svc:9200
        index-prefix: my-prefix
        tls:
          ca: /es/certificates/ca.crt
    secretName: jaeger-secret
  volumeMounts:
    - name: certificates
      mountPath: /es/certificates/
      readOnly: true
  volumes:
    - name: certificates
      secret:
        secretName: quickstart-es-http-certs-public








Storage example with persistent storage:




apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-prod
spec:
  strategy: production
  storage:
    type: elasticsearch
    elasticsearch:
      nodeCount: 1
      storage: (1)
        storageClassName: gp2
        size: 5Gi
      resources:
        requests:
          cpu: 200m
          memory: 4Gi
        limits:
          memory: 4Gi
      redundancyPolicy: ZeroRedundancy











1
Persistent storage configuration. In this case AWS gp2 with 5Gi size. When no value is specified, Jaeger uses emptyDir. The Elasticsearch Operator provisions PersistentVolumeClaim and PersistentVolume which are not removed with Jaeger instance. You can mount the same volumes if you create a Jaeger instance with the same name and namespace.











Jaeger Query configuration options




Query is a service that retrieves traces from storage and hosts the user interface to display them.





Table 7. Jaeger Query parameters









Parameter
Description
Values
Default value







spec:
  query:
   options: {}
   resources: {}




Configuration options that define the Query service.












query:
  additional-headers:




Additional HTTP response headers. Can be specified multiple times.






Format: "Key: Value"










query:
  base-path:




The base path for all jaeger-query HTTP routes can be set to a non-root value, for example, /jaeger would cause all UI URLs to start with /jaeger. This can be useful when running jaeger-query behind a reverse proxy.






/{path}










query:
  port:




The port for the query service.








16686








options:
  log-level:




Logging level for Query.






Possible values: trace, debug, info, warning, error, fatal, panic.













Sample Query configuration




apiVersion: jaegertracing.io/v1
kind: "Jaeger"
metadata:
  name: "my-jaeger"
spec:
  strategy: allInOne
  allInOne:
    options:
      log-level: debug
      query:
        base-path: /jaeger










Jaeger Ingester configuration options




Ingester is a service that reads from a Kafka topic and writes to another storage backend (Elasticsearch).  If you are using the allInOne or production deployment strategies, you do not need to configure the Ingester service.





Table 8. Jaeger Ingester parameters used by the Operator








Parameter
Description
Values







ingester:
  deadlockInterval:




Specifies the interval (in seconds or minutes) that the Ingester should wait for a message before terminating.
The deadlock interval is disabled by default (set to 0), to avoid the Ingester being terminated when no messages arrive while the system is being initialized.






Minutes and seconds, for example, 1m0s.  Default value is 0.










Table 9. Jaeger parameters passed to the Ingester








Parameter
Description
Values







spec:
  strategy: streaming
  ingester:
    options: {}




Configuration options that define the Ingester service.










options:
  kafka:
    consumer:
      topic:




The topic parameter identifies the Kafka configuration used by the collector to produce the messages, and the ingester to consume the messages.






Label for the consumer. For example, jaeger-spans.








options:
  kafka:
    consumer:
      brokers:




Identifies the Kafka configuration used by the Ingester to consume the messages.






Label for the broker, for example, my-cluster-kafka-brokers.kafka:9092.








options:
  log-level:




Logging level for the Ingester.






Possible values: trace, debug, info, warning, error, fatal, panic.











Streaming Collector and Ingester example




apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: simple-streaming
spec:
  strategy: streaming
  collector:
    options:
      kafka:
        producer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
  ingester:
    options:
      kafka:
        consumer:
          topic: jaeger-spans
          brokers: my-cluster-kafka-brokers.kafka:9092
      ingester:
        deadlockInterval: 5
  storage:
    type: elasticsearch
    options:
      es:
        server-urls: http://elasticsearch:9200














Injecting sidecars






OpenShift Jaeger relies on a proxy sidecar within the application’s pod to provide the agent. The Jaeger Operator can inject Jaeger Agent sidecars into deployment workloads. You can enable automatic sidecar injection or manage it manually.






Automatically injecting sidecars




To enable this feature, you add the annotation sidecar.jaegertracing.io/inject set to either the string true or the Jaeger instance name as returned by oc get jaegers.
When you specify true, there should be only a single Jaeger instance for the same namespace as the deployment, otherwise, the Operator cannot determine which Jaeger instance to use.  A specific Jaeger instance name on a deployment has a higher precedence than true applied on its namespace.






The following snippet shows a simple application that will inject a sidecar, with the Jaeger Agent pointing to the single Jaeger instance available in the same namespace:






sample automatic sidecar injection




apiVersion: apps/v1
kind: deployment
metadata:
  name: myapp
  annotations:
    "sidecar.jaegertracing.io/inject": "true" (1)
spec:
  selector:
    matchLabels:
      app: myapp
  template:
    metadata:
      labels:
        app: myapp
    spec:
      containers:
      - name: myapp
        image: acme/myapp:myversion








When the sidecar is injected, the Jaeger Agent can then be accessed at its default location on localhost.








Manually injecting sidecars




For controller types other than deployments (for example,  StatefulSets, DaemonSets, etc.), you can manually define the Jaeger Agent sidecar in your specification.






The following snippet shows the manual definition you can include in your containers section for a Jaeger Agent sidecar:






example sidecar definition for a StatefulSet




apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: example-statefulset
  namespace: example-ns
  labels:
    app: example-app
spec:

    spec:
      containers:
        - name: example-app
          image: acme/myapp:myversion
          ports:
            - containerPort: 8080
              protocol: TCP
        - name: jaeger-agent
          image: registry.redhat.io/distributed-tracing/jaeger-agent-rhel7:<version>
           # The agent version must match the operator version
          imagePullPolicy: IfNotPresent
          ports:
            - containerPort: 5775
              name: zk-compact-trft
              protocol: UDP
            - containerPort: 5778
              name: config-rest
              protocol: TCP
            - containerPort: 6831
              name: jg-compact-trft
              protocol: UDP
            - containerPort: 6832
              name: jg-binary-trft
              protocol: UDP
            - containerPort: 14271
              name: admin-http
              protocol: TCP
          args:
            - --reporter.grpc.host-port=dns:///jaeger-collector-headless.example-ns:14250
            - --reporter.type=grpc








The Jaeger Agent can then be accessed at its default location on localhost.