From ca3b4fa94b4965854191248ba4d37bedb297360a Mon Sep 17 00:00:00 2001 From: sarna Date: Tue, 5 May 2026 18:17:41 -0700 Subject: [PATCH] Change monitoring->observability A lot of our metrics-related docs are labeled as "monitoring" which is a bit misleading even though that's what Google calls it. IMHO "observability" is a good overall name to indicate how a user can observe their deployment generally, and we can have specific sections around enabling logs, metrics, (or WAF logs in the future). --- .../nginxaas-google/logging-config-access-logs.md | 2 +- .../nginxaas-google/logging-config-error-logs.md | 2 +- .../getting-started/access-management.md | 4 ++-- .../create-deployment/deploy-console.md | 6 +++--- .../nginx-configuration/nginx-configuration-console.md | 2 +- content/nginxaas-google/monitoring/_index.md | 5 ----- content/nginxaas-google/observability/_index.md | 5 +++++ .../enable-logs.md} | 4 ++-- .../enable-metrics.md} | 10 +++++----- .../{monitoring => observability}/metrics-catalog.md | 10 +++++----- content/nginxaas-google/overview.md | 2 +- static/llms-full.txt | 8 ++++---- 12 files changed, 30 insertions(+), 30 deletions(-) delete mode 100644 content/nginxaas-google/monitoring/_index.md create mode 100644 content/nginxaas-google/observability/_index.md rename content/nginxaas-google/{monitoring/enable-nginx-logs.md => observability/enable-logs.md} (97%) rename content/nginxaas-google/{monitoring/enable-monitoring.md => observability/enable-metrics.md} (98%) rename content/nginxaas-google/{monitoring => observability}/metrics-catalog.md (99%) diff --git a/content/includes/nginxaas-google/logging-config-access-logs.md b/content/includes/nginxaas-google/logging-config-access-logs.md index 3891ffea2f..992d685ebd 100644 --- a/content/includes/nginxaas-google/logging-config-access-logs.md +++ b/content/includes/nginxaas-google/logging-config-access-logs.md @@ -1,7 +1,7 @@ --- f5-product: NGOOGL f5-files: -- content/nginxaas-google/monitoring/enable-nginx-logs.md +- content/nginxaas-google/observability/enable-logs.md --- NGINX access logs are disabled by default. You can enable access logs by adding **access_log** directives to your NGINX configuration to specify the location of the logs and formats. The log path should always be configured to be inside **/var/log/nginx**. diff --git a/content/includes/nginxaas-google/logging-config-error-logs.md b/content/includes/nginxaas-google/logging-config-error-logs.md index 2a61d10477..56266eff89 100644 --- a/content/includes/nginxaas-google/logging-config-error-logs.md +++ b/content/includes/nginxaas-google/logging-config-error-logs.md @@ -1,7 +1,7 @@ --- f5-product: NGOOGL f5-files: -- content/nginxaas-google/monitoring/enable-nginx-logs.md +- content/nginxaas-google/observability/enable-logs.md --- NGINX error logs are disabled by default. You can enable error logs by adding **error_log** directives to your NGINX configuration to specify the location of the logs and formats. The log path should always be configured to be inside **/var/log/nginx**. diff --git a/content/nginxaas-google/getting-started/access-management.md b/content/nginxaas-google/getting-started/access-management.md index aac7b11a95..2b0cf1d182 100644 --- a/content/nginxaas-google/getting-started/access-management.md +++ b/content/nginxaas-google/getting-started/access-management.md @@ -113,5 +113,5 @@ In the NGINXaaS Console, ## What's next -- [Monitor your deployment]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}}) -- [Enable NGINX Logs]({{< ref "/nginxaas-google/monitoring/enable-nginx-logs.md" >}}) +- [Monitor your deployment]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}}) +- [Enable NGINX Logs]({{< ref "/nginxaas-google/observability/enable-logs.md" >}}) diff --git a/content/nginxaas-google/getting-started/create-deployment/deploy-console.md b/content/nginxaas-google/getting-started/create-deployment/deploy-console.md index 27032206e6..b269ff6572 100644 --- a/content/nginxaas-google/getting-started/create-deployment/deploy-console.md +++ b/content/nginxaas-google/getting-started/create-deployment/deploy-console.md @@ -64,7 +64,7 @@ Next, create a new NGINXaaS deployment using the NGINXaaS Console: - Select a **Configuration Version** from the list. - In the Cloud Details section, enter the network attachment ID that [you created earlier](#create-a-network-attachment) or select it in the **Network attachment** list. - The network attachment ID is formatted like the following example: `projects/my-google-project/regions/us-east1/networkAttachments/my-network-attachment`. - - Select **Managed Public Endpoint** or **Private Endpoint** under Service Frontend. + - Select **Managed Public Endpoint** or **Private Endpoint** under Service Frontend. - Refer to the [Service Frontend]({{< ref "/nginxaas-google/overview.md#service-frontend" >}}) documentation for more information on these two frontend types. - Select **Submit** to begin the deployment process. @@ -79,7 +79,7 @@ In the NGINXaaS Console, 1. To open the details of your deployment, select its name from the list of deployments. - You can view the details of your deployment, including the status, region, network attachment, NGINX configuration, and more. 1. Select **Edit** to modify the deployment description, and NCU Capacity. - - You can also configure monitoring from here. Detailed instructions can be found in [Enable Monitoring]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}}) + - You can also configure monitoring from here. Detailed instructions can be found in [Enable Monitoring]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}}) 1. Select **Update** to save your changes. 1. Select the Configuration tab to view the current NGINX configuration associated with the deployment. 1. Select **Update Configuration** to change the NGINX configuration associated with the deployment. @@ -87,7 +87,7 @@ In the NGINXaaS Console, ## Set up connectivity (Private Endpoint only) -If you selected **Private Endpoint** as the service frontend type, complete the following steps to allow client access. If you selected **Managed Public Endpoint**, skip this section.** +If you selected service frontend of type **Managed Public Endpoint**, skip this section.** If you selected **Private Endpoint** as the service frontend type, complete the following steps to allow client access. ### Internal traffic diff --git a/content/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md b/content/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md index 262a163e2c..d53c4e6545 100644 --- a/content/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md +++ b/content/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md @@ -34,4 +34,4 @@ You can apply an NGINX configuration to your F5 NGINXaaS for Google Cloud (NGINX 1. Confirm that you want to delete the configuration. ## What's next -[Monitor your deployment]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}}) \ No newline at end of file +[Monitor your deployment]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}}) diff --git a/content/nginxaas-google/monitoring/_index.md b/content/nginxaas-google/monitoring/_index.md deleted file mode 100644 index b42e915b49..0000000000 --- a/content/nginxaas-google/monitoring/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Logging and monitoring -weight: 300 -url: /nginxaas/google/monitoring/ ---- diff --git a/content/nginxaas-google/observability/_index.md b/content/nginxaas-google/observability/_index.md new file mode 100644 index 0000000000..2f09142570 --- /dev/null +++ b/content/nginxaas-google/observability/_index.md @@ -0,0 +1,5 @@ +--- +title: Observability +weight: 300 +url: /nginxaas/google/observability/ +--- diff --git a/content/nginxaas-google/monitoring/enable-nginx-logs.md b/content/nginxaas-google/observability/enable-logs.md similarity index 97% rename from content/nginxaas-google/monitoring/enable-nginx-logs.md rename to content/nginxaas-google/observability/enable-logs.md index 618f9ff372..9f8ac98f2c 100644 --- a/content/nginxaas-google/monitoring/enable-nginx-logs.md +++ b/content/nginxaas-google/observability/enable-logs.md @@ -1,9 +1,9 @@ --- -title: Enable NGINX logs +title: Enable Logs weight: 350 toc: true f5-docs: DOCS-000 -url: /nginxaas/google/monitoring/enable-nginx-logs/ +url: /nginxaas/google/observability/enable-logs/ f5-content-type: how-to f5-product: NGOOGL --- diff --git a/content/nginxaas-google/monitoring/enable-monitoring.md b/content/nginxaas-google/observability/enable-metrics.md similarity index 98% rename from content/nginxaas-google/monitoring/enable-monitoring.md rename to content/nginxaas-google/observability/enable-metrics.md index e4e542af94..4d36cbf74b 100644 --- a/content/nginxaas-google/monitoring/enable-monitoring.md +++ b/content/nginxaas-google/observability/enable-metrics.md @@ -1,9 +1,9 @@ --- -title: Enable monitoring +title: Enable Metrics weight: 200 toc: true f5-docs: DOCS-000 -url: /nginxaas/google/monitoring/enable-monitoring/ +url: /nginxaas/google/observability/enable-metrics/ f5-content-type: how-to f5-product: NGOOGL --- @@ -17,9 +17,9 @@ Monitoring your application's performance is crucial for maintaining its reliabi - Grant your principal access to one of the following IAM roles depending on your needs: - `roles/monitoring.viewer` — View metrics in Cloud Monitoring (read-only access) - `roles/monitoring.editor` — View metrics and create or import dashboards - + See [Google's documentation on controlling access to Cloud Monitoring with IAM](https://cloud.google.com/monitoring/access-control) for more information. -- Configure the [`status_zone`](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone) directive in your `server` blocks and the [`zone`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone) directive in your `upstream` blocks to collect HTTP request and response statistics, stream connection metrics, upstream statistics, and memory statistics. See the [Metrics Catalog]({{< ref "/nginxaas-google/monitoring/metrics-catalog.md" >}}) for configuration requirements. +- Configure the [`status_zone`](https://nginx.org/en/docs/http/ngx_http_status_module.html#status_zone) directive in your `server` blocks and the [`zone`](https://nginx.org/en/docs/http/ngx_http_upstream_module.html#zone) directive in your `upstream` blocks to collect HTTP request and response statistics, stream connection metrics, upstream statistics, and memory statistics. See the [Metrics Catalog]({{< ref "/nginxaas-google/observability/metrics-catalog.md" >}}) for configuration requirements. ## Export NGINXaaS metrics to a Google Cloud Project @@ -32,7 +32,7 @@ To enable sending metrics to your desired Google Cloud project, you must specify ## View NGINXaaS metrics in Google Cloud Monitoring -See the [Metrics Catalog]({{< ref "/nginxaas-google/monitoring/metrics-catalog.md" >}}) for a full list of metrics NGINXaaS provides. +See the [Metrics Catalog]({{< ref "/nginxaas-google/observability/metrics-catalog.md" >}}) for a full list of metrics NGINXaaS provides. ### Google Cloud Console's Metrics Explorer diff --git a/content/nginxaas-google/monitoring/metrics-catalog.md b/content/nginxaas-google/observability/metrics-catalog.md similarity index 99% rename from content/nginxaas-google/monitoring/metrics-catalog.md rename to content/nginxaas-google/observability/metrics-catalog.md index d122e85717..73a4c467d1 100644 --- a/content/nginxaas-google/monitoring/metrics-catalog.md +++ b/content/nginxaas-google/observability/metrics-catalog.md @@ -3,7 +3,7 @@ title: Metrics catalog weight: 400 toc: false f5-docs: DOCS-000 -url: /nginxaas/google/monitoring/metrics-catalog/ +url: /nginxaas/google/observability/metrics-catalog/ f5-content-type: reference f5-product: NGOOGL --- @@ -19,7 +19,7 @@ F5 NGINXaaS for Google Cloud (NGINXaaS) provides a rich set of metrics that you - [NGINX requests and response statistics](#nginx-requests-and-response-statistics) - [NGINX SSL statistics](#nginx-ssl-statistics) - [NGINX cache statistics](#nginx-cache-statistics) - - [NGINX worker statistics](#nginx-worker-statistics) + - [NGINX memory statistics](#nginx-memory-statistics) - [NGINX upstream statistics](#nginx-upstream-statistics) - [NGINX stream statistics](#nginx-stream-statistics) @@ -63,7 +63,7 @@ Example: server { listen 80; status_zone my_server_zone; - + location / { proxy_pass http://backend; } @@ -119,7 +119,7 @@ Example: ```nginx http { proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=my_cache:10m; - + server { location / { proxy_cache my_cache; @@ -215,7 +215,7 @@ stream { status_zone tcp_server; proxy_pass backend_stream; } - + upstream backend_stream { zone stream_backend 64k; server 10.0.0.1:12345; diff --git a/content/nginxaas-google/overview.md b/content/nginxaas-google/overview.md index d49620dc7f..b331b29484 100644 --- a/content/nginxaas-google/overview.md +++ b/content/nginxaas-google/overview.md @@ -40,7 +40,7 @@ The key capabilities of NGINXaaS for Google Cloud are: ### Service Frontend -The service frontend of an NGINXaaS deployment controls how client ingress traffic reaches your deployment. There are two frontend types: managed public endpoint and private endpoint. +The service frontend of an NGINXaaS deployment controls how client ingress traffic reaches your deployment. There are two frontend types: **Managed Public Endpoint** and **Private Endpoint**. #### Managed Public Endpoint diff --git a/static/llms-full.txt b/static/llms-full.txt index 58fca16f43..6880e0628d 100644 --- a/static/llms-full.txt +++ b/static/llms-full.txt @@ -1435,16 +1435,16 @@ - [Known issues](https://docs.nginx.com/nginxaas/google/known-issues/) ## Monitoring -- [Logging and monitoring](https://docs.nginx.com/nginxaas/google/monitoring/) +- [Logging and monitoring](https://docs.nginx.com/nginxaas/google/observability/) ### Enable Monitoring -- [Enable monitoring](https://docs.nginx.com/nginxaas/google/monitoring/enable-monitoring/) +- [Enable monitoring](https://docs.nginx.com/nginxaas/google/observability/enable-metrics/) ### Enable Nginx Logs -- [Enable NGINX logs](https://docs.nginx.com/nginxaas/google/monitoring/enable-nginx-logs/) +- [Enable NGINX logs](https://docs.nginx.com/nginxaas/google/observability/enable-logs/) ### Metrics Catalog -- [Metrics catalog](https://docs.nginx.com/nginxaas/google/monitoring/metrics-catalog/) +- [Metrics catalog](https://docs.nginx.com/nginxaas/google/observability/metrics-catalog/) ## Overview - [Overview and architecture](https://docs.nginx.com/nginxaas/google/overview/)