Merge pull request #7 from Charles1000Chen/mu

Merge cumulated updates

Author: Charles1000Chen

.gitignore

@@ -1,3 +1,6 @@
 /spectrum-virtualize-exporter
 /temp.yaml
-/.vscode
+
+/.vscode
+/.whitesource
+/.jenkinsfile*

.travis.yml

@@ -1,6 +1,4 @@
 language: go
 
 go:
-- 1.x
-- 1.11.x
-- master
+- 1.22.x

CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.9.4 / 2022-04-18
+
+* [FIXBUG] Fix vulunerabilities for CVE-2022-21698
+
+## 0.9.3 / 2021-06-21
+
+* [FEATURE] Support to verify the certification of Spectrum device
+* [CHANGE] Add a parameter 'verifyCert' into spectrumVirtualize.yml file to turn on/off the ability of certification verification
+
 ## 0.9.2 / 2020-04-30
 
 * [CHANGE] Disable metrics from the exporter itself by default

Dockerfile

@@ -1,8 +1,30 @@
+FROM ubuntu:jammy AS pem
+RUN apt update && apt install curl -y
+WORKDIR /root/
+# The links of the IBM root CA and intermediate certs are from https://daymvs1.pok.ibm.com/ibmca/certificates.do;
+# for other well known CAs, just install the ca-certificates package.
+RUN curl https://daymvs1.pok.ibm.com/ibmca/downloadCarootCert.do?file=carootcert.der --output carootcert.der --cipher 'DEFAULT:!DH' && \
+    curl https://daymvs1.pok.ibm.com/ibmca/downloadCarootCert.do?file=caintermediatecert.der --output caintermediatecert.der --cipher 'DEFAULT:!DH' && \
+    openssl x509 -inform der -in carootcert.der -out 01-carootcert.pem && \
+    openssl x509 -inform der -in caintermediatecert.der -out 02-caintermediatecert.pem
 
