From 23926e5d3c4151c50d4b218844db493cd41f3e9d Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Tue, 26 Nov 2024 17:12:11 +0000 Subject: [PATCH 1/5] Add workspace log docs --- docs/source/management/logs.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/source/management/logs.md b/docs/source/management/logs.md index f9a9948453..0b575fde2d 100644 --- a/docs/source/management/logs.md +++ b/docs/source/management/logs.md @@ -20,7 +20,7 @@ These include, - package proxy - Gitea and Hedgedoc -Logs from all containers are ingested into the [SREs log workspace](#log-workspace). +Logs from all containers are ingested into the [SRE's log analytics workspace](#log-workspace). There are two logs `ContainerEvents_CL` @@ -29,3 +29,18 @@ There are two logs `ContainerInstanceLog_CL` : Container process logs. : This is where you can view the output of the containerised applications and will be useful for debugging problems. + +## Workspace logs + +Logs from all user workspaces are ingested into the [SRE's log analytics workspace](#log-workspace). + +There are three logs + +`Perf` +: Usage statistics for individual workspaces, such as percent memory used and percent disk space used + +`Syslog` +: Linux system logs for individual workspaces, useful for debugging problems related to system processes + +`Heartbeat` +: Verification that the Azure Monitoring Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) \ No newline at end of file From 52f587ac824cee29652d63b8686f066272c7e8ca Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:13:12 +0000 Subject: [PATCH 2/5] fix linting --- docs/source/management/logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/management/logs.md b/docs/source/management/logs.md index 0b575fde2d..3c5b9c7b18 100644 --- a/docs/source/management/logs.md +++ b/docs/source/management/logs.md @@ -43,4 +43,4 @@ There are three logs : Linux system logs for individual workspaces, useful for debugging problems related to system processes `Heartbeat` -: Verification that the Azure Monitoring Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) \ No newline at end of file +: Verification that the Azure Monitoring Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) From dbcd646ce830ab31da58144d63bc682d03427c99 Mon Sep 17 00:00:00 2001 From: Matt Craddock <5796417+craddm@users.noreply.github.com> Date: Wed, 27 Nov 2024 14:14:40 +0000 Subject: [PATCH 3/5] Add link to docs for Azure Monitor Agent --- docs/source/management/logs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/management/logs.md b/docs/source/management/logs.md index 3c5b9c7b18..046f9c12eb 100644 --- a/docs/source/management/logs.md +++ b/docs/source/management/logs.md @@ -7,7 +7,7 @@ Some of these logs are ingested into a central location, an Azure [Log Analytics Each SRE has its own Log Analytics Workspace. You can view the workspaces by going to the Azure portal and navigating to [Log Analytics Workspaces](https://portal.azure.com/#browse/Microsoft.OperationalInsights%2Fworkspaces). -Select which log workspace you want to view by clicking on the workspace named `shm--sre--log`. +Select which Log Analytics Workspace you want to view by clicking on the workspace named `shm--sre--log`. The logs can be filtered using [Kusto Query Language (KQL)](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-query-overview). @@ -32,7 +32,7 @@ There are two logs ## Workspace logs -Logs from all user workspaces are ingested into the [SRE's log analytics workspace](#log-workspace). +Logs from all user workspaces are ingested into the [SRE's log analytics workspace](#log-workspace) using the [Azure Monitor Agent](https://learn.microsoft.com/en-us/azure/azure-monitor/agents/azure-monitor-agent-overview). There are three logs @@ -43,4 +43,4 @@ There are three logs : Linux system logs for individual workspaces, useful for debugging problems related to system processes `Heartbeat` -: Verification that the Azure Monitoring Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) +: Verification that the Azure Monitor Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) From 8222d646a49933dbad233cf6abe22c9a98f6a6f6 Mon Sep 17 00:00:00 2001 From: Jim Madge Date: Thu, 28 Nov 2024 09:52:18 +0000 Subject: [PATCH 4/5] Add full stops --- docs/source/management/logs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/management/logs.md b/docs/source/management/logs.md index 046f9c12eb..4fca60864b 100644 --- a/docs/source/management/logs.md +++ b/docs/source/management/logs.md @@ -37,10 +37,10 @@ Logs from all user workspaces are ingested into the [SRE's log analytics workspa There are three logs `Perf` -: Usage statistics for individual workspaces, such as percent memory used and percent disk space used +: Usage statistics for individual workspaces, such as percent memory used and percent disk space used. `Syslog` -: Linux system logs for individual workspaces, useful for debugging problems related to system processes +: Linux system logs for individual workspaces, useful for debugging problems related to system processes. `Heartbeat` -: Verification that the Azure Monitor Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace) +: Verification that the Azure Monitor Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace). From 7088eea3f1f49848f55a71b1e79beb7c7caaac2e Mon Sep 17 00:00:00 2001 From: Jim Madge Date: Thu, 28 Nov 2024 10:09:41 +0000 Subject: [PATCH 5/5] Adjust syslog description --- docs/source/management/logs.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/management/logs.md b/docs/source/management/logs.md index 4fca60864b..cf55508cd3 100644 --- a/docs/source/management/logs.md +++ b/docs/source/management/logs.md @@ -40,7 +40,9 @@ There are three logs : Usage statistics for individual workspaces, such as percent memory used and percent disk space used. `Syslog` -: Linux system logs for individual workspaces, useful for debugging problems related to system processes. +: [syslog](https://www.paessler.com/it-explained/syslog) events from workspaces. +: Syslog is the _de facto_ standard protocol for logging on Linux and most applications will log to it. +: These logs will be useful for debugging problems with the workspace or workspace software. `Heartbeat` : Verification that the Azure Monitor Agent is present on the workspaces and is able to connect to the [log analytics workspace](#log-workspace).