Merge pull request #207009 from SudheeshGH/ServerLogs

Server Logs Documentation - New Feature

Author: PMEds28

articles/mysql/TOC.yml

@@ -210,6 +210,12 @@
         href: flexible-server/tutorial-configure-audit.md
       - name: Alerts
         href: flexible-server/how-to-alert-on-metric.md  
+      - name: Configuring Server logs
+        items:
+        - name: Azure portal
+          href: flexible-server/how-to-server-logs-portal.md
+        - name: Azure CLI
+          href: flexible-server/how-to-server-logs-cli.md
     - name: Replication
       items:
       - name: Configure data-in replication

articles/mysql/flexible-server/concepts-monitoring.md

@@ -9,24 +9,27 @@ ms.author: sisawant
 ms.date: 9/21/2020
 ---
 
-# Monitor Azure Database for MySQL Flexible Servers with built-in metrics
+# Monitor Azure Database for MySQL Flexible Server
 
 [!INCLUDE[applies-to-mysql-flexible-server](../includes/applies-to-mysql-flexible-server.md)]
 
-Azure Database for MySQL Flexible Server provides monitoring of servers through Azure Monitor. Metrics are numerical values that describe some aspect of the resources of your server at a particular time. Monitoring your server's resources helps you troubleshoot and optimize your workload by allowing you to monitor what matters the most to you. Monitoring the right metrics helps you keep the performance, reliability, and availability of your server and applications.
+Azure Database for MySQL Flexible Server provides monitoring of servers through Azure Monitor. Monitoring data about your servers helps you troubleshoot and optimize for your workload.
 
-In this article, you will learn about the various metrics available for your flexible server that give insight into the behavior of your server.
+In this article, you'll learn about the various metrics available and Server logs for your flexible server that give insight into the behavior of your server.
 
 > [!NOTE]
 > This article contains references to the term *slave*, a term that Microsoft no longer uses. When the term is removed from the software, we'll remove it from this article.
 
-## Available metrics
+## Metrics
 
-Azure Database for MySQL Flexible Server provides various metrics to understand how your workload is performing and based on this data, you can understand the impact on your server and application. For example, in flexible server, you can monitor **Host CPU percent**, **Active Connections**, **IO percent**, and **Host Memory Percent** to identify when there is a performance impact. From there, you may have to optimize your workload, scale vertically by changing compute tiers, or scaling horizontally by using read replica.
+Metrics are numerical values that describe some aspect of the resources of your server at a particular time. Monitoring your server's resources helps you troubleshoot and optimize your workload by allowing you to monitor what matters the most to you. Monitoring the right metrics helps you keep the performance, reliability, and availability of your server and applications.
+
+Azure Database for MySQL Flexible Server provides various metrics to understand how your workload is performing and based on this data, you can understand the impact on your server and application.
 
 All Azure metrics have a one-minute frequency, and each metric provides 30 days of history. You can configure alerts on the metrics. For step-by-step guidance, see [How to set up alerts](./how-to-alert-on-metric.md). Other tasks include setting up automated actions, performing advanced analytics, and archiving history. For more information, see the [Azure Metrics Overview](../../azure-monitor/data-platform.md).
 
-### List of metrics
+
+## List of metrics
 These metrics are available for Azure Database for MySQL:
 
 |Metric display name|Metric|Unit|Description|
