Skip to content

Commit 998fbdf

Browse files
authored
docs: use CODER_LOG_FILTER instead of CODER_VERBOSE (#19105)
closes #18833 replace suggestions to use the now-deprecated `CODER_VERBOSE` with more specific `CODER_LOG_FILTER` thanks @UnicornyRainbow! --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
1 parent 428ec35 commit 998fbdf

File tree

3 files changed

+3
-4
lines changed

3 files changed

+3
-4
lines changed

docs/admin/monitoring/notifications/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ troubleshoot:
282282
1. Review the logs. Search for the term `notifications` for diagnostic information.
283283

284284
- If you do not see any relevant logs, set
285-
`CODER_VERBOSE=true` or `--verbose` to output debug logs.
285+
`CODER_LOG_FILTER=".*notifications.*"` to filter for notification-related logs.
286286
1. If you are on version 2.15.x, notifications must be enabled using the
287287
`notifications`
288288
[experiment](../../../install/releases/feature-stages.md#early-access-features).

docs/admin/users/idp-sync.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ Visit the Coder UI to confirm these changes:
203203
### Group allowlist
204204

205205
You can limit which groups from your identity provider can log in to Coder with
206-
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/cli/server#--oidc-allowed-groups).
206+
[CODER_OIDC_ALLOWED_GROUPS](../../reference/cli/server.md#--oidc-allowed-groups).
207207
Users who are not in a matching group will see the following error:
208208

209209
<Image height="412px" src="../../images/admin/group-allowlist.png" alt="Unauthorized group error" align="center" />
@@ -419,7 +419,6 @@ If you are running into issues with a sync:
419419
1. To reduce noise, you can filter for only logs related to group/role sync:
420420
421421
```sh
422-
CODER_VERBOSE=true
423422
CODER_LOG_FILTER=".*userauth.*|.*groups returned.*"
424423
```
425424

docs/admin/users/oidc-auth/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ claims from the ID token and the claims obtained from hitting the upstream
2727
provider's `userinfo` endpoint, and use the resulting data as a basis for
2828
creating a new user or looking up an existing user.
2929

30-
To troubleshoot claims, set `CODER_VERBOSE=true` and follow the logs while
30+
To troubleshoot claims, set `CODER_LOG_FILTER=".*got oidc claims.*"` and follow the logs while
3131
signing in via OIDC as a new user. Coder will log the claim fields returned by
3232
the upstream identity provider in a message containing the string
3333
`got oidc claims`, as well as the user info returned.

0 commit comments

Comments
 (0)