Skip to content

Commit cbe4649

Browse files
committed
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 specific sections around enabling logs, metrics, (or WAF logs in the future).
1 parent 17c363e commit cbe4649

12 files changed

Lines changed: 30 additions & 30 deletions

File tree

content/includes/nginxaas-google/logging-config-access-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
f5-product: NGOOGL
33
f5-files:
4-
- content/nginxaas-google/monitoring/enable-nginx-logs.md
4+
- content/nginxaas-google/observability/enable-logs.md
55
---
66

77
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**.

content/includes/nginxaas-google/logging-config-error-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
f5-product: NGOOGL
33
f5-files:
4-
- content/nginxaas-google/monitoring/enable-nginx-logs.md
4+
- content/nginxaas-google/observability/enable-logs.md
55
---
66

77
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**.

content/nginxaas-google/getting-started/access-management.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,5 +113,5 @@ In the NGINXaaS Console,
113113

114114
## What's next
115115

116-
- [Monitor your deployment]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}})
117-
- [Enable NGINX Logs]({{< ref "/nginxaas-google/monitoring/enable-nginx-logs.md" >}})
116+
- [Monitor your deployment]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}})
117+
- [Enable NGINX Logs]({{< ref "/nginxaas-google/observability/enable-logs.md" >}})

content/nginxaas-google/getting-started/create-deployment/deploy-console.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Next, create a new NGINXaaS deployment using the NGINXaaS Console:
6464
- Select a **Configuration Version** from the list.
6565
- 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.
6666
- The network attachment ID is formatted like the following example: `projects/my-google-project/regions/us-east1/networkAttachments/my-network-attachment`.
67-
- Select **Managed Public Endpoint** or **Private Endpoint** under Service Frontend.
67+
- Select **Managed Public Endpoint** or **Private Endpoint** under Service Frontend.
6868
- Refer to the [Service Frontend]({{< ref "/nginxaas-google/overview.md#service-frontend" >}}) documentation for more information on these two frontend types.
6969
- Select **Submit** to begin the deployment process.
7070

@@ -79,15 +79,15 @@ In the NGINXaaS Console,
7979
1. To open the details of your deployment, select its name from the list of deployments.
8080
- You can view the details of your deployment, including the status, region, network attachment, NGINX configuration, and more.
8181
1. Select **Edit** to modify the deployment description, and NCU Capacity.
82-
- You can also configure monitoring from here. Detailed instructions can be found in [Enable Monitoring]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}})
82+
- You can also configure monitoring from here. Detailed instructions can be found in [Enable Monitoring]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}})
8383
1. Select **Update** to save your changes.
8484
1. Select the Configuration tab to view the current NGINX configuration associated with the deployment.
8585
1. Select **Update Configuration** to change the NGINX configuration associated with the deployment.
8686
1. To modify the contents of the NGINX configuration, see [Update an NGINX Configuration]({{< ref "/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md#update-an-nginx-configuration" >}}).
8787

8888
## Set up connectivity (Private Endpoint only)
8989

90-
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.**
90+
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.
9191

9292
### Internal traffic
9393

content/nginxaas-google/getting-started/nginx-configuration/nginx-configuration-console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ You can apply an NGINX configuration to your F5 NGINXaaS for Google Cloud (NGINX
3434
1. Confirm that you want to delete the configuration.
3535

3636
## What's next
37-
[Monitor your deployment]({{< ref "/nginxaas-google/monitoring/enable-monitoring.md" >}})
37+
[Monitor your deployment]({{< ref "/nginxaas-google/observability/enable-metrics.md" >}})

content/nginxaas-google/monitoring/_index.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Observability
3+
weight: 300
4+
url: /nginxaas/google/observability/
5+
---

content/nginxaas-google/monitoring/enable-nginx-logs.md renamed to content/nginxaas-google/observability/enable-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: Enable NGINX logs
2+
title: Enable Logs
33
weight: 350
44
toc: true
55
f5-docs: DOCS-000
6-
url: /nginxaas/google/monitoring/enable-nginx-logs/
6+
url: /nginxaas/google/observability/enable-logs/
77
f5-content-type: how-to
88
f5-product: NGOOGL
99
---

content/nginxaas-google/monitoring/enable-monitoring.md renamed to content/nginxaas-google/observability/enable-metrics.md

Lines changed: 5 additions & 5 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
f5-docs: DOCS-000
6-
url: /nginxaas/google/monitoring/enable-monitoring/
6+
url: /nginxaas/google/observability/enable-metrics/
77
f5-content-type: how-to
88
f5-product: NGOOGL
99
---
@@ -17,9 +17,9 @@ Monitoring your application's performance is crucial for maintaining its reliabi
1717
- Grant your principal access to one of the following IAM roles depending on your needs:
1818
- `roles/monitoring.viewer` — View metrics in Cloud Monitoring (read-only access)
1919
- `roles/monitoring.editor` — View metrics and create or import dashboards
20-
20+
2121
See [Google's documentation on controlling access to Cloud Monitoring with IAM](https://cloud.google.com/monitoring/access-control) for more information.
22-
- 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.
22+
- 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.
2323

2424
## Export NGINXaaS metrics to a Google Cloud Project
2525

@@ -32,7 +32,7 @@ To enable sending metrics to your desired Google Cloud project, you must specify
3232

3333
## View NGINXaaS metrics in Google Cloud Monitoring
3434

35-
See the [Metrics Catalog]({{< ref "/nginxaas-google/monitoring/metrics-catalog.md" >}}) for a full list of metrics NGINXaaS provides.
35+
See the [Metrics Catalog]({{< ref "/nginxaas-google/observability/metrics-catalog.md" >}}) for a full list of metrics NGINXaaS provides.
3636

3737
### Google Cloud Console's Metrics Explorer
3838

content/nginxaas-google/monitoring/metrics-catalog.md renamed to content/nginxaas-google/observability/metrics-catalog.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Metrics catalog
33
weight: 400
44
toc: false
55
f5-docs: DOCS-000
6-
url: /nginxaas/google/monitoring/metrics-catalog/
6+
url: /nginxaas/google/observability/metrics-catalog/
77
f5-content-type: reference
88
f5-product: NGOOGL
99
---
@@ -19,7 +19,7 @@ F5 NGINXaaS for Google Cloud (NGINXaaS) provides a rich set of metrics that you
1919
- [NGINX requests and response statistics](#nginx-requests-and-response-statistics)
2020
- [NGINX SSL statistics](#nginx-ssl-statistics)
2121
- [NGINX cache statistics](#nginx-cache-statistics)
22-
- [NGINX worker statistics](#nginx-worker-statistics)
22+
- [NGINX memory statistics](#nginx-memory-statistics)
2323
- [NGINX upstream statistics](#nginx-upstream-statistics)
2424
- [NGINX stream statistics](#nginx-stream-statistics)
2525

@@ -63,7 +63,7 @@ Example:
6363
server {
6464
listen 80;
6565
status_zone my_server_zone;
66-
66+
6767
location / {
6868
proxy_pass http://backend;
6969
}
@@ -119,7 +119,7 @@ Example:
119119
```nginx
120120
http {
121121
proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=my_cache:10m;
122-
122+
123123
server {
124124
location / {
125125
proxy_cache my_cache;
@@ -215,7 +215,7 @@ stream {
215215
status_zone tcp_server;
216216
proxy_pass backend_stream;
217217
}
218-
218+
219219
upstream backend_stream {
220220
zone stream_backend 64k;
221221
server 10.0.0.1:12345;

0 commit comments

Comments
 (0)