Skip to content

Commit 360ac8e

Browse files
authored
Update azure-database-for-postgresql.md
1 parent c82adb9 commit 360ac8e

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

docs/integrations/microsoft-azure/azure-database-for-postgresql.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1010

1111
[Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/overview) is a fully managed relational database service in the Microsoft cloud based on the PostgreSQL community edition. This integration helps in monitoring resource utilization and identifying slow queries to optimize your workloads and configure your server for the best performance.
1212

13-
The below instructions applies to Azure Database for PostgreSQL with Flexible Server only.
13+
The instructions below apply to Azure Database for PostgreSQL with Flexible Server only.
1414

1515
## Log and metric types
1616

1717
For Azure Database for PostgreSQL, you can collect the following logs and metrics:
1818

1919
* **PostgreSQL Logs**. These logs can be used to identify, troubleshoot, and repair configuration errors and suboptimal performance. To learn more about the log format, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-logging#log-format).
20-
* **Activity logs**. Provides insight into any subscription-level or management group level events that have occurred in the Azure. To learn more, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).
20+
* **Activity logs**. Provides insight into any subscription-level or management group-level events that have occurred in Azure. To learn more, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/activity-log-schema).
2121
* **Metrics**. These metrics are available for a flexible server instance of Azure Database for PostgreSQL. For more information on supported metrics and instructions for enabling them, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-monitoring#metrics).
2222

