Skip to content

Commit a949d66

Browse files
authored
Merge pull request #230376 from damendo/main
Syslog doc updates
2 parents 2469f3c + ca8afe2 commit a949d66

File tree

4 files changed

+34
-6
lines changed

4 files changed

+34
-6
lines changed

articles/azure-monitor/containers/container-insights-syslog.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,24 @@ Container Insights offers the ability to collect Syslog events from Linux nodes
1515
1616
## Prerequisites
1717

18-
- You will need to have managed identity authentication enabled on your cluster. To enable, see [migrate your AKS cluster to managed identity authentication](container-insights-enable-existing-clusters.md?tabs=azure-cli#migrate-to-managed-identity-authentication). Note: This which will create a Data Collection Rule (DCR) named `MSCI-<WorkspaceRegion>-<ClusterName>`
18+
- You need to have managed identity authentication enabled on your cluster. To enable, see [migrate your AKS cluster to managed identity authentication](container-insights-enable-existing-clusters.md?tabs=azure-cli#migrate-to-managed-identity-authentication). Note: Enabling Managed Identity will create a new Data Collection Rule (DCR) named `MSCI-<WorkspaceRegion>-<ClusterName>`
1919
- Minimum versions of Azure components
2020
- **Azure CLI**: Minimum version required for Azure CLI is [2.45.0 (link to release notes)](/cli/azure/release-notes-azure-cli#february-07-2023). See [How to update the Azure CLI](/cli/azure/update-azure-cli) for upgrade instructions.
2121
- **Azure CLI AKS-Preview Extension**: Minimum version required for AKS-Preview Azure CLI extension is [ 0.5.125 (link to release notes)](https://github.com/Azure/azure-cli-extensions/blob/main/src/aks-preview/HISTORY.rst#05125). See [How to update extensions](/cli/azure/azure-cli-extensions-overview#how-to-update-extensions) for upgrade guidance.
2222
- **Linux image version**: Minimum version for AKS node linux image is 2022.11.01. See [Upgrade Azure Kubernetes Service (AKS) node images](https://learn.microsoft.com/azure/aks/node-image-upgrade) for upgrade help.
2323

2424
## How to enable Syslog
25-
26-
Use the following command in Azure CLI to enable syslog collection when you create a new AKS cluster.
25+
26+
### From the Azure portal
27+
28+
Navigate to your cluster. Open the _Insights_ tab for your cluster. Open the _Monitor Settings_ panel. Click on Edit collection settings, then check the box for _Enable Syslog collection_
29+
30+
:::image type="content" source="media/container-insights-syslog/syslog-enable.gif" lightbox="media/container-insights-syslog/syslog-enable.gif" alt-text="Screen recording of syslog being enabled from the Azure portal through the Monitor Settings panel in Container Insights." border="true":::
2731

2832
### Using Azure CLI commands
2933

34+
Use the following command in Azure CLI to enable syslog collection when you create a new AKS cluster.
35+
3036
```azurecli
3137
az aks create -g syslog-rg -n new-cluster --enable-managed-identity --node-count 1 --enable-addons monitoring --enable-msi-auth-for-monitoring --enable-syslog --generate-ssh-key
3238
```
@@ -89,7 +95,23 @@ provisioningState : Succeeded
8995
```
9096

9197
## How to access Syslog data
92-
98+
99+
### Access using built-in workbooks
100+
101+
To get a quick snapshot of your syslog data, customers can use our built-in Syslog workbook. There are two ways to access the built-in workbook.
102+
103+
Option 1 - The Reports tab in Container Insights.
104+
Navigate to your cluster. Open the _Insights_ tab for your cluster. Open the _Reports_ tab and look for the _Syslog_ workbook.
105+
106+
:::image type="content" source="media/container-insights-syslog/syslog-workbook-cluster.gif" lightbox="media/container-insights-syslog/syslog-workbook-cluster.gif" alt-text="Video of Syslog workbook being accessed from Container Insights Reports tab." border="true":::
107+
108+
Option 2 - The Workbooks tab in AKS
109+
Navigate to your cluster. Open the _Workbooks_ tab for your cluster and look for the _Syslog_ workbook.
110+
111+
:::image type="content" source="media/container-insights-syslog/syslog-workbook-container-insights-reports-tab.gif" lightbox="media/container-insights-syslog/syslog-workbook-container-insights-reports-tab.gif" alt-text="Video of Syslog workbook being accessed from cluster workbooks tab." border="true":::
112+
113+
### Access using log queries
114+
93115
Syslog data is stored in the [Syslog](/azure/azure-monitor/reference/tables/syslog) table in your Log Analytics workspace. You can create your own [log queries](../logs/log-query-overview.md) in [Log Analytics](../logs/log-analytics-overview.md) to analyze this data or use any of the [prebuilt queries](../logs/log-query-overview.md).
94116

95117
:::image type="content" source="media/container-insights-syslog/azmon-3.png" lightbox="media/container-insights-syslog/azmon-3.png" alt-text="Screenshot of Syslog query loaded in the query editor in the Azure Monitor Portal UI." border="false":::
@@ -98,7 +120,7 @@ You can open Log Analytics from the **Logs** menu in the **Monitor** menu to acc
98120

99121
:::image type="content" source="media/container-insights-syslog/aks-4.png" lightbox="media/container-insights-syslog/aks-4.png" alt-text="Screenshot of Query editor with Syslog query." border="false":::
100122

101-
### Sample queries
123+
#### Sample queries
102124

103125
The following table provides different examples of log queries that retrieve Syslog records.
104126

@@ -135,5 +157,11 @@ Select the minimum log level for each facility that you want to collect.
135157

136158
## Next steps
137159

138-
- Read more about [Syslog record properties](/azure/azure-monitor/reference/tables/syslog)
160+
Once setup customers can start sending Syslog data to the tools of their choice
161+
- Send Syslog to Microsoft Sentinel: https://learn.microsoft.com/azure/sentinel/connect-syslog
162+
- Export data from Log Analytics: https://learn.microsoft.com/azure/azure-monitor/logs/logs-data-export?tabs=portal
163+
164+
Read more
165+
- [Syslog record properties](/azure/azure-monitor/reference/tables/syslog)
139166

167+
Share your feedback for the preview here: https://forms.office.com/r/BBvCjjDLTS
2.49 MB
Loading
6.43 MB
Loading
Loading

0 commit comments

Comments
 (0)