Skip to content

Commit 810b070

Browse files
authored
Merge pull request #214535 from paulth1/log-articles-batch-2
edit pass: Log articles batch 2
2 parents 1d53775 + 3c0a6fe commit 810b070

File tree

5 files changed

+321
-266
lines changed

5 files changed

+321
-266
lines changed

articles/azure-monitor/logs/basic-logs-configure.md

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
22
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.
44
ms.topic: conceptual
55
ms.custom: event-tier1-build-2022
66
ms.date: 10/01/2022
77
---
88

99
# Configure Basic Logs in Azure Monitor
1010

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.
1212

1313
> [!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).
1515
1616
## 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:
1917

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.
22-
- [AppTraces](/azure/azure-monitor/reference/tables/apptraces) - Freeform Application Insights traces.
23-
- [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.
22+
- [AppTraces](/azure/azure-monitor/reference/tables/apptraces): Freeform Application Insights traces.
23+
- [ContainerAppConsoleLogs](/azure/azure-monitor/reference/tables/ContainerAppConsoleLogs): Logs generated by Azure Container Apps, within a Container Apps environment.
2424

2525
> [!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.
2727
2828
## Set table configuration
2929

@@ -33,17 +33,17 @@ To configure a table for Basic Logs or Analytics Logs in the Azure portal:
3333

3434
1. From the **Log Analytics workspaces** menu, select **Tables**.
3535

36-
The **Tables** screen lists all of the tables in the workspace.
36+
The **Tables** screen lists all the tables in the workspace.
3737

3838
1. Select the context menu for the table you want to configure and select **Manage table**.
3939

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.":::
4141

4242
1. From the **Table plan** dropdown on the table configuration screen, select **Basic** or **Analytics**.
4343

4444
The **Table plan** dropdown is enabled only for [tables that support Basic Logs](#which-tables-support-basic-logs).
4545

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.":::
4747

4848
1. Select **Save**.
4949

@@ -54,20 +54,21 @@ To configure a table for Basic Logs or Analytics Logs, call the **Tables - Updat
5454
```http
5555
PATCH https://management.azure.com/subscriptions/<subscriptionId>/resourcegroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/tables/<tableName>?api-version=2021-12-01-preview
5656
```
57+
5758
> [!IMPORTANT]
58-
> 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).
5960
6061
**Request body**
6162

6263
|Name | Type | Description |
6364
| --- | --- | --- |
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`.|
6566

6667
**Example**
6768

6869
This example configures the `ContainerLogV2` table for Basic Logs.
6970

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.
7172

7273
**Sample request**
7374

@@ -97,7 +98,7 @@ Use this request body to change to Analytics Logs:
9798

9899
**Sample response**
99100

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:
101102

102103
Status code: 200
103104

@@ -133,27 +134,28 @@ For example:
133134
```azurecli
134135
az monitor log-analytics workspace table update --subscription ContosoSID --resource-group ContosoRG --workspace-name ContosoWorkspace --name ContainerLogV2 --plan Analytics
135136
```
136-
137+
137138
---
138139
139140
## Check table configuration
141+
140142
# [Portal](#tab/portal-2)
141143
142-
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).
143145
144-
Alternatively:
146+
Alternatively:
145147
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.
148150
149-
Basic Logs tables have a unique icon:
151+
Basic Logs tables have a unique icon:
150152
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":::
152154
153155
You can also hover over a table name for the table information view, which indicates whether the table is configured as Basic Logs:
154156
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+
157159
# [API](#tab/api-2)
158160
159161
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:
162164
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}?api-version=2021-12-01-preview
163165
```
164166

165-
**Response Body**
167+
**Response body**
166168

167169
|Name | Type | Description |
168170
| --- | --- | --- |
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.|
172174
|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).
174176

175-
**Sample Request**
177+
**Sample request**
176178

177179
```http
178180
GET https://management.azure.com/subscriptions/ContosoSID/resourcegroups/ContosoRG/providers/Microsoft.OperationalInsights/workspaces/ContosoWorkspace/tables/ContainerLogV2?api-version=2021-12-01-preview
179181
```
180182

181-
182-
**Sample Response**
183+
**Sample response**
183184

184185
Status code: 200
185186
```http
@@ -210,13 +211,13 @@ az monitor log-analytics workspace table show --subscription ContosoSID --resour
210211

211212
---
212213

213-
## Retention and archiving of Basic Logs
214+
## Retain and archive Basic Logs
214215

215216
Analytics tables retain data based on a [retention and archive policy](data-retention-archive.md) you set.
216217

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.
218219

219220
## Next steps
220221

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)
223+
- [Query data in Basic Logs](basic-logs-query.md)

0 commit comments

Comments
 (0)