Skip to content

Commit adef2b0

Browse files
Update README.md
1 parent 81a4f59 commit adef2b0

File tree

1 file changed

+42
-13
lines changed

1 file changed

+42
-13
lines changed

README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -128,19 +128,16 @@ Authentication is used by the exporter as the mechanism to cross authenticate to
128128
The exporter understands the following requests:
129129

130130

131-
| URL | GET parameters | description |
132-
| ------------------------------------------------------| -------------- | -----------------------------|
133-
| http://\<exporter-host\>:\<port\>/metrics | endpoint | Full array metrics |
134-
| http://\<exporter-host\>:\<port\>/metrics/array | endpoint | Array metrics |
135-
| http://\<exporter-host\>:\<port\>/metrics/objectstore | endpoint | Object Store metrics * |
136-
| http://\<exporter-host\>:\<port\>/metrics/clients | endpoint | Clients metrics |
137-
| http://\<exporter-host\>:\<port\>/metrics/filesystems | endpoint | File System metrics * |
138-
| http://\<exporter-host\>:\<port\>/metrics/usage | endpoint | Quotas usage metrics |
139-
| http://\<exporter-host\>:\<port\>/metrics/policies | endpoint | NFS policies info metrics |
131+
| URL | GET parameters | description |
132+
| ----------------------------------------------------- | -------------- | ------------------------- |
133+
| http://\<exporter-host\>:\<port\>/metrics | endpoint | Full array metrics |
134+
| http://\<exporter-host\>:\<port\>/metrics/array | endpoint | Array metrics |
135+
| http://\<exporter-host\>:\<port\>/metrics/clients | endpoint | Clients metrics |
136+
| http://\<exporter-host\>:\<port\>/metrics/filesystems | endpoint | File System metrics |
137+
| http://\<exporter-host\>:\<port\>/metrics/objectstore | endpoint | Object Store metrics |
138+
| http://\<exporter-host\>:\<port\>/metrics/policies | endpoint | NFS policies info metrics |
139+
| http://\<exporter-host\>:\<port\>/metrics/usage | endpoint | Quotas usage metrics |
140140

141-
\* Introduced in version 1.1.0 of the FB OpenMetrics exporter, a change to the filesystem and bucket URI's was made to split off separate endpoints to ensure performance metrics for the /metrics/array endpoint remains quick to scrape in large environments.
142-
143-
Depending on the target array, scraping for the whole set of metrics could result into timeout issues, in which case it is suggested either to increase the scraping timeout or to scrape each single endpoint instead.
144141

145142
### Usage examples
146143

@@ -161,10 +158,42 @@ Please have a look at the documentation of each image/application for adequate c
161158

162159
A simple but complete example to deploy a full monitoring stack on kubernetes can be found in the [examples](examples/config/k8s) directory
163160

161+
### Upgrade Information
162+
163+
v1.1.0 - New URIs `filesystem` and `objectstore` were added to split off these metric instruments to ensure metrics in the `array` URI remain quick to scrape in large environments to comply with the limitations recommendation set below in [Bugs and Limitations](#bugs-and-limitations).
164+
165+
If you require the following metrics for your dataset for your observability toolset, please add the new endpoint(s) as required.
166+
167+
168+
The following metrics have been moved from `array` to `filesystem`
169+
170+
* `purefb_file_systems_performance_average_bytes`
171+
* `purefb_file_systems_performance_bandwidth_bytes`
172+
* `purefb_file_systems_performance_latency_usec`
173+
* `purefb_file_systems_performance_throughput_iops`
174+
* `purefb_file_systems_space_bytes`
175+
* `purefb_file_systems_space_data_reduction_ratio`
176+
177+
The following metrics have been moved from `array` to `objectstore`
178+
179+
* `purefb_buckets_object_count`
180+
* `purefb_buckets_performance_average_bytes`
181+
* `purefb_buckets_performance_bandwidth_bytes`
182+
* `purefb_buckets_performance_latency_usec`
183+
* `purefb_buckets_performance_throughput_iops`
184+
* `purefb_buckets_quota_space_bytes`
185+
* `purefb_buckets_s3_specific_performance_latency_usec`
186+
* `purefb_buckets_s3_specific_performance_throughput_iops`
187+
* `purefb_buckets_space_bytes`
188+
* `purefb_buckets_space_data_reduction_ratio`
189+
* `purefb_object_store_accounts_data_reduction_ratio`
190+
* `purefb_object_store_accounts_object_count`
191+
* `purefb_object_store_accounts_space_bytes`
192+
164193

165194
### Bugs and Limitations
166195

167-
* Pure FlashBlade REST APIs are not designed for efficiently reporting on full clients and objects quota KPIs, therefrore it is suggested to scrape the "array" metrics preferably and use the "clients" and "usage" metrics individually and with a lower frequency than the other.. In any case, as a general rule, it is advisable to do not lower the scraping interval down to less than 30 sec. In case you experience timeout issues, you may want to increase the Prometheus scraping timeout and interval approriately.
196+
* Pure FlashBlade REST APIs are not designed for efficiently reporting on full clients and objects quota metrics. Therefore, it is suggested to scrape the `array` metrics most frequently and use the `clients`, `filesystem`, `objectstore`, `policies`, and `usage` endpoints individually and with a lower frequency. As a general rule, it is not advisable to lower the scraping interval to less than 30 seconds for for any endpoint. In case you experience timeout issues, you may want to increase the Prometheus scraping timeout and interval appropriately. It is very important to have the collection interval (frequency) safely higher than the scrape duration.
168197

169198
### Metrics Collected
170199

0 commit comments

Comments
 (0)