## Summary **Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`). Adds a front-matter `title` to every navigable docs page whose title can be migrated **mechanically**, with no editorial judgment. This is the content step that Phase 1 (renderers prefer front-matter title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware, `DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged and live. **Rendered no-op.** The renderers already resolve the page title from the manifest and hide the leading body H1 (Phase 1), so no page changes visually. This just moves the title into front matter where Fumadocs and the migrated tooling can read it. ## What's in this batch Dry-run on `main` (464 navigable pages) splits into: | category | count | this PR | |----------|-------|---------| | already has front-matter title (Reference, from Phase 2 generators) | 196 | skipped (idempotent) | | **mechanical** — leading body H1 equals the manifest label | 138 | ✅ add front-matter `title`, drop the duplicate H1 | | **no body H1** — renders under the manifest label only | 4 | ✅ add front-matter `title` only | | **mismatch** — body H1 differs from the manifest label | 126 | ⏭️ deferred (needs an editorial decision, see below) | 142 files changed, all under `docs/`. ## Deliberately out of scope: the 126 mismatches Pages where the body H1 is richer than the short sidebar label (e.g. label **Modules** / H1 *Contributing modules*, label **Install** / H1 *Installing Coder*) need a canonical-title decision, not a script. A few even look like the body H1 is the redundant one (`install/cli.md` and `install/index.md` both carry the H1 *Installing Coder*). These will land in follow-up batches **by nav section** once the policy is set, so each gets real review. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Every added front-matter block parses as YAML and its `title` round-trips to the manifest label (checked programmatically across all 142 files). - Every removed line is a leading `# H1` that equalled the manifest title; no body prose was reflowed. Front matter is correctly hoisted above pre-existing `<!-- markdownlint-disable -->` comments on the two pages that had them. - `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in Phase 4); `MD025` is not tripped because the duplicate body H1s are removed. ``` $ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main) Linting: 142 file(s) Summary: 0 error(s) ``` Linear: DOCS-484 > This PR was created with AI assistance (Coder Agents).
68 lines
2.6 KiB
Markdown
68 lines
2.6 KiB
Markdown
---
|
|
title: Logs
|
|
---
|
|
|
|
All Coder services log to standard output, which can be critical for identifying
|
|
errors and monitoring Coder's deployment health. Like any service, logs can be
|
|
captured via Splunk, Datadog, Grafana Loki, or other ingestion tools.
|
|
|
|
## `coderd` Logs
|
|
|
|
By default, the Coder server exports human-readable logs to standard output. You
|
|
can access these logs via `kubectl logs deployment/coder -n <coder-namespace>`
|
|
on Kubernetes or `journalctl -u coder` if you deployed Coder on a host
|
|
machine/VM.
|
|
|
|
- To change the log format/location, you can set
|
|
[`CODER_LOGGING_HUMAN`](../../reference/cli/server.md#--log-human) and
|
|
[`CODER_LOGGING_JSON`](../../reference/cli/server.md#--log-json) server config.
|
|
options.
|
|
- To only display certain types of logs, use
|
|
the[`CODER_LOG_FILTER`](../../reference/cli/server.md#-l---log-filter) server
|
|
config. Using `.*` will result in the `DEBUG` log level being used.
|
|
|
|
> [!NOTE]
|
|
> To disable human-readable logging, set `--log-human` (or
|
|
> `CODER_LOGGING_HUMAN`) to `/dev/null`. An empty string does not disable
|
|
> logging.
|
|
|
|
Events such as server errors, audit logs, user activities, and SSO & OpenID
|
|
Connect logs are all captured in the `coderd` logs.
|
|
|
|
## `provisionerd` Logs
|
|
|
|
Logs for [external provisioners](../provisioners/index.md) are structured
|
|
[and configured](../../reference/cli/provisioner_start.md#--log-human) similarly
|
|
to `coderd` logs. Use these logs to troubleshoot and monitor the Terraform
|
|
operations behind workspaces and templates.
|
|
|
|
## Workspace Logs
|
|
|
|
The [Coder agent](../infrastructure/architecture.md#agents) inside workspaces
|
|
provides useful logs around workspace-to-server and client-to-workspace
|
|
connections. For Kubernetes workspaces, these are typically the pod logs as the
|
|
agent runs via the container entrypoint.
|
|
|
|
Agent logs are also stored in the workspace filesystem by default:
|
|
|
|
- macOS/Linux: `/tmp/coder-agent.log`
|
|
- Windows: Refer to the template code (e.g.
|
|
[azure-windows](https://github.com/coder/coder/blob/2cfadad023cb7f4f85710cff0b21ac46bdb5a845/examples/templates/azure-windows/Initialize.ps1.tftpl#L64))
|
|
to see where logs are stored.
|
|
|
|
> [!NOTE]
|
|
> Logs are truncated once they reach 5MB in size.
|
|
|
|
Startup script logs are also stored in the temporary directory of macOS and
|
|
Linux workspaces.
|
|
|
|
## Kubernetes Event Logs
|
|
|
|
Sometimes, a workspace may take a while to start or even fail to start due to
|
|
underlying events on the Kubernetes cluster such as a node being out of
|
|
resources or a missing image. You can install
|
|
[coder-logstream-kube](../integrations/kubernetes-logs.md) to stream Kubernetes
|
|
events to the Coder UI.
|
|
|
|

|