Skip to content

NGINXaaS Platform metric migration #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/nginxaas-azure/monitoring/enable-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Monitoring your application's performance is crucial for maintaining its reliabi

Refer to the [Azure monitor overview](https://docs.microsoft.com/en-us/azure/azure-monitor/overview) documentation from Microsoft to learn more about Azure Monitor.

### Prerequisites
## Prerequisites

- A system assigned managed identity with `Monitoring Metrics Publisher` role.

Expand All @@ -25,7 +25,7 @@ Azure Monitor will collects metrics from the NGINXaaS deployment automatically i
## Exporting
You can export Azure Monitor metrics to other destinations like Log Analytics workspace, Azure Storage Account, Azure Event Hubs or Azure Monitor partner solutions using Diagnostic Setting. For more information, see the [Metrics diagnostic setting](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings).

To configure diagnostic settings for a service, see [Create diagnostic settings in Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/create-diagnostic-settings).
To configure diagnostic settings for a service, see [Create diagnostic settings in Azure Monitor](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/create-diagnostic-settings). You can export metrics by selecting the `AllMetrics` category in diagnostic settings.

{{<note>}} Not all metrics are exportable via diagnostic settings, for a list of exportable metrics, see [NGINXaaS exportable metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/nginx-nginxplus-nginxdeployments-metrics).{{</note>}}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Migrate from Custom Metrics to Platform Metrics
weight: 1000
toc: true
url: /nginxaas/azure/getting-started/migrate-to-platform-metrics/
type:
- how-to
---

## Overview
NGINXaaS previously supported monitoring using [Custom Metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/metrics-custom-overview). Custom metrics is a preview feature in Azure and support for it will be dropped in the future. We have added support for Platform metrics which is the Azure recommended way for monitoring resources, we strongly recommend you to migrate your deployments monitoring to use Platform metrics to take advantage of reduced latency and higher reliability.
Comment on lines +10 to +11
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Overview
NGINXaaS previously supported monitoring using [Custom Metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/metrics-custom-overview). Custom metrics is a preview feature in Azure and support for it will be dropped in the future. We have added support for Platform metrics which is the Azure recommended way for monitoring resources, we strongly recommend you to migrate your deployments monitoring to use Platform metrics to take advantage of reduced latency and higher reliability.
## Overview
NGINXaaS for Azure previously supported monitoring using [Custom Metrics](https://learn.microsoft.com/en-us/azure/azure-monitor/metrics/metrics-custom-overview). Custom metrics is a preview feature in Azure and support for it will be dropped in the future. We have added support for Platform metrics, which is the Azure recommended way for monitoring resources; we strongly recommend you migrate your deployments monitoring to use Platform metrics to take advantage of reduced latency and higher reliability.


## Migration Steps
This section contains instructions on how to migrate your deployment monitoring from Custom Metrics to Platform Metrics.

1. Verify that your NGINXaaS deployment meets the [pre-requisites]({{< relref "/nginxaas-azure/monitoring/enable-monitoring.md#prerequisites">}}) for Platform metrics to work.
2. If the per-requisites are met, Platform metrics are enabled by default on all NGINXaaS deployment. Verify that you are able to see the new metrics in Azure Monitor under the `Standard Metrics` namespace.
3. Turn off legacy monitoring.

- **Using Portal**
1. Go to the **NGINX monitoring** page of the NGINXaaS deployment in the Azure portal.
2. Toggle Off the `Send metrics to Azure Monitor` switch.
3. Click Save.

- **Using Terraform**
1. Set `diagnose_support_enabled` to false in the `azurerm_nginx_deployment` resource.
2. Run `terraform plan` followed by `terraform apply` to upgrade the deployment.

- **Using Azure CLI**
Run the command below:
```bash
az nginx deployment update --name myDeployment --resource-group \
myResourceGroup --enable-diagnostics="false"
```
Loading