Skip to content

Commit 74a721e

Browse files
authored
chore: NGINXaaS: Update monitoring to metrics and prerequisites (#1543)
chore: Update monitoring which is a generic term to metrics and update the prereq to not require the Metrics Publisher role.
1 parent 68b3475 commit 74a721e

File tree

13 files changed

+17
-16
lines changed

13 files changed

+17
-16
lines changed

content/includes/nginxaas-azure/terraform-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ nd-files:
77
---
88

99
- [NGINXaaS Managed Identity Documentation]({{< ref "/nginxaas-azure/getting-started/managed-identity-portal.md" >}})
10-
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md" >}})
10+
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md" >}})

content/nginxaas-azure/changelog/archive/changelog-2023.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ To see a list of currently active issues, visit the [Known issues]({{< ref "/ngi
298298

299299
NGINXaaS, powered by [NGINX Plus](https://www.nginx.com/products/nginx/), is a fully managed service that removes the burden of deploying your own NGINX Plus cluster, installing libraries, upgrading, and managing it.
300300

301-
NGINXaaS simplifies the process of moving your [existing NGINX configuration]({{< ref "/nginxaas-azure/getting-started/nginx-configuration#add-nginx-configuration" >}}) to the Azure cloud. Once your configurations are moved to Azure, [securely manage SSL/TLS certificates and keys stored in Azure Key Vault and reference them within your NGINX configurations]({{< ref "/nginxaas-azure/getting-started/ssl-tls-certificates/ssl-tls-certificates-portal.md" >}}). You can [watch your application's traffic in real time]({{< ref "/nginxaas-azure/monitoring/enable-monitoring" >}}) with Azure monitoring and alerts, and scale your deployment to fit your needs, maximizing cost efficiency.
301+
NGINXaaS simplifies the process of moving your [existing NGINX configuration]({{< ref "/nginxaas-azure/getting-started/nginx-configuration#add-nginx-configuration" >}}) to the Azure cloud. Once your configurations are moved to Azure, [securely manage SSL/TLS certificates and keys stored in Azure Key Vault and reference them within your NGINX configurations]({{< ref "/nginxaas-azure/getting-started/ssl-tls-certificates/ssl-tls-certificates-portal.md" >}}). You can [watch your application's traffic in real time]({{< ref "/nginxaas-azure/monitoring/enable-metrics" >}}) with Azure monitoring and alerts, and scale your deployment to fit your needs, maximizing cost efficiency.
302302
You can create, update, and delete your NGINXaaS deployment using the [Azure Resource Manager]({{< ref "/nginxaas-azure/client-tools/templates.md" >}}), the [Azure SDK]({{< ref "/nginxaas-azure/client-tools/sdk" >}}), [CLI]({{< ref "/nginxaas-azure/getting-started/create-deployment/deploy-azure-cli.md" >}}), and [Terraform]({{< ref "/nginxaas-azure/getting-started/create-deployment/deploy-terraform.md" >}}) in addition to the [Azure portal]({{< ref "/nginxaas-azure/getting-started/create-deployment/" >}}).
303303

304304
Our new "Standard" plan is ready for production workloads.

content/nginxaas-azure/changelog/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ NGINXaaS now allows both precompiled and custom policies for F5 WAF for NGINX to
9898
9999
- {{% icon-feature %}} **Azure Monitor Platform Metrics**
100100
101-
NGINXaaS now publishes platform metrics directly to Azure Monitor. Compared to legacy monitoring based on custom metrics, platform metrics offers reduced latency and higher reliability. We strongly recommend migrating your alerts to use platform metrics for improved monitoring and management. For more details on enabling platform metrics, please refer to [Enable Monitoring]({{< relref "/nginxaas-azure/monitoring/enable-monitoring.md">}}).
101+
NGINXaaS now publishes platform metrics directly to Azure Monitor. Compared to legacy monitoring based on custom metrics, platform metrics offers reduced latency and higher reliability. We strongly recommend migrating your alerts to use platform metrics for improved monitoring and management. For more details on enabling platform metrics, please refer to [Enable Monitoring]({{< relref "/nginxaas-azure/monitoring/enable-metrics.md">}}).
102102
103103
## April 22, 2025
104104

content/nginxaas-azure/client-tools/sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For example scripts to create or update deployment resources, see [NGINXaaS Snip
3131
- [Azure SDK Deployment Create or Update Documentation](https://learn.microsoft.com/en-us/python/api/azure-mgmt-nginx/azure.mgmt.nginx.operations.deploymentsoperations?view=azure-python#azure-mgmt-nginx-operations-deploymentsoperations-begin-create-or-update)
3232
- [Azure SDK Deployment Delete Documentation](https://learn.microsoft.com/en-us/python/api/azure-mgmt-nginx/azure.mgmt.nginx.operations.deploymentsoperations?view=azure-python#azure-mgmt-nginx-operations-deploymentsoperations-begin-delete)
3333
- [NGINXaaS Managed Identity Documentation]({{< ref "/nginxaas-azure/getting-started/managed-identity-portal.md" >}})
34-
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-monitoring/" >}})
34+
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-metrics/" >}})
3535

3636
### Create or update a certificate
3737

content/nginxaas-azure/client-tools/templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ F5 NGINXaaS for Azure (NGINXaaS) deployments can be managed using the ARM API or
2626
See [NGINXaaS Snippets](https://github.com/nginxinc/nginxaas-for-azure-snippets/tree/main/arm-templates/deployments/create-or-update) for an example template to create or update deployment resources.
2727

2828
- [NGINXaaS Managed Identity Documentation]({{< ref "/nginxaas-azure/getting-started/managed-identity-portal.md" >}})
29-
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md" >}})
29+
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md" >}})
3030

3131
### Create or update a certificate
3232

content/nginxaas-azure/client-tools/terraform.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ F5 NGINXaaS for Azure (NGINXaaS) deployments can be managed using Terraform. Thi
2525
See [NGINXaaS Snippets](https://github.com/nginxinc/nginxaas-for-azure-snippets/tree/main/terraform/deployments/create-or-update) for an example to create or update deployment resources.
2626

2727
- [NGINXaaS Managed Identity Documentation]({{< ref "/nginxaas-azure/getting-started/managed-identity-portal.md" >}})
28-
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md" >}})
28+
- [NGINXaaS Azure Monitor Documentation]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md" >}})
2929

3030
### Create or update a certificate
3131

content/nginxaas-azure/getting-started/ssl-tls-certificates/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ For Azure client tools, such as the Azure CLI or Azure Resource Manager, the cer
6060

6161
## Monitor certificates
6262

63-
To view the status of your SSL/TLS certificates, [enable monitoring]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md" >}}) for your NGINXaaS deployment and navigate to the **Metrics** tab in the Azure portal. View the `nginxaas.certificates` metric under the `nginxaas statistics` metric namespace. The `nginxaas.certificates` metric allows you to filter by certificate name and the status of the certificate. The status dimension reports the health of your certificates through the following values:
63+
To view the status of your SSL/TLS certificates, [enable monitoring]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md" >}}) for your NGINXaaS deployment and navigate to the **Metrics** tab in the Azure portal. View the `nginxaas.certificates` metric under the `nginxaas statistics` metric namespace. The `nginxaas.certificates` metric allows you to filter by certificate name and the status of the certificate. The status dimension reports the health of your certificates through the following values:
6464

6565
{{< table >}}
6666

content/nginxaas-azure/monitoring/configure-alerts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This guide explains how to create and configure metrics-based alerts for your NG
2121

2222
- To complete this setup, you must be an owner or user access administrator for the NGINX deployment resource.
2323

24-
- To enable metrics, see [Enable Monitoring]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md" >}}).
24+
- To enable metrics, see [Enable Metrics]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md" >}}).
2525

2626
{{< call-out "note" >}} See [Azure monitor overview](https://docs.microsoft.com/en-us/azure/azure-monitor/overview) documentation to familiarize with Azure Monitor. {{< /call-out >}}
2727

content/nginxaas-azure/monitoring/enable-monitoring.md renamed to content/nginxaas-azure/monitoring/enable-metrics.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Enable monitoring
2+
title: Enable metrics
33
weight: 200
44
toc: true
55
nd-docs: DOCS-876
6-
url: /nginxaas/azure/monitoring/enable-monitoring/
6+
url: /nginxaas/azure/monitoring/enable-metrics/
77
type:
88
- how-to
99
---
@@ -14,9 +14,10 @@ Refer to the [Azure monitor overview](https://docs.microsoft.com/en-us/azure/azu
1414

1515
## Prerequisites
1616

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

19-
{{< call-out "note" >}} When a system assigned managed identity is added to the deployment through portal, this role is automatically added.{{< /call-out >}}
19+
{{< call-out "note" >}}The system-assigned managed identity does not need any role assignments to enable the metrics functionality described in this section.
20+
{{< /call-out >}}
2021

2122
## Collection
2223

content/nginxaas-azure/monitoring/migrate-to-platform-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ F5 NGINXaaS for Azure previously supported monitoring through [Custom Metrics](h
1515

1616
Follow the steps in this section to migrate your deployment monitoring from Custom metrics to Platform metrics.
1717

18-
1. Verify that your NGINXaaS deployment meets the [pre-requisites]({{< ref "/nginxaas-azure/monitoring/enable-monitoring.md#prerequisites">}}) for Platform metrics to work.
18+
1. Verify that your NGINXaaS deployment meets the [pre-requisites]({{< ref "/nginxaas-azure/monitoring/enable-metrics.md#prerequisites">}}) for Platform metrics to work.
1919
2. If the pre-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.
2020
3. **Migrate existing alert rules** to use Platform metrics instead of Custom metrics:
2121

0 commit comments

Comments
 (0)