Skip to content

Commit 5d45218

Browse files
authored
docs: application logs (#8166)
1 parent 3b9b06f commit 5d45218

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

docs/admin/app-logs.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Application Logs
2+
3+
In Coderd, application logs refer to the records of events, messages, and activities generated by the application during its execution.
4+
These logs provide valuable information about the application's behavior, performance, and any issues that may have occurred.
5+
6+
Application logs include entries that capture events on different levels of severity:
7+
8+
- Informational messages
9+
- Warnings
10+
- Errors
11+
- Debugging information
12+
13+
By analyzing application logs, system administrators can gain insights into the application's behavior, identify and diagnose problems, track performance metrics, and make informed decisions to improve the application's stability and efficiency.
14+
15+
## Error logs
16+
17+
To ensure effective monitoring and timely response to critical events in the Coder application, it is recommended to configure log alerts
18+
that specifically watch for the following log entries:
19+
20+
| Log Level | Module | Log message | Potential issues |
21+
| --------- | ---------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------- |
22+
| `ERROR` | `coderd` | `workspace build error` | Workspace owner is unable to start their workspace. |
23+
| `ERROR` | `coderd.autobuild` | `workspace build error` | Autostart failed to initiate the workspace. |
24+
| `ERROR` | `coderd.provisionerd-<name>` | | The provisioner job encounters issues importing the workspace template or building the workspace. |
25+
| `ERROR` | `coderd.userauth` | | Authentication problems, such as the inability of the workspace user to log in. |
26+
| `ERROR` | `coderd.prometheusmetrics` | | The metrics aggregator's queue is full, causing it to reject new metrics. |

docs/images/icons/notes.svg

+1
Loading

docs/manifest.json

+6
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,12 @@
314314
"icon_path": "./images/icons/networking.svg",
315315
"state": "enterprise"
316316
},
317+
{
318+
"title": "Application Logs",
319+
"description": "Learn how to use Application Logs in your Coder deployment",
320+
"path": "./admin/app-logs.md",
321+
"icon_path": "./images/icons/notes.svg"
322+
},
317323
{
318324
"title": "Audit Logs",
319325
"description": "Learn how to use Audit Logs in your Coder deployment",

0 commit comments

Comments
 (0)