Skip to content

Commit 9640f56

Browse files
committed
docs: Describe the queryLogFile setting
We want to allow cluster admins to enable the query log, however it should be noted that this is a temporary solution for debugging situations ad-hoc and should not be enabled permanently. https://prometheus.io/docs/guides/query-log/
1 parent fbc0f79 commit 9640f56

File tree

3 files changed

+23
-17
lines changed

3 files changed

+23
-17
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [#1402](https://github.com/openshift/cluster-monitoring-operator/pull/1402) Drop pod-centric cAdvisor metrics that are available at slice level.
77
- [#1399](https://github.com/openshift/cluster-monitoring-operator/pull/1399) Rename ThanosSidecarUnhealthy to ThanosSidecarNoConnectionToStartedPrometheus and make it resilient to WAL replays.
88
- [#1446](https://github.com/openshift/cluster-monitoring-operator/pull/1446) Bump Grafana version to 7.5.11
9+
- [#1373](https://github.com/openshift/cluster-monitoring-operator/pull/1373) Enable admins to toggle the [query_log_file](https://prometheus.io/docs/guides/query-log/#enable-the-query-log) setting for Prometheus.
910

1011
## 4.9
1112

Documentation/user-guides/configuring-cluster-monitoring.md

+4
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,10 @@ resources: [v1.ResourceRequirements](https://kubernetes.io/docs/api-reference/v1
8383
# specified by users
8484
externalLabels:
8585
[ - <labelname>: <labelvalue> ]
86+
# log all the queries run by the engine to a log file
87+
# this option should be enabled temporarily only to support debugging
88+
# as there is no option to support or manage log rotation
89+
queryLogFile: string
8690
```
8791
8892
### AlertmanagerMainConfig

examples/user-workload/README.md

+18-17
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,26 @@ data:
1818
Configuration example is located in this directory, with the following supported configuration fields:
1919
```
2020
prometheusOperator:
21-
logLevel string
22-
nodeSelector map[string]string
23-
tolerations []v1.Toleration
21+
logLevel string
22+
nodeSelector map[string]string
23+
tolerations []v1.Toleration
2424
2525
thanosRuler:
26-
logLevel string
27-
nodeSelector map[string]string
28-
tolerations []v1.Toleration
29-
resources *v1.ResourceRequirements
30-
volumeClaimTemplate *v1.PersistentVolumeClaim
26+
logLevel string
27+
nodeSelector map[string]string
28+
tolerations []v1.Toleration
29+
resources *v1.ResourceRequirements
30+
volumeClaimTemplate *v1.PersistentVolumeClaim
3131
3232
prometheus:
33-
logLevel string
34-
nodeSelector map[string]string
35-
tolerations []v1.Toleration
36-
retention string
37-
resources *v1.ResourceRequirements
38-
externalLabels map[string]string
39-
volumeClaimTemplate *v1.PersistentVolumeClaim
40-
hostport string
41-
remoteWrite []monv1.RemoteWriteSpec
33+
logLevel string
34+
nodeSelector map[string]string
35+
tolerations []v1.Toleration
36+
retention string
37+
resources *v1.ResourceRequirements
38+
externalLabels map[string]string
39+
volumeClaimTemplate *v1.PersistentVolumeClaim
40+
hostport string
41+
remoteWrite []monv1.RemoteWriteSpec
42+
queryLogFile string
4243
```

0 commit comments

Comments
 (0)