You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-monitor/logs/basic-logs-configure.md
+39-38Lines changed: 39 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,29 @@
1
1
---
2
2
title: Configure Basic Logs in Azure Monitor
3
-
description: Configure a table for Basic Logs in Azure Monitor.
3
+
description: Learn how to configure a table for Basic Logs in Azure Monitor.
4
4
ms.topic: conceptual
5
5
ms.custom: event-tier1-build-2022
6
6
ms.date: 10/01/2022
7
7
---
8
8
9
9
# Configure Basic Logs in Azure Monitor
10
10
11
-
Setting a table's [log data plan](log-analytics-workspace-overview.md#log-data-plans) to *Basic Logs* lets you save on the cost of storing high-volume verbose logs you use for debugging, troubleshooting and auditing, but not for analytics and alerts. This article describes how to configure Basic Logs for a particular table in your Log Analytics workspace.
11
+
Setting a table's [log data plan](log-analytics-workspace-overview.md#log-data-plans) to **Basic Logs** lets you save on the cost of storing high-volume verbose logs you use for debugging, troubleshooting, and auditing, but not for analytics and alerts. This article describes how to configure Basic Logs for a particular table in your Log Analytics workspace.
12
12
13
13
> [!IMPORTANT]
14
-
> You can switch a table's plan once a week. The Basic Logs feature is not available for workspaces in [legacy pricing tiers](cost-logs.md#legacy-pricing-tiers).
14
+
> You can switch a table's plan once a week. The Basic Logs feature isn't available for workspaces in [legacy pricing tiers](cost-logs.md#legacy-pricing-tiers).
15
15
16
16
## Which tables support Basic Logs?
17
-
By default, all tables in your Log Analytics are Analytics tables, and available for query and alerts.
18
-
You can currently configure the following tables for Basic Logs:
19
17
20
-
- All custom tables created with or migrated to the [Data Collection Rule (DCR)-based logs ingestion API.](logs-ingestion-api-overview.md)
21
-
-[ContainerLogV2](/azure/azure-monitor/reference/tables/containerlogv2) - Used in [Container Insights](../containers/container-insights-overview.md) and includes verbose text-based log records.
-[ContainerAppConsoleLogs](/azure/azure-monitor/reference/tables/ContainerAppConsoleLogs) - Logs generated by Container Apps, within a Container App environment.
18
+
By default, all tables in your Log Analytics workspace are Analytics tables, and they're available for query and alerts. You can currently configure the following tables for Basic Logs:
19
+
20
+
- Custom tables: All custom tables created with or migrated to the [data collection rule (DCR)-based logs ingestion API.](logs-ingestion-api-overview.md)
21
+
-[ContainerLogV2](/azure/azure-monitor/reference/tables/containerlogv2): Used in [Container insights](../containers/container-insights-overview.md) and includes verbose text-based log records.
-[ContainerAppConsoleLogs](/azure/azure-monitor/reference/tables/ContainerAppConsoleLogs): Logs generated by Azure Container Apps, within a Container Apps environment.
24
24
25
25
> [!NOTE]
26
-
> Tables created with the [Data Collector API](data-collector-api.md)do not support Basic Logs.
26
+
> Tables created with the [Data Collector API](data-collector-api.md)don't support Basic Logs.
27
27
28
28
## Set table configuration
29
29
@@ -33,17 +33,17 @@ To configure a table for Basic Logs or Analytics Logs in the Azure portal:
33
33
34
34
1. From the **Log Analytics workspaces** menu, select **Tables**.
35
35
36
-
The **Tables** screen lists all of the tables in the workspace.
36
+
The **Tables** screen lists all the tables in the workspace.
37
37
38
38
1. Select the context menu for the table you want to configure and select **Manage table**.
39
39
40
-
:::image type="content" source="media/basic-logs-configure/log-analytics-table-configuration.png" lightbox="media/basic-logs-configure/log-analytics-table-configuration.png" alt-text="Screenshot showing the Manage table button for one of the tables in a workspace.":::
40
+
:::image type="content" source="media/basic-logs-configure/log-analytics-table-configuration.png" lightbox="media/basic-logs-configure/log-analytics-table-configuration.png" alt-text="Screenshot that shows the Manage table button for one of the tables in a workspace.":::
41
41
42
42
1. From the **Table plan** dropdown on the table configuration screen, select **Basic** or **Analytics**.
43
43
44
44
The **Table plan** dropdown is enabled only for [tables that support Basic Logs](#which-tables-support-basic-logs).
45
45
46
-
:::image type="content" source="media/basic-logs-configure/log-analytics-configure-table-plan.png" lightbox="media/basic-logs-configure/log-analytics-configure-table-plan.png" alt-text="Screenshot showing the Table plan dropdown on the table configuration screen.":::
46
+
:::image type="content" source="media/basic-logs-configure/log-analytics-configure-table-plan.png" lightbox="media/basic-logs-configure/log-analytics-configure-table-plan.png" alt-text="Screenshot that shows the Table plan dropdown on the table configuration screen.":::
47
47
48
48
1. Select **Save**.
49
49
@@ -54,20 +54,21 @@ To configure a table for Basic Logs or Analytics Logs, call the **Tables - Updat
> Use the Bearer token for authentication. Read more about [using Bearer tokens](https://social.technet.microsoft.com/wiki/contents/articles/51140.azure-rest-management-api-the-quickest-way-to-get-your-bearer-token.aspx).
59
+
> Use the bearer token for authentication. Learn more about [using bearer tokens](https://social.technet.microsoft.com/wiki/contents/articles/51140.azure-rest-management-api-the-quickest-way-to-get-your-bearer-token.aspx).
59
60
60
61
**Request body**
61
62
62
63
|Name | Type | Description |
63
64
| --- | --- | --- |
64
-
|properties.plan | string | The table plan. Possible values are *Analytics* and *Basic*.|
65
+
|properties.plan | string | The table plan. Possible values are `Analytics` and `Basic`.|
65
66
66
67
**Example**
67
68
68
69
This example configures the `ContainerLogV2` table for Basic Logs.
69
70
70
-
Container Insights uses ContainerLog by default. To switch to using ContainerLogV2 for Container Insights, [enable the ContainerLogV2 schema](../containers/container-insights-logging-v2.md) before you convert the table to Basic Logs.
71
+
Container insights uses `ContainerLog` by default. To switch to using `ContainerLogV2` for Container insights, [enable the ContainerLogV2 schema](../containers/container-insights-logging-v2.md) before you convert the table to Basic Logs.
71
72
72
73
**Sample request**
73
74
@@ -97,7 +98,7 @@ Use this request body to change to Analytics Logs:
97
98
98
99
**Sample response**
99
100
100
-
This is the response for a table changed to Basic Logs.
101
+
This sample is the response for a table changed to Basic Logs:
To check table configuration in the Azure portal, you can open the table configuration screen, as described in [Set table configuration](#set-table-configuration).
144
+
To check table configuration in the Azure portal, you can open the table configuration screen, as described in [Set table configuration](#set-table-configuration).
143
145
144
-
Alternatively:
146
+
Alternatively:
145
147
146
-
1. From the **Azure Monitor** menu, select **Logs** and select your workspace for the [scope](scope.md). See [Log Analytics tutorial](log-analytics-tutorial.md#view-table-information) for a walkthrough.
147
-
1. Open the **Tables** tab, which lists all tables in the workspace.
148
+
1. From the **Azure Monitor** menu, select **Logs** and select your workspace for the [scope](scope.md). See the [Log Analytics tutorial](log-analytics-tutorial.md#view-table-information) for a walkthrough.
149
+
1. Open the **Tables** tab, which lists all tables in the workspace.
148
150
149
-
Basic Logs tables have a unique icon:
151
+
Basic Logs tables have a unique icon:
150
152
151
-
:::image type="content" source="media/basic-logs-configure/table-icon.png" alt-text="Screenshot of the Basic Logs table icon in the table list." lightbox="media/basic-logs-configure/table-icon.png":::
153
+
:::image type="content" source="media/basic-logs-configure/table-icon.png" alt-text="Screenshot that shows the Basic Logs table icon in the table list." lightbox="media/basic-logs-configure/table-icon.png":::
152
154
153
155
You can also hover over a table name for the table information view, which indicates whether the table is configured as Basic Logs:
154
156
155
-
:::image type="content" source="media/basic-logs-configure/table-info.png" alt-text="Screenshot of the Basic Logs table indicator in the table details." lightbox="media/basic-logs-configure/table-info.png":::
156
-
157
+
:::image type="content" source="media/basic-logs-configure/table-info.png" alt-text="Screenshot that shows the Basic Logs table indicator in the table details." lightbox="media/basic-logs-configure/table-info.png":::
158
+
157
159
# [API](#tab/api-2)
158
160
159
161
To check the configuration of a table, call the **Tables - Get** API:
@@ -162,24 +164,23 @@ To check the configuration of a table, call the **Tables - Get** API:
162
164
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}?api-version=2021-12-01-preview
163
165
```
164
166
165
-
**Response Body**
167
+
**Response body**
166
168
167
169
|Name | Type | Description |
168
170
| --- | --- | --- |
169
-
|properties.plan | string | The table plan. Either "Analytics" or "Basic". |
170
-
|properties.retentionInDays | integer | The table's data retention in days. In _Basic Logs_, the value is 8 days, fixed. In _Analytics Logs_, the value is between 7 and 730.|
171
-
|properties.totalRetentionInDays | integer | The table's data retention including Archive period|
171
+
|properties.plan | string | The table plan. Either `Analytics` or `Basic`. |
172
+
|properties.retentionInDays | integer | The table's data retention in days. In `Basic Logs`, the value is 8 days, fixed. In `Analytics Logs`, the value is between 7 and 730 days.|
173
+
|properties.totalRetentionInDays | integer | The table's data retention that also includes the archive period.|
172
174
|properties.archiveRetentionInDays|integer|The table's archive period (read-only, calculated).|
173
-
|properties.lastPlanModifiedDate|String|Last time when plan was set for this table. Null if no change was ever done from the default settings (read-only)
175
+
|properties.lastPlanModifiedDate|String|Last time when the plan was set for this table. Null if no change was ever done from the default settings (read-only).
174
176
175
-
**Sample Request**
177
+
**Sample request**
176
178
177
179
```http
178
180
GET https://management.azure.com/subscriptions/ContosoSID/resourcegroups/ContosoRG/providers/Microsoft.OperationalInsights/workspaces/ContosoWorkspace/tables/ContainerLogV2?api-version=2021-12-01-preview
179
181
```
180
182
181
-
182
-
**Sample Response**
183
+
**Sample response**
183
184
184
185
Status code: 200
185
186
```http
@@ -210,13 +211,13 @@ az monitor log-analytics workspace table show --subscription ContosoSID --resour
210
211
211
212
---
212
213
213
-
## Retention and archiving of Basic Logs
214
+
## Retain and archive Basic Logs
214
215
215
216
Analytics tables retain data based on a [retention and archive policy](data-retention-archive.md) you set.
216
217
217
-
Basic Logs tables retain data for eight days. When you change an existing table's plan to Basic Logs, Azure archives data that is more than eight days old but still within the table's original retention period.
218
+
Basic Logs tables retain data for eight days. When you change an existing table's plan to Basic Logs, Azure archives data that's more than eight days old but still within the table's original retention period.
218
219
219
220
## Next steps
220
221
221
-
-[Learn more about the different log plans.](log-analytics-workspace-overview.md#log-data-plans)
222
-
-[Query data in Basic Logs.](basic-logs-query.md)
222
+
-[Learn more about the different log plans](log-analytics-workspace-overview.md#log-data-plans)
0 commit comments