-# FROM quay.io/prometheus/busybox:latest
-FROM s390x/busybox:latest
-COPY spectrum-virtualize-exporter /bin/spectrum-virtualize-exporter
-COPY spectrumVirtualize.yml /etc/spectrumVirtualize/spectrumVirtualize.yml
+
+FROM ubuntu:jammy
+
+ARG APP_USER=spectrum
+
+# Use "make binary" to build the binary spectrum-virtualize-exporter
+COPY spectrum-virtualize-exporter /opt/spectrumVirtualize/spectrum-virtualize-exporter
+COPY spectrumVirtualize.yml /opt/spectrumVirtualize/spectrumVirtualize.yml
+COPY --from=pem /root/*.pem /usr/local/share/ca-certificates/
+# https://github.com/golang/go/blob/master/src/crypto/x509/root_linux.go
+RUN mkdir -p /etc/ssl/certs \
+    && cat /usr/local/share/ca-certificates/*.pem >> /etc/ssl/certs/ca-certificates.crt \
+    && groupadd -g 1000 -r $APP_USER \
+    && useradd -u 1000 -r -g $APP_USER -d /home/$APP_USER -m -s /bin/bash $APP_USER \
+    && chown -R 1000:1000 /opt/spectrumVirtualize
+
+USER $APP_USER
 EXPOSE 9119
-ENTRYPOINT ["/bin/spectrum-virtualize-exporter"]
-CMD ["--config.file=/etc/spectrumVirtualize/spectrumVirtualize.yml"]
+ENTRYPOINT ["/opt/spectrumVirtualize/spectrum-virtualize-exporter"]
+CMD ["--config.file=/etc/spectrumVirtualize/spectrumVirtualize.yml"]

Makefile

@@ -1 +1,23 @@
-go build 
+SHELL := /bin/bash -o pipefail
+PROJDIR := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
+PROJNAME := $(shell basename $(PROJDIR))
+VERSION := $(shell git describe --abbrev=0 --tags)
+
+versionDir=github.com/prometheus/common/version
+gitBranch=$(shell git rev-parse --abbrev-ref HEAD)
+gitCommit=$(shell git rev-parse --short HEAD)
+gitUser=$(shell git config user.name | tr -d ' ')
+buildDate=$(shell TZ=Asia/Shanghai date +%FT%T%z)
+
+ldflags="-s -w -X ${versionDir}.Version=${VERSION} -X ${versionDir}.Revision=${gitCommit} \
+    -X ${versionDir}.Branch=${gitBranch} -X ${versionDir}.BuildUser=${gitUser} \
+    -X ${versionDir}.BuildDate=${buildDate}"
+all: binary
+
+binary:
+	@echo "build the ${PROJNAME}"
+	go build -ldflags ${ldflags}
+	@echo "build done."
+
+docker: binary
+	docker build . -t $(PROJNAME):$(gitCommit)

README.md

@@ -6,18 +6,18 @@ collects metrics from storage solutions which are built with the
 Storage solutions built with the IBM Spectrum Virtualize software are the
 [IBM FlashSystem V9000 system](https://www.ibm.com/support/knowledgecenter/STKMQV_8.2.1/com.ibm.storage.vflashsystem9000.8.2.1.doc/svc_svcovr_1bcfiq.html),
 the [IBM SAN Volume Controller](https://www.ibm.com/us-en/marketplace/san-volume-controller) and
- the [IBM Storwize Family](https://www.ibm.com/it-infrastructure/storage/storwize<Paste>)
+ the [IBM Storwize Family](https://www.ibm.com/it-infrastructure/storage/storwize\<Paste>)
 
 ## Usage
 
-| Flag | Description | Default Value | 
+| Flag | Description | Default Value |
 | --- | --- | --- |
 | config.file | Path to configuration file | spectrumVirtualize.yml |
-| web.telemetry-path | Path under which to expose metrics | /metrics |
+| web.metrics-context | Context under which to expose metrics | /metrics |
+| web.settings-context | Context under which to expose setting metrics | /settings |
 | web.listen-address | Address on which to expose metrics and web interface | :9119 |
 | web.disable-exporter-metrics | Exclude metrics about the exporter itself (promhttp_*, process_*, go_*) | true |
-| --collector.name | Collector are enabled, the name means name of CLI Command | By default enabled collectors: lssystem and lssystemstats. |
-| --no-collector.name | Collectors that are enabled by default can be disabled, the name means name of CLI Command | By default disabled collectors: lsnodestats, lsmdisk, lsmdiskgrp, lsvdisk and lsvdiskcopy. |
+| --collector.[name] | Enable or disable collector. The [name] is in the list "`lsmdisk`, `lsmdiskgrp`, `lsnodestats`, `lssystem`, `lssystemstats`, `lsvdisk`, `lsvdiskcopy`, `lscloudcallhome`, `lsdrive`, `lsenclosure`, `lsenclosurebattery`, `lsenclosurecanister`, `lsenclosurepsu`, `lshost`, `ip`, `lsmdisk_s`, `lsmdiskgrp_s`, `lsnodecanister`, `lsportfc`" | [true\|false]. <br> By default enabled collectors: `lssystem`, `lssystemstats`, `lscloudcallhome`, `lsdrive`, `lsenclosure`, `lsenclosurebattery`, `lsenclosurecanister`, `lsenclosurepsu`, `lshost`, `ip`, `lsmdisk_s`, `lsmdiskgrp_s`, `lsnodecanister`, `lsportfc`. |
 
 ## Building and running
 
@@ -27,47 +27,81 @@ the [IBM SAN Volume Controller](https://www.ibm.com/us-en/marketplace/san-volume
 * Building:
 
   * binary
-    ```
+
+    ```bash
     export GOPATH=your_gopath
     cd your_gopath
-    git clone git@github.ibm.com:ZaaS/spectrum-virtualize-exporter.git
+    git clone https://github.com/IBM/spectrum-virtualize-exporter.git
     cd spectrum-virtualize-exporter
-    go build
+    make binary
     go install (Optional but recommended. This step will copy spectrum-virtualize-exporter binary package into $GOPATH/bin directory. It will be connvenient to copy the package to Monitoring docker image)
     ```
+
   * docker image
-    ```
-    docker build -t spectrum-virtualize-exporter .
+
+    ```bash
+    make docker
     ```
 
 * Running:
   * Run Locally
-    ```
+
+    ```bash
     ./spectrum-virtualize-exporter --config.file=/etc/spectrumVirtualize/spectrumVirtualize.yml
     ```
 
   * Run as docker image
-    ```
-    docker run -it -d -p 9119:9119 -v /etc/spectrumVirtualize/spectrumVirtualize.yml:/etc/spectrumVirtualize/spectrumVirtualize.yml --name spectrum-virtualize-exporter spectrum-virtualize-exporter --config.file=/etc/spectrumVirtualize/spectrumVirtualize.yml --log.level debug --restart always
+
+    ```bash
+    docker run -it -d -p 9119:9119 -v /etc/spectrumVirtualize/spectrumVirtualize.yml:/etc/spectrumVirtualize/spectrumVirtualize.yml --name spectrum-virtualize-exporter spectrum-virtualize-exporter --config.file=/etc/spectrumVirtualize/spectrumVirtualize.yml --log.level debug
     ```
 
-  * Visit http://localhost:9119/metrics
+  * Visit <http://localhost:9119/metrics>
 
 ## Configuration
 
-The spectrum-virtualize-exporter reads from [spectrumVirtualize.yml](spectrumVirtualize.yml) config file by default. Edit your config YAML file, Enter the IP address of the storage device, your username, and your password there. 
-```
+The spectrum-virtualize-exporter loads the [./spectrumVirtualize.yml](spectrumVirtualize.yml) config file by default.
+
+### Required settings
+
+* `targets.[].ipAddress`: IP address of the storage device.
+* `targets.[].userid`: Username to access the storage device.
+* `targets.[].password`: User password to access the storage device.
+
+### Optionally settings
+
+* `extra_labels.[].name`: Customized label name adding to metrics.
+* `extra_labels.[].value`: Value of the customized label.
+* `tls_server_config.ca_cert`: The CA certificate chain file in pem format for verifying client certificate.
+* `tls_server_config.server_cert`: The server's certificate chain file in pem format.
+* `tls_server_config.server_key`: The server's private key file.
+
+### Config File Sample
+
+```yaml
 targets:
   - ipAddress: IP address
     userid: user
     password: password
+extra_labels:
+  - name: pod_name
+    value: pod_value
+tls_server_config:
+  ca_cert: ./certs/ca-root.crt
+  server_cert: ./certs/server.crt
+  server_key: ./certs/server.key
 ```
 
+**If any of the "ca_cert", "server_cert" or "server_key" are not provided, the exporter http server will start without https(mTLS) enabled.**
+
 ## Exported Metrics
 
-| CLI Command | Description | Default | Metrics | Total number of metrics |
+* It recommended to scrape every 30 seconds.
+
+| RESTful API | Description | Default | Metrics | Total number of metrics |
 | --- | --- | --- | --- | --- |
-| - | Metrics from the exporter itself. | Disabled | [List](docs/exporter_metrics.md) | 35 |
+| - | Metrics from the prometheus exporter itself. | Disabled | [List](docs/exporter_prometheus_metrics.md) | 30 |
+| - | Metrics from the spectrum exporter itself. | Enabled | [List](docs/exporter_spectrum_metrics.md) | 4 |
 | lssystem | Get a detailed view of a clustered system (system). | Enabled | [List](docs/lssystem_metrics.md) | 57 |
 | lssystemstats | Get the most recent values of all node statistics in a system. | Enabled | [List](docs/lssystemstats_metrics.md) | 49 |
 | lsnodestats | Ge the most recent values of statistics for all nodes. | Disabled | [List](docs/lsnodestats_metrics.md)| 46 |
@@ -76,6 +110,27 @@ targets:
 | lsvdisk | Get detailed view of volumes that are recognized by the system. | Disabled | [List](docs/lsvdisk_metrics.md) | 1 |
 | lsvdiskcopy | Get volume copy information. | Disabled | [List](docs/lsvdiskcopy_metrics.md) | 1 |
 
+## Exported Setting Metrics
+
+* It recommended to scrape every >15 minutes.
+
+| RESTful API | Description | Default | Metrics | Total number of metrics |
+| --- | --- | --- | --- | --- |
+| - | Metrics from the prometheus exporter itself. | Disabled | [List](docs/exporter_prometheus_metrics.md) | 30 |
+| - | Metrics from the spectrum exporter itself. | Enabled | [List](docs/exporter_spectrum_metrics.md) | 4 |
+| lscloudcallhome | The status of the Call Home information. | Enabled | [List](docs/lscloudcallhome_settings.md) | 1 |
+| lsenclosure | The summary of the enclosures including canister and PSU. | Enabled | [List](docs/lsenclosure_settings.md) | 1 |
+| lsenclosurebattery | The information about the batteries. | Enabled | [List](docs/lsenclosurebattery_settings.md) | 2 |
+| lsenclosurecanister | The detailed status of each canister in enclosures. | Enabled | [List](docs/lsenclosurecanister_settings.md) | 1 |
+| lsenclosurepsu | The information about each power-supply unit (PSU) in enclosures. | Enabled | [List](docs/lsenclosurepsu_settings.md) | 1 |
+| lsdrive | The configuration information and drive vital product data (VPD). | Enabled | [List](docs/lsdrive_settings.md) | 3 |
+| lshost | The concise information about all the hosts visible to the system. | Enabled | [List](docs/lshost_settings.md) | 1 |
+| lsnodecanister | The node canisters that are part of the system. | Enabled | [List](docs/lsnodecanister_settings.md) | 1 |
+| lsportfc | The status and properties of the Fibre Channel (FC) input/output (I/O) ports for the clustered system. | Enabled | [List](docs/lsportfc_settings.md) | 1 |
+| lsmdisk | The info of managed disks (MDisks) visible to the system. | Enabled | [List](docs/lsmdisk_settings.md) | 1 |
+| lsmdiskgrp | The info of storage pools that are visible to the system. | Enabled | [List](docs/lsmdiskgrp_settings.md) | 1 |
+| - | The connection status of system IPs(PSYS, SSYS, SVC1, SVC2). | Enabled | [List](docs/lsenclosurebattery_settings.md) | 1 |
+
 ## References
 
 * [IBM Spectrum Virtualize RESTful API For FS9xxx](https://www.ibm.com/support/knowledgecenter/en/STSLR9_8.2.0/com.ibm.fs9100_820.doc/rest_api_overview.html)