From 5d45218a5d8398faffd5e6bd5d0e1a8c343270bf Mon Sep 17 00:00:00 2001 From: Marcin Tojek Date: Thu, 22 Jun 2023 23:25:17 +0200 Subject: [PATCH] docs: application logs (#8166) --- docs/admin/app-logs.md | 26 ++++++++++++++++++++++++++ docs/images/icons/notes.svg | 1 + docs/manifest.json | 6 ++++++ 3 files changed, 33 insertions(+) create mode 100644 docs/admin/app-logs.md create mode 100644 docs/images/icons/notes.svg diff --git a/docs/admin/app-logs.md b/docs/admin/app-logs.md new file mode 100644 index 0000000000..87efe05ae6 --- /dev/null +++ b/docs/admin/app-logs.md @@ -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-` | | 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. | diff --git a/docs/images/icons/notes.svg b/docs/images/icons/notes.svg new file mode 100644 index 0000000000..b21b109d55 --- /dev/null +++ b/docs/images/icons/notes.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/manifest.json b/docs/manifest.json index f01144605e..00574def08 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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",