Skip to content

Commit 84ed63e

Browse files
authored
docs: remove filtered metrics from GCP catalog (#261)
1 parent ab6db7a commit 84ed63e

File tree

2 files changed

+5
-94
lines changed

2 files changed

+5
-94
lines changed

content/nginxaas-google/monitoring/enable-monitoring.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ Refer to the [Google's Metrics Explorer](https://cloud.google.com/monitoring/cha
4343

4444
You can retrieve raw time series metrics from the [Cloud Monitoring API](https://cloud.google.com/monitoring/api/v3).
4545

46-
For example, you can use [`projects.timeSeries.list`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) to list metrics matching filters from a specified time interval. The following `curl` command lists `nginxaas.ncus.provisioned` metrics from the time interval `start_time` to `end_time` in the given `project_id`.
46+
For example, you can use [`projects.timeSeries.list`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) to list metrics matching filters from a specified time interval. The following `curl` command lists `nginx.http.requests` metrics from the time interval `start_time` to `end_time` in the given `project_id`.
4747

4848
```bash
4949
curl \
50-
"https://monitoring.googleapis.com/v3/projects/{project_id}/timeSeries?filter=metric.type%3D%22workload.googleapis.com%2Fnginxaas.ncus.provisioned%22&interval.endTime={end_time}&interval.startTime={start_time}" \
50+
"https://monitoring.googleapis.com/v3/projects/{project_id}/timeSeries?filter=metric.type%3D%22workload.googleapis.com%2Fnginx.http.requests%22&interval.endTime={end_time}&interval.startTime={start_time}" \
5151
--header "Authorization: Bearer $(gcloud auth print-access-token)" \
5252
--header "Accept: application/json" \
5353
--compressed
@@ -71,7 +71,7 @@ The following JSON shows an example response body:
7171
"nginxaas_deployment_name": "test-deployment",
7272
"nginxaas_namespace": "default"
7373
},
74-
"type": "workload.googleapis.com/nginxaas.ncus.provisioned"
74+
"type": "workload.googleapis.com/nginx.http.requests"
7575
},
7676
"resource": {
7777
"type": "generic_node",
@@ -82,7 +82,7 @@ The following JSON shows an example response body:
8282
"project_id": "{project_id}"
8383
}
8484
},
85-
"metricKind": "GAUGE",
85+
"metricKind": "CUMULATIVE",
8686
"valueType": "INT64",
8787
"points": [
8888
{
@@ -91,7 +91,7 @@ The following JSON shows an example response body:
9191
"endTime": "{end_time}"
9292
},
9393
"value": {
94-
"int64Value": "10"
94+
"int64Value": "1405"
9595
}
9696
}
9797
]

content/nginxaas-google/monitoring/metrics-catalog.md

Lines changed: 0 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ F5 NGINXaaS for Google Cloud (NGINXaaS) provides a rich set of metrics that you
1414

1515
- [Available metrics](#available-metrics)
1616
- [Metrics](#metrics)
17-
- [NGINXaaS statistics](#nginxaas-statistics)
1817
- [NGINX config statistics](#nginx-config-statistics)
1918
- [NGINX connections statistics](#nginx-connections-statistics)
2019
- [NGINX requests and response statistics](#nginx-requests-and-response-statistics)
@@ -23,27 +22,12 @@ F5 NGINXaaS for Google Cloud (NGINXaaS) provides a rich set of metrics that you
2322
- [NGINX worker statistics](#nginx-worker-statistics)
2423
- [NGINX upstream statistics](#nginx-upstream-statistics)
2524
- [NGINX stream statistics](#nginx-stream-statistics)
26-
- [System cpu statistics](#system-cpu-statistics)
27-
- [System disk statistics](#system-disk-statistics)
28-
- [System memory statistics](#system-memory-statistics)
29-
- [System filesystem statistics](#system-filesystem-statistics)
30-
- [System network statistics](#system-network-statistics)
3125

3226
## Metrics
3327

3428
The following metrics are reported by NGINXaaS for Google Cloud in Google Cloud Monitoring.
3529
The metrics are categorized by the namespace used in Google Cloud Monitoring. The labels allow you to filter or split your queries in Google Cloud Monitoring providing you with a granular view over the metrics reported.
3630

37-
### NGINXaaS statistics
38-
39-
{{< table >}}
40-
41-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
42-
| --------------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
43-
| nginxaas.ncus.provisioned| nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | The number of successfully provisioned NCUs during the aggregation interval. | deployment |
44-
45-
{{< /table >}}
46-
4731
### NGINX config statistics
4832

4933
{{< table >}}
@@ -174,76 +158,3 @@ The metrics are categorized by the namespace used in Google Cloud Monitoring. Th
174158
| nginx.stream.upstream.zombie.count | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, nginx_zone_name, nginx_upstream_name | gauge | The current number of peers removed from the group but still processing active client connections. | upstream |
175159

176160
{{< /table >}}
177-
178-
### System cpu statistics
179-
180-
{{< table >}}
181-
182-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
183-
|----------------------------------------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|---------------|
184-
| system.cpu.time | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, cpu, state | count | Total seconds each logical CPU spent on each mode (idle, interrupt, nice, softirq, steal, system, user, wait). | deployment |
185-
| system.cpu.utilization | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, cpu, state | gauge | Difference in system.cpu.time since the last measurement per logical CPU, divided by the elapsed time (value in interval [0,1]). | deployment |
186-
| system.cpu.physical.count | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | Number of available physical CPUs. | deployment |
187-
| system.cpu.logical.count | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | Number of available logical CPUs. | deployment |
188-
| system.cpu.frequency | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, cpu | gauge | Current frequency of the CPU core in Hz. | deployment |
189-
190-
{{< /table >}}
191-
192-
### System disk statistics
193-
194-
{{< table >}}
195-
196-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
197-
|----------------------------------------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|---------------|
198-
| system.disk.io | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | Disk bytes transferred (read/write). | deployment |
199-
| system.disk.operations | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | Disk operations count (read/write). | deployment |
200-
| system.disk.io_time | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device | count | Time disk spent activated. On Windows, this is calculated as the inverse of disk idle time. | deployment |
201-
| system.disk.operation_time | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | Time spent in disk operations. | deployment |
202-
| system.disk.weighted_io_time | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device | count | Time disk spent activated multiplied by the queue length. | deployment |
203-
| system.disk.pending_operations | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device | count | The queue size of pending I/O operations. | deployment |
204-
| system.disk.merged | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | The number of disk reads/writes merged into single physical disk access operations. | deployment |
205-
206-
{{< /table >}}
207-
208-
### NGINX memory statistics
209-
210-
{{< table >}}
211-
212-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
213-
|----------------------------------------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|---------------|
214-
| system.memory.limit | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | Total bytes of memory available. | deployment |
215-
| system.memory.usage | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, state | count | Bytes of memory in use, broken down by type (buffered, cached, inactive, free, slab_reclaimable, slab_unreclaimable, used). | deployment |
216-
| system.memory.utilization | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, state | gauge | Percentage of memory bytes in use. | deployment |
217-
| system.memory.page_size | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | gauge | A constant value for the system's configured page size. | deployment |
218-
| system.linux.memory.available | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | An estimate of how much memory is available for starting new applications, without swapping (Linux only). | deployment |
219-
| system.linux.memory.dirty | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | The amount of dirty memory according to `/proc/meminfo`. | deployment |
220-
221-
{{< /table >}}
222-
223-
### System filesystem statistics
224-
225-
{{< table >}}
226-
227-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
228-
|----------------------------------------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|---------------|
229-
| system.filesystem.usage | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, mode, mountpoint, type, state | count | Filesystem bytes used, broken down by usage type (free, reserved, used). | deployment |
230-
| system.filesystem.inodes.usage | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, mode, mountpoint, type, state | count | FileSystem inodes used. | deployment |
231-
| system.filesystem.utilization | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, mode, mountpoint, type | gauge | Fraction of filesystem bytes used. | deployment |
232-
233-
{{< /table >}}
234-
235-
### NGINX system statistics
236-
237-
{{< table >}}
238-
239-
| **Metric** | **Labels** | **Type** | **Description** | **Roll-up per** |
240-
|----------------------------------------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------|---------------|
241-
| system.network.packets | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | The number of packets transferred (receive/transmit). | deployment |
242-
| system.network.dropped | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | The number of packets dropped. | deployment |
243-
| system.network.errors | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | The number of network errors encountered. | deployment |
244-
| system.network.io | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, device, direction | count | The number of bytes transmitted and received. | deployment |
245-
| system.network.connections | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location, protocol, state | count | The number of network connections by protocol and state. | deployment |
246-
| system.network.conntrack.count | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | The count of entries in conntrack table. | deployment |
247-
| system.network.conntrack.max | nginxaas_account_id, nginxaas_namespace, nginxaas_deployment_object_id, nginxaas_deployment_name, nginxaas_deployment_location | count | The limit for entries in the conntrack table. | deployment |
248-
249-
{{< /table >}}

0 commit comments

Comments
 (0)