2323
## Setup
@@ -28,7 +28,7 @@ Azure service sends monitoring data to Azure Monitor, which can then [stream dat
2828
* Logs collection from [Azure Monitor](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-monitoring#logs) using our [Azure Event Hubs source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
2929
* Metrics collection using our [HTTP Logs and Metrics source](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-monitoring#metrics) via Azure Functions deployed using the ARM template.
3030

31-
You must explicitly enable diagnostic settings for each Azure Database for PostgreSQL server you want to monitor. You can forward logs to the same event hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations).
31+
You must explicitly enable diagnostic settings for each Azure Database for the PostgreSQL server you want to monitor. You can forward logs to the same event hub provided they satisfy the limitations and permissions as described [here](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#destination-limitations).
3232

3333
When you configure the event hubs source or HTTP source, plan your source category to ease the querying process. A hierarchical approach allows you to make use of wildcards. For example: `Azure/DatabaseForPostgreSQL/Logs`, `Azure/DatabaseForPostgreSQL/Metrics`.
3434

@@ -38,13 +38,13 @@ When you configure the event hubs source or HTTP source, plan your source catego
3838
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
3939
2. Search for the following fields:
4040
- `tenant_name`. This field is tagged at the collector level. You can get the tenant name using the instructions in the [Microsoft Documentation](https://learn.microsoft.com/en-us/azure/active-directory-b2c/tenant-management-read-tenant-name#get-your-tenant-name).
41-
- `location`. The region to which the resource name belongs to.
41+
- `location`. The region to which the resource name belongs.
4242
- `subscription_id`. ID associated with a subscription where the resource is present.
4343
- `resource_group`. The resource group name where the Azure resource is present.
4444
- `provider_name`. Azure resource provider name (for example, Microsoft.Network).
4545
- `resource_type`. Azure resource type (for example, storage accounts).
4646
- `resource_name`. The name of the resource (for example, storage account name).
47-
- `service_type`. Type of the service that can be accessed with a Azure resource.
47+
- `service_type`. Type of the service that can be accessed with an Azure resource.
4848
- `service_name`. Services that can be accessed with an Azure resource (for example, Azure SQL databases in Azure SQL Server).
4949
3. Create the fields if they are not present. Refer to [Manage fields](/docs/manage/fields/#manage-fields).
5050

@@ -94,7 +94,7 @@ Create the following Field Extraction Rules (FER) for Azure Storage by following
9494

9595
Create the following metrics rules by following the instructions in [Create a metrics rule](/docs/metrics/metric-rules-editor/#create-a-metrics-rule).
9696

97-
#### Azure observability metadata extraction flexible postgresql server level
97+
#### Azure observability metadata extraction flexible PostgreSQL server level
9898

9999
```sql
100100
Rule Name: AzureObservabilityMetadataExtractionAzureDatabaseForPostgreSQLLevel
@@ -115,16 +115,16 @@ resourceId=/SUBSCRIPTIONS/*/RESOURCEGROUPS/*/PROVIDERS/MICROSOFT.DBFORPOSTGRESQL
115115
116116
### Configure metrics collection
117117
118-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
118+
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, onto an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
119119
120-
1. Create hosted collector and tag `tenant_name` field. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
120+
1. Create a hosted collector and tag the `tenant_name` field. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Tenant-Name.png')} alt="Azure Tag Tenant Name" style={{border: '1px solid gray'}} width="500" />
121121
2. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
122122
1. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
123-
1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Flexible PostgreSQL Server resource that you want to monitor.
124-
1. Choose `Stream to an event hub` as destination.
123+
1. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform the steps below for each Flexible PostgreSQL Server resource that you want to monitor.
124+
1. Choose `Stream to an event hub` as the destination.
125125
1. Select `AllMetrics`.
126-
1. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name. <br/><img src={useBaseUrl('img/send-data/azureflexible-postgresqlserver-metrics.png')} alt="Azure flexible postgresql server metrics" style={{border: '1px solid gray'}} width="800" />
127-
1. Tag the location field in the source with right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Database for PostgreSql Tag Location" style={{border: '1px solid gray'}} width="400" />
126+
1. Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by the ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name. <br/><img src={useBaseUrl('img/send-data/azureflexible-postgresqlserver-metrics.png')} alt="Azure flexible postgresql server metrics" style={{border: '1px solid gray'}} width="800" />
127+
1. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Database for PostgreSql Tag Location" style={{border: '1px solid gray'}} width="400" />
128128
129129
### Configure logs collection
130130
@@ -133,19 +133,19 @@ In this section, you will configure a pipeline for shipping metrics from Azure M
133133
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
134134
135135
1. To set up the Azure Event Hubs source in Sumo Logic, refer to the [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
136-
2. To create the diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the steps below for each Azure Redis cache account that you want to monitor.
136+
2. To create the diagnostic settings in the Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/data-factory/monitor-configure-diagnostics). Perform the steps below for each Azure Redis cache account that you want to monitor.
137137
1. Choose **Stream to an event hub** as the destination.
138138
1. Select `allLogs`.
139139
1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azureflexible-postgresqlserver-logs.png')} alt="Azure flexible postgresql server logs" style={{border: '1px solid gray'}} width="800" />
140-
3. Set server parameters as below:
140+
3. Set server parameters as given below:
141141
- `wal_level`. Set to **logical**.
142142
- `log_statement_stats`. Set to **ON**.
143143
- `log_statement`. Select **ALL**.
144144
- `log_lock_waits`. Set to **ON**. Set `deadlock_timeout`
145145
- `log_recovery_conflict_waits`. Set to **ON**.
146146
147147
148-
4. Tag the location field in the source with right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Redis Cache Tag Location" style={{border: '1px solid gray'}} width="400" />
148+
4. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Redis Cache Tag Location" style={{border: '1px solid gray'}} width="400" />
149149
150150
#### Activity logs
151151
@@ -155,15 +155,15 @@ To collect activity logs, follow the instructions [here](/docs/integrations/micr
155155
Since this source contains logs from multiple regions, ensure that you do not tag this source with the location tag.
156156
:::
157157
158-
## Installing the Azure Flexible Database for PostgreSql app
158+
## Installing the Azure Flexible Database for PostgreSQL app
159159
160160
Now that you have set up data collection, install the Azure Database for PostgreSQL Sumo Logic app to use the pre-configured dashboards that provide visibility into your environment for real-time analysis of overall usage.
161161
162162
import AppInstallNoDataSourceV2 from '../../reuse/apps/app-install-index-apps-v2.md';
163163
164164
<AppInstallNoDataSourceV2/>
165165
166-
## Viewing the Flexible Database for PostgreSql dashboards
166+
## Viewing the Flexible Database for PostgreSQL dashboards
167167
168168
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
169169
@@ -177,7 +177,7 @@ The **Azure Database for PostgreSQL - Disk** dashboard provides insights on Numb
177177
178178
### Administrative Operations
179179
180-
The **Azure Database for PostgreSQL - Administrative Operations** dashboard provides insights on Top 10 operations that caused the most errors, Distribution by Operation Type (Read, Write, and Delete), Distribution by Operations, Recent Write Operations, Recent Delete Operations, Users/Applications by Operation type, and Distribution by Status.
180+
The **Azure Database for PostgreSQL - Administrative Operations** dashboard provides insights on the top 10 operations that caused the most errors, Distribution by Operation Type (Read, Write, and Delete), Distribution by Operations, Recent Write Operations, Recent Delete Operations, Users/Applications by Operation type, and Distribution by Status.
181181
182182
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureDatabaseForPostgresql/Azure-Database-for-PostgreSQL-Administrative-Operations.png')} alt="Azure Database for PostgreSql - Administrative Operations" style={{border: '1px solid gray'}} width="800" />
183183
@@ -256,13 +256,13 @@ The **Azure Database for PostgreSQL - Transactions** dashboard provides insights
256256
257257
To troubleshoot metrics collection, follow the instructions in [Collect Metrics from Azure Monitor > Troubleshooting metrics collection](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#troubleshooting-metrics-collection).
258258
259-
## Upgrade/Downgrade the Azure Flexible Database for PostgreSql app (Optional)
259+
## Upgrade/Downgrade the Azure Flexible Database for PostgreSQL app (Optional)
260260
261261
import AppUpdate from '../../reuse/apps/app-update.md';
262262
263263
<AppUpdate/>
264264
265-
## Uninstalling the Azure Flexible Database for PostgreSql app (Optional)
265+
## Uninstalling the Azure Flexible Database for PostgreSQL app (Optional)
266266
267267
import AppUninstall from '../../reuse/apps/app-uninstall.md';
268268

0 commit comments

Comments
 (0)