Skip to content

Commit 4a3d124

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 5400ec2 commit 4a3d124

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

Diff for: CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Note: This CHANGELOG is only for the monitoring team to track all monitoring related changes. Please see OpenShift release notes for official changes.
22

3+
## 4.10
4+
5+
- [#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.
6+
37
## 4.9
48

59
- [#1312](https://github.com/openshift/cluster-monitoring-operator/pull/1312) Support label to exclude namespaces from user-workload monitoring.

Diff for: 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

Diff for: examples/user-workload/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,5 @@ externalLabels map[string]string
3939
volumeClaimTemplate *v1.PersistentVolumeClaim
4040
hostport string
4141
remoteWrite []monv1.RemoteWriteSpec
42+
queryLogFile string
4243
```

0 commit comments

Comments
 (0)