@@ -46,6 +49,22 @@ These metrics are available for Azure Database for MySQL:
 |Aborted Connections|aborted_connections|Count|Total number of failed attempts to connect to your MySQL server, for example, failed connection due to bad credentials. For more information on aborted connections, you can refer to this [documentation](https://dev.mysql.com/doc/refman/5.7/en/communication-errors.html).|
 |Queries|queries|Count|Total number of queries executed per minute on your server. Total count of queries per minute on your server from your database workload and Azure MySQL processes.|
 
+
+## Server logs
+
+In Azure Database for MySQL Server – Flexible Server, users can configure and download server logs to assist with troubleshooting efforts. With this feature enabled, a flexible server starts capturing events of the selected log type and writes them to a file. You can then use the Azure portal and Azure CLI to download the files to work with them.
+The server logs feature is disabled by default. For information about how to enable server logs, see [How to enable and download server logs for Azure Database for MySQL - Flexible Server](./how-to-server-logs-portal.md)
+
+To perform a historical analysis of your data, in the Azure portal, on the Diagnostics settings pane for your server, add a diagnostic setting to send the logs to Log Analytics workspace, Azure Storage, or event hubs. For more information, see [Set up diagnostics](./tutorial-query-performance-insights.md#set-up-diagnostics).
+
+**Server logs retention**
+
+When logging is enabled for an Azure Database for MySQL flexible server, logs are available up to seven days from their creation.
+If the total size of the available logs exceeds 7 GB, then the oldest files are deleted until space is available.
+The 7-GB storage limit for server logs is available free of cost and can't be extended.
+Logs are rotated every 24 hours or 7 GB, whichever comes first.
+
+
 ## Next steps
 - See [How to set up alerts](./how-to-alert-on-metric.md) for guidance on creating an alert on a metric.
-- Learn more about [scaling IOPS](./concepts/../concepts-compute-storage.md#iops) to improve performance.
+- How to enable and download server logs for Azure Database for MySQL - Flexible Server from [Azure portal](./how-to-server-logs-portal.md) or [Azure CLI](./how-to-server-logs-cli.md)

articles/mysql/flexible-server/how-to-server-logs-cli.md

@@ -0,0 +1,70 @@
+---
+title: 'Monitoring - List and Download Server logs using Azure CLI'
+description: This article describes how to download and list server logs using Azure CLI.
+ms.service: mysql
+ms.subservice: flexible-server
+ms.topic: conceptual
+author: code-sidd
+ms.author: sisawant
+ms.date: 08/05/2022
+---
+# List and Download Server logs using Azure CLI
+
+[[!INCLUDE[applies-to-mysql-flexible-server](../includes/applies-to-mysql-flexible-server.md)]
+
+This article shows you how to list and download server flexible server using Azure CLI.
+
+## Prerequisites
+
+This article requires that you're running the Azure CLI version 2.39.0 or later locally. To see the version installed, run the `az --version` command. If you need to install or upgrade, see [Install Azure CLI](/cli/azure/install-azure-cli).
+
+You'll need to sign-in to your account using the [az sign-in](/cli/azure/reference-index#az-login) command. Note the **id** property, which refers to **Subscription ID** for your Azure account.
+
+```azurecli-interactive
+az login
+```
+
+Select the specific subscription under your account using [az account set](/cli/azure/account) command. Make a note of the **id** value from the **az login** output to use as the value for **subscription** argument in the command. If you have multiple subscriptions, choose the appropriate subscription in which the resource should be billed. To get all your subscription, use [az account list](/cli/azure/account#az-account-list).
+
+```azurecli
+az account set --subscription <subscription id>
+```
+
+## List Server logs using Azure CLI
+
+Once you're configured the prerequisites and connected to your required subscription.
+You can list the server logs from your flexible server by below command.
+
+
+```azurecli
+az mysql flexible-server server-logs list --resource-group <myresourcegroup> --server-name <serverlogdemo> --out <table>
+```
+
+Here are the details for the above command
+
+LastModifiedTime | Name  | ResourceGroup | SizeInKb  | TypePropertiesType  | Url
+---|---|---|---|---|---|
+2022-08-01T11:09:48+00:00 | mysql-slow-serverlogdemo-2022073111.log  | myresourcegroup | 10947 | slowlog | https://00000000000.file.core.windows.net/0000000serverlog/slowlogs/mysql-slow-serverlogdemo-2022073111.log?
+2022-08-02T11:10:00+00:00 | mysql-slow-serverlogdemo-2022080111.log  | myresourcegroup | 10927 | slowlog | https://00000000000.file.core.windows.net/0000000serverlog/slowlogs/mysql-slow-serverlogdemo-2022080111.log?
+2022-08-03T11:10:12+00:00   | mysql-slow-serverlogdemo-2022080211.log  | myresourcegroup | 10936 | slowlog | https://00000000000.file.core.windows.net/0000000serverlog/slowlogs/mysql-slow-serverlogdemo-2022080211.log?
+2022-08-03T11:12:00+00:00 | mysql-slow-serverlogdemo-2022080311.log  | myresourcegroup | 8920 | slowlog | https://00000000000.file.core.windows.net/0000000serverlog/slowlogs/mysql-slow-serverlogdemo-2022080311.log?
+
+
+Above list shows LastModifiedTime, Name, ResourceGroup, SizeInKb and Download Url of the Server Logs available.
+Default LastModifiedTime is set to 72 hours, for listing files older than 72 hours, use flag `--file-last-written <Time:HH>`
+
+```azurecli
+az mysql flexible-server server-logs list --resource-group <myresourcegroup>  --server-name <serverlogdemo> --out table --file-last-written <144>
+```
+
+## Downloading Server logs using Azure CLI
+
+Below command will download the mentioned server logs to your current directory.
+
+```azurecli
+az mysql flexible-server server-logs download --resource-group <myresourcegroup> --server-name <serverlogdemo>  --name <mysql-slow-serverlogdemo-2022073111.log>
+```
+
+## Next Steps
+- To enable and disable Server logs from portal, you can refer to the [article].(./how-to-server-logs-portal.md)
+- Learn more about [Configure slow logs using Azure CLI](./tutorial-query-performance-insights.md#configure-slow-query-logs-by-using-the-azure-cli)

articles/mysql/flexible-server/how-to-server-logs-portal.md

@@ -0,0 +1,87 @@
+---
+title: 'How to enable and download server logs for Azure Database for MySQL - Flexible Server'
+description: This article describes how to download and list server logs using Azure portal.
+ms.service: mysql
+ms.subservice: flexible-server
+ms.topic: conceptual
+author: code-sidd
+ms.author: sisawant
+ms.date: 08/05/2022
+---
+# Enable, list and download server logs for Azure Database for MySQL - Flexible Server
+
+[!INCLUDE[applies-to-mysql-flexible-server](../includes/applies-to-mysql-flexible-server.md)]
+
+You can use server logs to help monitor and troubleshoot an instance of Azure Database for MySQL - Flexible Server, and to gain detailed insights into the activities that have run on your servers.
+By default, the server logs feature in Azure Database for MySQL - Flexible Server is disabled. However, after you enable the feature, a flexible server starts capturing events of the selected log type and writes them to a file. You can then use the Azure portal or the Azure CLI to download the files to assist with your troubleshooting efforts.
+This article explains how to enable the server logs feature in Azure Database for MySQL - Flexible Server and download server log files. It also provides information about how to disable the feature.
+
+In this tutorial, you’ll learn how to:
+- Enable the server logs feature.
+- Disable the server logs feature.
+- Download server log files.
+
+## Prerequisites
+
+To complete this tutorial, you need an existing Azure Database for MySQL flexible server. If you need to create a new server, see [Create an Azure Database for MySQL flexible server](./quickstart-create-server-portal.md).
+
+## Enable Server logs
+
+To enable the server logs feature, perform the following steps.
+
+1. In the [Azure portal](https://portal.azure.com), select your MySQL flexible server.
+
+2. On the left pane, under **Monitoring**, select **Server logs**.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/1-how-to-serverlog.png" alt-text="Screenshot showing Azure Database for My SQL - Server Logs.":::
+
+3. To enable server logs, under **Server logs**, select **Enable**.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/2-how-to-serverlog.png" alt-text="Screenshot showing Enable Server Logs.":::
+
+>[!Note]
+> You can also enable server logs in the Azure portal, on the [Server parameters](./how-to-configure-server-parameters-portal.md) pane for your server, by setting the value of the log_output parameter to FILE.
+> For more information on the log_output parameter, in the MySQL documentation, see topic Server System Variables ([version 5.7](https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_log_output) or [version 8.0](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_log_output)).
+
+4. To enable the slow_query_log log, under **Select logs to enable**, select **slow_query_log**.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/3-how-to-serverlog.png" alt-text="Screenshot showing select slow log - Server Logs.":::
+
+To configure slow_logs on your Azure Database for MySQL flexible server, see [Query Performance Insight.](./tutorial-query-performance-insights.md)
+
+
+## Download Server logs
+
+To download server logs, perform the following steps.
+> [!Note]
+> After enabling logs, the log files will be available to download after few minutes.
+
+1. Under **Name**, select the log file you want to download, and then, under **Action**, select **Download**.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/4-how-to-serverlog.png" alt-text="Screenshot showing Server Logs - Download.":::
+
+    For HA enabled Azure database for MySQL Flexible server, server logs for standby server can be identified by another four-letter identifier after the hostname of the server as shown below.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/5-how-to-serverlog.png" alt-text="Screenshot showing server Logs - HA logs.":::
+
+2. To download multiple log files at one time, under **Name**, select the files you want to download, and then above **Name**, select **Download**.
+
+    :::image type="content" source="./media/how-to-server-logs-portal/6-how-to-serverlog.png" alt-text="Screenshot showing server Logs - Download all.":::
+
+
+## Disable Server Logs
+
+1. From your Azure portal, select Server logs from Monitoring server pane.
+
+2. For disabling Server logs to file, Uncheck Enable. (The setting will disable logging for all the log_types available)
+
+    :::image type="content" source="./media/how-to-server-logs-portal/7-how-to-serverlog.png" alt-text="Screenshot showing server Logs - Disable.":::
+
+3. Select Save
+
+    :::image type="content" source="./media/how-to-server-logs-portal/8-how-to-serverlog.png" alt-text="Screenshot showing server Logs - Save.":::
+
+
+## Next steps
+- Learn more about [How to enable slow query logs](./tutorial-query-performance-insights.md#configure-slow-query-logs-by-using-the-azure-portal)
+- List and download [Server logs using Azure CLI](./how-to-server-logs-cli.md)