mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
90 lines
2.9 KiB
Plaintext
90 lines
2.9 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * observability/monitoring/configuring-the-monitoring-stack.adoc
|
|
|
|
:_mod-docs-content-type: PROCEDURE
|
|
[id="enabling-query-logging-for-thanos-querier_{context}"]
|
|
= Enabling query logging for Thanos Querier
|
|
|
|
For default platform monitoring in the `openshift-monitoring` project, you can enable the {cmo-first} to log all queries run by Thanos Querier.
|
|
|
|
[IMPORTANT]
|
|
====
|
|
Because log rotation is not supported, only enable this feature temporarily when you need to troubleshoot an issue. After you finish troubleshooting, disable query logging by reverting the changes you made to the `ConfigMap` object to enable the feature.
|
|
====
|
|
|
|
.Prerequisites
|
|
|
|
* You have installed the {oc-first}.
|
|
* You have access to the cluster as a user with the `cluster-admin` cluster role.
|
|
* You have created the `cluster-monitoring-config` `ConfigMap` object.
|
|
|
|
.Procedure
|
|
|
|
You can enable query logging for Thanos Querier in the `openshift-monitoring` project:
|
|
|
|
. Edit the `cluster-monitoring-config` `ConfigMap` object in the `openshift-monitoring` project:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc -n openshift-monitoring edit configmap cluster-monitoring-config
|
|
----
|
|
+
|
|
. Add a `thanosQuerier` section under `data/config.yaml` and add values as shown in the following example:
|
|
+
|
|
[source,yaml]
|
|
----
|
|
apiVersion: v1
|
|
kind: ConfigMap
|
|
metadata:
|
|
name: cluster-monitoring-config
|
|
namespace: openshift-monitoring
|
|
data:
|
|
config.yaml: |
|
|
thanosQuerier:
|
|
enableRequestLogging: <value> <1>
|
|
logLevel: <value> <2>
|
|
|
|
|
|
----
|
|
<1> Set the value to `true` to enable logging and `false` to disable logging. The default value is `false`.
|
|
<2> Set the value to `debug`, `info`, `warn`, or `error`. If no value exists for `logLevel`, the log level defaults to `error`.
|
|
|
|
. Save the file to apply the changes. The pods affected by the new configuration are automatically redeployed.
|
|
|
|
.Verification
|
|
|
|
. Verify that the Thanos Querier pods are running. The following sample command lists the status of pods in the `openshift-monitoring` project:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc -n openshift-monitoring get pods
|
|
----
|
|
|
|
. Run a test query using the following sample commands as a model:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ token=`oc create token prometheus-k8s -n openshift-monitoring`
|
|
----
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc -n openshift-monitoring exec -c prometheus prometheus-k8s-0 -- curl -k -H "Authorization: Bearer $token" 'https://thanos-querier.openshift-monitoring.svc:9091/api/v1/query?query=cluster_version'
|
|
----
|
|
|
|
. Run the following command to read the query log:
|
|
+
|
|
[source,terminal]
|
|
----
|
|
$ oc -n openshift-monitoring logs <thanos_querier_pod_name> -c thanos-query
|
|
----
|
|
+
|
|
[NOTE]
|
|
====
|
|
Because the `thanos-querier` pods are highly available (HA) pods, you might be able to see logs in only one pod.
|
|
====
|
|
|
|
. After you examine the logged query information, disable query logging by changing the `enableRequestLogging` value to `false` in the config map.
|
|
|