Skip to content

Commit a999df4

Browse files
authored
Merge pull request #20 from datamattsson/v104
v1.0.4 and onboard docs
2 parents 621635a + 892ec7d commit a999df4

File tree

9 files changed

+260
-40
lines changed

9 files changed

+260
-40
lines changed

docs/css/hpedev.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@
141141
margin: 0px;
142142
}
143143

144-
.rst-versions {
145-
width: 310px;
144+
.fa-code-fork {
145+
display: none;
146146
}
147147

148148
.rst-content .section ol li > ol, .rst-content .section ol li > ul, .rst-content .section ul li > ol, .rst-content .section ul li > ul, .rst-content .toctree-wrapper ol li > ol, .rst-content .toctree-wrapper ol li > ul, .rst-content .toctree-wrapper ul li > ol, .rst-content .toctree-wrapper ul li > ul, .rst-content section ol li > ol, .rst-content section ol li > ul, .rst-content section ul li > ol, .rst-content section ul li > ul, .rst-content .section ol li > *, .rst-content .section ul li > *, .rst-content .toctree-wrapper ol li > *, .rst-content .toctree-wrapper ul li > *, .rst-content section ol li > *, .rst-content section ul li > * {

docs/deployment/index.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ password: examplepassword
1414

1515
The `address` value is either a resolvable hostname or IP address of the management interface on the storage system. The `username` value identifies a storage system user with privileges described below.
1616

17-
| Storage System | User Type | Minimal Role | Open Ports Requirements |
18-
| :-------------------------------------------------------- | :---------- | :------------- | :---------------------- |
19-
| HPE Alletra Storage MP Block, Alletra 9000, Primera, 3PAR | System User | Browse | 22, 443 |
20-
| HPE Alletra 5000/6000, Nimble Storage | System User | Guest | 5392 |
21-
| HPE Alletra 5000/6000, Nimble Storage<sup>1</sup> | Tenant | N/A | 443, 5392 |
17+
| Storage System | User Type | Minimal Role | Open Ports Requirements |
18+
| :--------------------------------------------------------- | :---------- | :------------- | :---------------------- |
19+
| HPE Alletra Storage MP B10000, Alletra 9000, Primera, 3PAR | System User | Browse | 22, 443 |
20+
| HPE Alletra 5000/6000, Nimble Storage | System User | Guest | 5392 |
21+
| HPE Alletra 5000/6000, Nimble Storage<sup>1</sup> | Tenant | N/A | 443, 5392 |
2222

2323
<sup>1</sup> = NimbleOS 6.0 and above only.
2424

@@ -48,17 +48,21 @@ CONFIG-PATH is the location of the storage system [configuration](#configuration
4848

4949
## Command Example
5050

51-
```markdown
51+
```markdown fct_label="3PAR, Primera, Alletra 9000 and Alletra Storage MP B10000"
5252
./hpe-array-exporter --log.path=/var/log/hpe-array-exporter.log /etc/config/storage-system.yaml
5353
```
5454

55+
```markdown fct_label="Nimble Storage and Alletra 5000/6000"
56+
GODEBUG=tlsrsakex=1 ./hpe-array-exporter --log.path=/var/log/hpe-array-exporter.log /etc/config/storage-system.yaml
57+
```
58+
5559
!!! important
5660
Include the `--accept-eula` option or set the environment variable `ACCEPT_HPE_STANDARD_EULA=yes` to confirm your acceptance of the [HPE license restrictions](../legal/eula/index.md).
5761

5862

5963
# Using a Container Image
6064

61-
A container image is hosted at `quay.io/hpestorage/array-exporter:v1.0.3`, with v1.0.3 replaced by the desired release version.
65+
A container image is hosted at `quay.io/hpestorage/array-exporter:v1.0.4`, with v1.0.4 replaced by the desired release version.
6266

6367
When deploying the array exporter as a container, the configuration file must be mounted as a volume.
6468

@@ -71,13 +75,13 @@ In this example, the configuration file at `/tmp/storage-system.yaml` is bound t
7175
```markdown
7276
docker run -it --name hpe-array-exporter -p 9090:8080 \
7377
-v /tmp/storage-system.yaml:/etc/config/storage-system.yaml \
74-
quay.io/hpestorage/array-exporter:v1.0.3 \
78+
quay.io/hpestorage/array-exporter:v1.0.4 \
7579
--log.path /var/log/hpe-array-exporter.log \
7680
/etc/config/storage-system.yaml
7781
```
7882

7983
!!! important
80-
Include the `--accept-eula` option or set the environment variable `ACCEPT_HPE_STANDARD_EULA=yes` to confirm your acceptance of the [HPE license restrictions](/legal/eula/index.html).
84+
Include the `--accept-eula` option or set the environment variable `ACCEPT_HPE_STANDARD_EULA=yes` to confirm your acceptance of the [HPE license restrictions](../legal/eula/index.md).
8185

8286
Consult the [Docker command line documentation](https://docs.docker.com/engine/reference/commandline/run/) for more information on running containers using Docker.
8387

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ This documentation shows how to [deploy](deployment/index.md) the exporter, the
1010

1111
HPE Storage Array Exporter for Prometheus is compatible with these storage arrays:
1212

13-
* HPE Alletra Storage MP Block
13+
* HPE Alletra Storage MP B10000<sup>1</sup>
1414
* HPE Alletra 9000
1515
* HPE Alletra 5000/6000
1616
* HPE Nimble Storage
1717
* HPE Primera
1818
* HPE 3PAR
1919

20+
<small>
21+
<sup>1</sup> = The B10000 platform from release 10.4 has its own [onboard exporter](onboard/index.md) and customers are recommended to use that. The external HPE Storage Array Exporter for Prometheus is not guaranteed future compatibility with the B10000 platform.
22+
</small>
23+
2024
See the [compatibility chart](releases/index.md) for specific versions and releases.
2125

2226
# Support

docs/integration/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It's most common to have scrape targets statically defined in a Prometheus confi
1515

1616
When running Prometheus as either a standalone executable or a container, a [configuration file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/) (conventionally named prometheus.yml) is used. In it, a scrape job can be added for the exporter with configuration content similar to the following example.
1717

18-
```markdown
18+
```yaml
1919
scrape_configs:
2020
- job_name: 'hpe-array-exporter'
2121
# A scrape interval of 30 seconds or more is recommended
@@ -54,7 +54,7 @@ The ServiceMonitor's `namespaceSelector` and `selector` fields in turn control h
5454

5555
#### ServiceMonitor Example
5656

57-
```markdown
57+
```yaml
5858
kind: ServiceMonitor
5959
apiVersion: monitoring.coreos.com/v1
6060
metadata:

docs/metrics/index.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@ The metrics provided by the HPE Storage Array Exporter for Prometheus vary accor
44

55
[TOC]
66

7-
## HPE Alletra 9000 and Primera
7+
## Alletra Storage MP B10000, Alletra 9000, Primera and 3PAR
88

9-
The metrics provided for HPE Alletra 9000 and Primera storage systems (3PAR is also supported) are equivalent, with the metric names reflecting the storage system type.
9+
The metrics provided for 3PAR derived systems are equivalent, with the metric names reflecting the storage system type.
10+
11+
!!! error "Recommendation"
12+
For HPE Alletra Storage MP B10000 it's recommended to use the [onboard exporter](../onboard/index.md).
1013

1114
### Common Provisioning Group (CPG) Space
1215

1316
| Metric | Type | Description |
1417
| :--- | :--- | :--- |
15-
| hpealletra9000_cpg_capacity_bytes<br/>hpeprimera_cpg_capacity_bytes<br/>hpe3par_cpg_capacity_bytes | Gauge | Total capacity allocated to a CPG |
16-
| hpealletra9000_cpg_used_bytes<br/>hpeprimera_cpg_used_bytes<br/>hpe3par_cpg_used_bytes | Gauge | CPG capacity in use |
17-
| hpealletra9000_cpg_available_bytes<br/>hpeprimera_cpg_available_bytes<br/>hpe3par_cpg_available_bytes | Gauge | CPG capacity available |
18-
| hpealletra9000_cpg_volume_used_bytes<br/>hpeprimera_cpg_volume_used_bytes<br/>hpe3par_cpg_volume_used_bytes | Gauge | CPG capacity reserved for volumes |
19-
| hpealletra9000_cpg_snapshot_used_bytes<br/>hpeprimera_cpg_snapshot_used_bytes<br/>hpe3par_cpg_snapshot_used_bytes | Gauge | CPG capacity reserved for snapshots |
18+
| hpealletrastoragemp_cpg_capacity_bytes<br/>hpealletra9000_cpg_capacity_bytes<br/>hpeprimera_cpg_capacity_bytes<br/>hpe3par_cpg_capacity_bytes | Gauge | Total capacity allocated to a CPG |
19+
| hpealletrastoragemp_cpg_used_bytes<br/>hpealletra9000_cpg_used_bytes<br/>hpeprimera_cpg_used_bytes<br/>hpe3par_cpg_used_bytes | Gauge | CPG capacity in use |
20+
| hpealletrastoragemp_cpg_available_bytes<br/>hpealletra9000_cpg_available_bytes<br/>hpeprimera_cpg_available_bytes<br/>hpe3par_cpg_available_bytes | Gauge | CPG capacity available |
21+
| hpealletrastoragemp_cpg_volume_used_bytes<br/>hpealletra9000_cpg_volume_used_bytes<br/>hpeprimera_cpg_volume_used_bytes<br/>hpe3par_cpg_volume_used_bytes | Gauge | CPG capacity reserved for volumes |
22+
| hpealletrastoragemp_cpg_snapshot_used_bytes<br/>hpealletra9000_cpg_snapshot_used_bytes<br/>hpeprimera_cpg_snapshot_used_bytes<br/>hpe3par_cpg_snapshot_used_bytes | Gauge | CPG capacity reserved for snapshots |
2023

2124
Each of these metrics includes the following label.
2225

@@ -28,9 +31,10 @@ Each of these metrics includes the following label.
2831

2932
| Metric | Type | Labels | Description |
3033
| :--- | :--- | :--- | :--- |
31-
| hpealletra9000_volume_size_bytes<br/>hpeprimera_volume_size_bytes<br/>hpe3par_volume_size_bytes | Gauge | cpg, provisioning, volume | Volume data capacity |
34+
| hpealletrastoragemp_volume_size_bytes<br/>hpealletra9000_volume_size_bytes<br/>hpeprimera_volume_size_bytes<br/>hpe3par_volume_size_bytes | Gauge | cpg, provisioning, volume | Volume data capacity |
3235
| hpealletra9000_volume_used_bytes<br/>hpeprimera_volume_used_bytes<br/>hpe3par_volume_used_bytes | Gauge | cpg, provisioning, volume | Space used for volume data, including reserved space for a fully-provisioned volume |
3336
| hpealletra9000_volume_snapshot_used_bytes<br/>hpeprimera_volume_snapshot_used_bytes<br/>hpe3par_volume_snapshot_used_bytes | Gauge | cpg, provisioning, snap_cpg, volume | Space used for volume snapshots |
37+
| hpealletrastoragemp_volume_total_used_bytes | Gauge | cpg, provisioning, snap_cpg, volume | Space used for both user data and volume snapshots |
3438

3539
The labels have the following meanings.
3640

@@ -45,12 +49,12 @@ The labels have the following meanings.
4549

4650
| Metric | Type | Description |
4751
| :--- | :--- | :--- |
48-
| hpealletra9000_volume_reads_per_second_avg5m<br/>hpeprimera_volume_reads_per_second_avg5m<br/>hpep3par_volume_reads_per_second_avg5m | Gauge | Read operations performed on the VLUNs for a volume per second, averaged over a fixed five-minute interval (read IOPS) |
49-
| hpealletra9000_volume_writes_per_second_avg5m<br/>hpeprimera_volume_writes_per_second_avg5m<br/>hpe3par_volume_writes_per_second_avg5m | Gauge | Write operations performed on the VLUNs for a volume per second, averaged over a fixed five-minute interval (write IOPS) |
50-
| hpealletra9000_volume_read_bytes_per_second_avg5m<br/>hpeprimera_volume_read_bytes_per_second_avg5m<br/>hpe3par_volume_read_bytes_per_second_avg5m | Gauge | Bytes read from the VLUNs for a volume per second, averaged over a fixed five-minute interval (read throughput) |
51-
| hpealletra9000_volume_write_bytes_per_second_avg5m<br/>hpeprimera_volume_write_bytes_per_second_avg5m<br/>hpe3par_volume_write_bytes_per_second_avg5m | Gauge | Bytes written to the VLUNs for a volume per second, averaged over a fixed five-minute interval (write throughput) |
52-
| hpealletra9000_volume_seconds_per_read_avg5m<br/>hpeprimera_volume_seconds_per_read_avg5m<br/>hpe3par_volume_seconds_per_read_avg5m | Gauge | Seconds elapsed during a single read from the VLUNs for a volume, averaged over a fixed five-minute interval (read latency) |
53-
| hpealletra9000_volume_seconds_per_write_avg5m<br/>hpeprimera_volume_seconds_per_write_avg5m<br/>hpe3par_volume_seconds_per_write_avg5m | Gauge | Seconds elapsed during a single write to the VLUNs for a volume, averaged over a fixed five-minute interval (write latency) |
52+
| hpealletrastoragemp_volume_reads_per_second_avg5m<br/>hpealletra9000_volume_reads_per_second_avg5m<br/>hpeprimera_volume_reads_per_second_avg5m<br/>hpep3par_volume_reads_per_second_avg5m | Gauge | Read operations performed on the VLUNs for a volume per second, averaged over a fixed five-minute interval (read IOPS) |
53+
| hpealletrastoragemp_volume_writes_per_second_avg5m<br/>hpealletra9000_volume_writes_per_second_avg5m<br/>hpeprimera_volume_writes_per_second_avg5m<br/>hpe3par_volume_writes_per_second_avg5m | Gauge | Write operations performed on the VLUNs for a volume per second, averaged over a fixed five-minute interval (write IOPS) |
54+
| hpealletrastoragemp_volume_read_bytes_per_second_avg5m<br/>hpealletra9000_volume_read_bytes_per_second_avg5m<br/>hpeprimera_volume_read_bytes_per_second_avg5m<br/>hpe3par_volume_read_bytes_per_second_avg5m | Gauge | Bytes read from the VLUNs for a volume per second, averaged over a fixed five-minute interval (read throughput) |
55+
| hpealletrastoragemp_volume_write_bytes_per_second_avg5m<br/>hpealletra9000_volume_write_bytes_per_second_avg5m<br/>hpeprimera_volume_write_bytes_per_second_avg5m<br/>hpe3par_volume_write_bytes_per_second_avg5m | Gauge | Bytes written to the VLUNs for a volume per second, averaged over a fixed five-minute interval (write throughput) |
56+
| hpealletrastoragemp_volume_seconds_per_read_avg5m<br/>hpealletra9000_volume_seconds_per_read_avg5m<br/>hpeprimera_volume_seconds_per_read_avg5m<br/>hpe3par_volume_seconds_per_read_avg5m | Gauge | Seconds elapsed during a single read from the VLUNs for a volume, averaged over a fixed five-minute interval (read latency) |
57+
| hpealletrastoragemp_volume_seconds_per_write_avg5m<br/>hpealletra9000_volume_seconds_per_write_avg5m<br/>hpeprimera_volume_seconds_per_write_avg5m<br/>hpe3par_volume_seconds_per_write_avg5m | Gauge | Seconds elapsed during a single write to the VLUNs for a volume, averaged over a fixed five-minute interval (write latency) |
5458

5559
Each of these metrics includes the following labels.
5660

@@ -59,12 +63,12 @@ Each of these metrics includes the following labels.
5963
| cpg | Name of the CPG containing the volume |
6064
| volume | Volume name |
6165

62-
## HPE Alletra 5000/6000 and Nimble
66+
## Alletra 5000/6000 and Nimble Storage
6367

64-
The metrics provided for HPE Alletra 5000/6000 and Nimble Storage systems are equivalent, with the metric names reflecting the storage system type.
68+
The metrics provided for Alletra 5000/6000 and Nimble Storage systems are equivalent, with the metric names reflecting the storage system type.
6569

6670
!!! note
67-
HPE Alletra 5000 metrics will appear as "hpealletra6000".
71+
Alletra 5000 metrics will appear as "hpealletra6000".
6872

6973
### Storage Pool Space
7074

0 commit comments

Comments
 (0)