Skip to content

Commit 9959adb

Browse files
adellapeadellape
authored
Merge pull request #70512 from max-cx/OBSDOCS-577
OBSDOCS-577: Docs bug fix for an incorrect API
2 parents 5ee54a6 + a1083f2 commit 9959adb

File tree

4 files changed

+115
-47
lines changed

4 files changed

+115
-47
lines changed

‎distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ include::modules/distr-tracing-tempo-config-storage.adoc[leveloffset=+2]
2121

2222
include::modules/distr-tracing-tempo-config-query-frontend.adoc[leveloffset=+2]
2323

24+
[role="_additional-resources"]
25+
[id="additional-resources_distr-tracing-tempo-configuring"]
26+
==== Additional resources
27+
* xref:../../nodes/scheduling/nodes-scheduler-taints-tolerations.adoc#nodes-scheduler-taints-tolerations-about_nodes-scheduler-taints-tolerations[Understanding taints and tolerations]
28+
2429
include::modules/distr-tracing-tempo-config-spanmetrics.adoc[leveloffset=+2]
2530

2631
include::modules/distr-tracing-tempo-config-multitenancy.adoc[leveloffset=+2]

‎modules/distr-tracing-tempo-config-default.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ spec:
3838

3939
|apiVersion:
4040
|API version to use when creating the object.
41-
|`tempotracing.io/v1`
42-
|`tempotracing.io/v1`
41+
|`tempo.grafana.com/v1alpha1`
42+
|`tempo.grafana.com/v1alpha1`
4343

4444
|kind:
4545
|Defines the kind of Kubernetes object to create.

‎modules/distr-tracing-tempo-config-query-frontend.adoc

Lines changed: 107 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -6,62 +6,125 @@
66
[id="distr-tracing-tempo-config-query_{context}"]
77
= Query configuration options
88

9-
Query is a service that retrieves traces from storage and hosts the user interface to display them.
9+
Two components of the {TempoShortName}, the querier and query frontend, manage queries. You can configure both of these components.
1010

11-
.Parameters used by the {TempoOperator} to define Query
11+
The querier component finds the requested trace ID in the ingesters or back-end storage. Depending on the set parameters, the querier component can query both the ingesters and pull bloom or indexes from the back end to search blocks in object storage. The querier component exposes an HTTP endpoint at `GET /querier/api/traces/<traceID>`, but it is not expected to be used directly. Queries must be sent to the query frontend.
12+
13+
.Configuration parameters for the querier component
1214
[options="header"]
13-
[cols="l, a, a, a"]
1415
|===
15-
|Parameter |Description |Values |Default value
16-
17-
|spec:
18-
query:
19-
replicas:
20-
|Specifies the number of Query replicas to create.
21-
|Positive integer
22-
|
16+
|Parameter |Description |Values
17+
18+
|`nodeSelector`
19+
|The simple form of the node-selection constraint.
20+
|type: object
21+
22+
|`replicas`
23+
|The number of replicas to be created for the component.
24+
|type: integer; format: int32
25+
26+
|`tolerations`
27+
|Component-specific pod tolerations.
28+
|type: array
2329
|===
2430

31+
The query frontend component is responsible for sharding the search space for an incoming query. The query frontend exposes traces via a simple HTTP endpoint: `GET /api/traces/<traceID>`. Internally, the query frontend component splits the `blockID` space into a configurable number of shards and then queues these requests. The querier component connects to the query frontend component via a streaming gRPC connection to process these sharded queries.
2532

