mirror of https://github.com/coder/coder.git
docs: application logs (#8166)
This commit is contained in:
parent
3b9b06fe5a
commit
5d45218a5d
|
@ -0,0 +1,26 @@
|
|||
# Application Logs
|
||||
|
||||
In Coderd, application logs refer to the records of events, messages, and activities generated by the application during its execution.
|
||||
These logs provide valuable information about the application's behavior, performance, and any issues that may have occurred.
|
||||
|
||||
Application logs include entries that capture events on different levels of severity:
|
||||
|
||||
- Informational messages
|
||||
- Warnings
|
||||
- Errors
|
||||
- Debugging information
|
||||
|
||||
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.
|
||||
|
||||
## Error logs
|
||||
|
||||
To ensure effective monitoring and timely response to critical events in the Coder application, it is recommended to configure log alerts
|
||||
that specifically watch for the following log entries:
|
||||
|
||||
| Log Level | Module | Log message | Potential issues |
|
||||
| --------- | ---------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------- |
|
||||
| `ERROR` | `coderd` | `workspace build error` | Workspace owner is unable to start their workspace. |
|
||||
| `ERROR` | `coderd.autobuild` | `workspace build error` | Autostart failed to initiate the workspace. |
|
||||
| `ERROR` | `coderd.provisionerd-<name>` | | The provisioner job encounters issues importing the workspace template or building the workspace. |
|
||||
| `ERROR` | `coderd.userauth` | | Authentication problems, such as the inability of the workspace user to log in. |
|
||||
| `ERROR` | `coderd.prometheusmetrics` | | The metrics aggregator's queue is full, causing it to reject new metrics. |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns="http://www.w3.org/2000/svg" height="48" viewBox="0 -960 960 960" width="48"><path d="M120-240v-60h480v60H120Zm0-210v-60h720v60H120Zm0-210v-60h720v60H120Z"/></svg>
|
After Width: | Height: | Size: 174 B |
|
@ -314,6 +314,12 @@
|
|||
"icon_path": "./images/icons/networking.svg",
|
||||
"state": "enterprise"
|
||||
},
|
||||
{
|
||||
"title": "Application Logs",
|
||||
"description": "Learn how to use Application Logs in your Coder deployment",
|
||||
"path": "./admin/app-logs.md",
|
||||
"icon_path": "./images/icons/notes.svg"
|
||||
},
|
||||
{
|
||||
"title": "Audit Logs",
|
||||
"description": "Learn how to use Audit Logs in your Coder deployment",
|
||||
|
|
Loading…
Reference in New Issue