Skip to content

Commit 42f845b

Browse files
Merge pull request #33638 from ajithkr-ms/sqlconnsummaryupdates
Improving the SQL Server Connections documentation
2 parents 2ae64c5 + b7ddafe commit 42f845b

File tree

4 files changed

+21
-7
lines changed

4 files changed

+21
-7
lines changed

docs/sql-server/azure-arc/includes/features-edition.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The following table identifies features available by [!INCLUDE [ssnoversion-md](
2525
| [Failover cluster instances](../support-for-fci.md) | Yes | Yes | Not applicable | Not applicable | Yes | Not applicable |
2626
| [Always On availability groups](../manage-availability-group.md) | Yes | Yes | Not applicable | Not applicable | Yes | Not applicable |
2727
| [Monitoring (preview)](../sql-monitoring.md) | Yes | Yes | No | No | No | No |
28+
| [Client connection summary (preview)](../sql-monitoring.md) | Yes | Yes | Yes | Yes | Yes | Yes |
2829
| [Operate with least privilege](../configure-least-privilege.md) | Yes | Yes | Yes | Yes | Yes | Yes |
2930

3031
<sup>1</sup> [Express LocalDB isn't supported.](/azure/purview/register-scan-on-premises-sql-server#supported-capabilities)

docs/sql-server/azure-arc/includes/features-operating-system.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The following table identifies features available by operating system:
2626
| [Failover cluster instances](../support-for-fci.md) | Yes | Not applicable |
2727
| [Always On availability groups (preview)](../manage-availability-group.md) | Yes | Not applicable |
2828
| [Monitoring (preview)](../sql-monitoring.md) | Yes | No |
29+
| [Client connection summary (preview)](../sql-monitoring.md) | Yes | No |
2930
| [Operate with least privilege](../configure-least-privilege.md)| Yes | No |
3031

3132
<sup>1</sup> [!INCLUDE [sssql22-md](../../../includes/sssql22-md.md)] only.

docs/sql-server/azure-arc/includes/features-version.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The following table identifies features available by SQL Server version:
2525
| [Failover cluster instances](../support-for-fci.md)| Yes | Yes | Yes | Yes | Yes | Yes |
2626
| [Always On availability groups (preview)](../manage-availability-group.md) | Yes | Yes | Yes | Yes | Yes | Yes |
2727
| [Monitoring (preview)](../sql-monitoring.md) | No | No | Yes <sup>2</sup> | Yes | Yes | Yes |
28+
| [Client connection summary (preview)](../sql-connection-summary.md) | No | No | Yes <sup>2</sup> | Yes | Yes | Yes |
2829
| [Operate with least privilege](../configure-least-privilege.md)| Yes | Yes | Yes | Yes | Yes | Yes |
2930

3031
<sup>1</sup> Requires subscription to [Extended Security Updates (ESU) enabled by Azure Arc](../../end-of-support/sql-server-extended-security-updates.md#subscribe-instances-for-esus).

docs/sql-server/azure-arc/sql-connection-summary.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: SQL Server Connection Summary
3-
description: Learn how you can see a summary of client connections made to an instance of SQL Server enabled by Azure Arc in the Azure portal by using the SQL Server Connections view.
3+
description: Learn how you can view client connections to an instance of SQL Server enabled by Azure Arc.
44
author: ajithkr-ms
55
ms.author: ajithkr
66
ms.reviewer: nhebbar, randolphwest
@@ -13,7 +13,7 @@ ms.custom:
1313

1414
[!INCLUDE [sqlserver](../../includes/applies-to-version/sqlserver.md)]
1515

16-
This article teaches you how to see a summary of client connections to [!INCLUDE [ssazurearc](../../includes/ssazurearc.md)] by using the SQL Server Connections view in the Azure portal.
16+
This article teaches you how to view client connections to [!INCLUDE [ssazurearc](../../includes/ssazurearc.md)] in Azure portal.
1717

1818
> [!NOTE]
1919
> The SQL Server Connections view in the Azure portal is currently in preview.
@@ -26,17 +26,28 @@ To view a summary of all client connections to the SQL Server instance, follow t
2626
1. Under **Monitoring**, select **SQL Server Connections**.
2727
1. (Optionally) Use the time range to view connections during a preferred window within the last 30 days.
2828

29-
Review the summarized data in the view:
30-
3129
:::image type="content" source="media/sql-connection-summary/sql-connection-summary.png" alt-text="Screenshot of the SQL Client Connections view for SQL Server enabled by Azure Arc." lightbox="media/sql-connection-summary/sql-connection-summary.png":::
3230

31+
### Review the summarized data in the view:
32+
33+
| Column name | Description and version-specific information |
34+
| --- | --- |
35+
| **Program Name** | Name of client program that initiated the session.|
36+
| **Client Interface Name** | Name of library/driver being used by the client to communicate with the server. |
37+
| **Database Name** | Name of the current database for the session in the hourly snapshots. |
38+
| **Request End Time** | Last request end time from the hourly snapshots. Indicator of how recently the client program connected used the database. |
39+
| **Total Writes** | Aggregated number of writes from the client program to the database as seen in the hourly snapshots. |
40+
| **Total Reads** | Aggregated number of reads from the client program to the database as seen in the hourly snapshots. |
41+
| **Elapsed Time** | Aggregated connection duration (in milliseconds) from the client program as seen in the hourly snapshots. |
42+
| **Count** | Count of unique sessions as seen in the hourly snapshots. The distinct sessions are identified using the login time. |
43+
3344
## How is the data collected?
3445

3546
By default, the SQL Server Connections view is available to all SQL Server instances enabled by Azure Arc. Data collection starts as soon as the instance is connected to Azure. Azure Connected Machine agent automatically polls [sys.dm_exec_sessions](../../relational-databases/system-dynamic-management-views/sys-dm-exec-sessions-transact-sql.md) hourly. The portal displays the data collection time. The service maintains the data for 30 days.
3647

3748
The connection data within the time range chosen on the portal dictates the client connection data summarized and presented as a table in the view.
3849

39-
## Disable connections view
50+
## Disable the connections view
4051

4152
Since the SQL Server connections view is enabled by default, you can choose to disable it and stop data collection. You can disable the SQL Server connections view by using the Azure portal, or the Azure CLI.
4253

@@ -60,9 +71,9 @@ az sql server-arc extension feature-flag set --name ClientConnections --enable f
6071
---
6172

6273

63-
## Enable connections view
74+
## Enable the connections view
6475

65-
If SQL Server Connections view and data collection has been disabled, you can enable it again by using the Azure portal, or the Azure CLI.
76+
If SQL Server Connections view and data collection is disabled, you can enable it again by using the Azure portal, or the Azure CLI.
6677

6778
### [Azure portal](#tab/azure-portal)
6879

0 commit comments

Comments
 (0)