26-
.Configuration parameters passed to Query
33+
.Configuration parameters for the query frontend component
2734
[options="header"]
28-
[cols="l, a, a, a"]
2935
|===
30-
|Parameter |Description |Values |Default value
31-
32-
|spec:
33-
query:
34-
options: {}
35-
|Configuration options that define the Query service.
36-
|
37-
|
38-
39-
|options:
40-
log-level:
41-
|Logging level for Query.
42-
|`debug`, `info`, `warn`, `error`, `fatal`, `panic`
43-
|
44-
45-
|options:
46-
query:
47-
base-path:
48-
|You can set the base path for all tempo-query HTTP routes to a non-root value: for example, `/tempo` will cause all UI URLs to start with `/tempo`. This can be useful when running `tempo-query` behind a reverse proxy.
49-
|`/<path>`
50-
|
36+
|Parameter |Description |Values
37+
38+
|`component`
39+
|Configuration of the query frontend component.
40+
|type: object
41+
42+
|`component.nodeSelector`
43+
|The simple form of the node selection constraint.
44+
|type: object
45+
46+
|`component.replicas`
47+
|The number of replicas to be created for the query frontend component.
48+
|type: integer; format: int32
49+
50+
|`component.tolerations`
51+
|Pod tolerations specific to the query frontend component.
52+
|type: array
53+
54+
|`jaegerQuery`
55+
|The options specific to the Jaeger Query component.
56+
|type: object
57+
58+
|`jaegerQuery.enabled`
59+
|When `enabled`, creates the Jaeger Query component,`jaegerQuery`.
60+
|type: boolean
61+
62+
|`jaegerQuery.ingress`
63+
|The options for the Jaeger Query ingress.
64+
|type: object
65+
66+
|`jaegerQuery.ingress.annotations`
67+
|The annotations of the ingress object.
68+
|type: object
69+
70+
|`jaegerQuery.ingress.host`
71+
|The hostname of the ingress object.
72+
|type: string
73+
74+
|`jaegerQuery.ingress.ingressClassName`
75+
|The name of an IngressClass cluster resource. Defines which ingress controller serves this ingress resource.
76+
|type: string
77+
78+
|`jaegerQuery.ingress.route`
79+
|The options for the OpenShift route.
80+
|type: object
81+
82+
|`jaegerQuery.ingress.route.termination`
83+
|The termination type. The default is `edge`.
84+
|type: string (enum: insecure, edge, passthrough, reencrypt)
85+
86+
|`jaegerQuery.ingress.type`
87+
|The type of ingress for the Jaeger Query UI. The supported types are `ingress`, `route`, and `none`.
88+
|type: string (enum: ingress, route)
89+
90+
|`jaegerQuery.monitorTab`
91+
|The monitor tab configuration.
92+
|type: object
93+
94+
|`jaegerQuery.monitorTab.enabled`
95+
|Enables the monitor tab in the Jaeger console. The `PrometheusEndpoint` must be configured.
96+
|type: boolean
97+
98+
|`jaegerQuery.monitorTab.prometheusEndpoint`
99+
|The endpoint to the Prometheus instance that contains the span rate, error, and duration (RED) metrics. For example, `+https://thanos-querier.openshift-monitoring.svc.cluster.local:9091+`.
100+
|type: string
101+
51102
|===
52103

53-
.Sample Query configuration
104+
.Example configuration of the query frontend component in a `TempoStack` CR
54105
[source,yaml]
55106
----
56-
apiVersion: tempotracing.io/v1
57-
kind: "Tempo"
107+
apiVersion: tempo.grafana.com/v1alpha1
108+
kind: TempoStack
58109
metadata:
59-
name: "my-tempo"
110+
name: simplest
60111
spec:
61-
strategy: allInOne
62-
allInOne:
63-
options:
64-
log-level: debug
65-
query:
66-
base-path: /tempo
112+
storage:
113+
secret:
114+
name: minio
115+
type: s3
116+
storageSize: 200M
117+
resources:
118+
total:
119+
limits:
120+
memory: 2Gi
121+
cpu: 2000m
122+
template:
123+
queryFrontend:
124+
jaegerQuery:
125+
enabled: true
126+
ingress:
127+
route:
128+
termination: edge
129+
type: route
67130
----

‎modules/distr-tracing-tempo-config-spanmetrics.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
= Configuration of the monitor tab in Jaeger UI
88

99
Trace data contains rich information, and the data is normalized across instrumented languages and frameworks.
10-
Therefore, additional metrics can be extracted from traces. These metrics are request count, duration, and error count (RED).
10+
Therefore, request rate, error, and duration (RED) metrics can be extracted from traces.
1111
The metrics can be visualized in Jaeger console in the *Monitor* tab.
1212

1313
The metrics are derived from spans in the OpenTelemetry Collector that are scraped from the Collector by the Prometheus deployed in the user-workload monitoring stack.

0 commit comments

Comments
 (0)