This is a simple server that scrapes a baremetal chassis' managers stats using the redfish API and exports them via HTTP for Prometheus consumption.
This app can support any chassis that has the redfish API available. If one needs to query any non-redfish API calls this app can be extended to support that. Please see the plugins documentation for more information.
To run it:
$ ./fishymetrics --help
usage: fishymetrics [<flags>]
redfish api exporter with all the bells and whistles
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
--user="" BMC static username
--password="" BMC static password
--timeout=15s BMC scrape timeout
--scheme="https" BMC Scheme to use
--log.level=[debug|info|warn|error]
log level verbosity
--log.method=[file|vector]
alternative method for logging in addition to stdout
--log.file-path="/var/log/fishymetrics"
directory path where log files are written if log-method is file
--log.file-max-size="256" max file size in megabytes if log-method is file
--log.file-max-backups="1" max file backups before they are rotated if log-method is file
--log.file-max-age="1" max file age in days before they are rotated if log-method is file
--vector.endpoint="http://0.0.0.0:4444"
vector endpoint to send structured json logs to
--port="9533" exporter port
--vault.addr="https://vault.com"
Vault instance address to get chassis credentials from
--vault.role-id="" Vault Role ID for AppRole
--vault.secret-id="" Vault Secret ID for AppRole
--collector.drives.modules-exclude=""
regex of drive module(s) to exclude from the scrape
--collector.firmware.modules-exclude=""
regex of firmware module to exclude from the scrape
--credentials.profiles=CREDENTIALS.PROFILES
profile(s) with all necessary parameters to obtain BMC credential from secrets backend, i.e.
--credentials.profiles="
profiles:
- name: profile1
mountPath: "kv2"
path: "path/to/secret"
userField: "user"
passwordField: "password"
...
"
--credentials.profiles='{"profiles":[{"name":"profile1","mountPath":"kv2","path":"path/to/secret","userField":"user","passwordField":"password"},...]}'
Or set the following ENV Variables:
BMC_USERNAME=<string>
BMC_PASSWORD=<string>
BMC_TIMEOUT=<duration> (Default: 15s)
BMC_SCHEME=<string> (Default: https)
EXPORTER_PORT=<int> (Default: 9533)
LOG_PATH=<string> (Default: /var/log/fishymetrics)
VAULT_ADDRESS=<string>
VAULT_ROLE_ID=<string>
VAULT_SECRET_ID=<string>
./fishymetricsSince some hosts can contain many dozens of drives, this can cause a scrape to take a very long time and may not be entirely necessary. Because of this we've included an exclude flag specifically for the drives.module and firmware.module scopes.
Example:
--collector.drives.modules-exclude="(?i)(FlexUtil|(SBMezz|IOEMezz)[0-9]+)"| Collector | Scope | Include Flag | Exclude Flag |
|---|---|---|---|
| drives | module | N/A | module-exclude |
| firmware | module | N/A | module-exclude |
Responds with the application's version, build_date, go_version, etc
curl http://localhost:9533/infoResponds with the application's runtime metrics
_if deployed on ones localhost_curl http://localhost:9533/metricsTo test a scrape of a host's redfish API, you can curl fishymetrics
curl 'http://localhost:9533/scrape?model=<model-name>&target=1.2.3.4'If you have a credential profile configured you can add the extra URL query parameter
curl 'http://localhost:9533/scrape?model=<model-name>&target=1.2.3.4&credential_profile=<profile-name>'There is plugin support which is passed a comma separated list of strings
curl 'http://localhost:9533/scrape?model=<model-name>&target=1.2.3.4&plugins=example1,example2'To run the fishymetrics exporter as a Docker container using static crdentials, run:
docker run --name fishymetrics -d -p <EXPORTER_PORT>:<EXPORTER_PORT> \
-e BMC_USERNAME='<user>' \
-e BMC_PASSWORD='<password>' \
-e BMC_TIMEOUT=15s \
-e EXPORTER_PORT=1234 \
comcast/fishymetrics:latestdocker run --name fishymetrics -d -p <EXPORTER_PORT>:<EXPORTER_PORT> \
-user '<user>' \
-password '<password>' \
-timeout 15s \
-port 1234 \
comcast/fishymetrics:latestThe fishymetrics exporter needs to be passed the address as a parameter, this can be done with relabelling.
Example config:
scrape_configs:
- job_name: 'fishymetrics'
static_configs:
- targets:
- bmc-fdqn-p1.example.com
labels:
foo: bar
- targets:
- bmc-fdqn-p2.example.com
labels:
foo: bar
metrics_path: /scrape
scrape_interval: 5m
params:
model: ["dl360"]
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: fishymetrics.example.com # Kubernetes cluster nginx-ingress FQDN or any host IP/FQDN you deployed withmake build
make docker
make test
dependency source code can be found in the sources.tgz file in the root of the comcast/fishymetrics-src docker image. To extract the source code, run the following commands:
export TMP_CONTAINER="$(docker create comcast/fishymetrics-src:latest)"
docker export $TMP_CONTAINER | tar -x sources.tgz
docker rm $TMP_CONTAINER
tar -xzf sources.tgzdependency licenses for each package:
| package | license |
|---|---|
github.com/hashicorp/go-hclog |
MIT license |
github.com/hashicorp/go-retryablehttp |
Mozilla Public License v2.0 |
github.com/hashicorp/vault/api |
Mozilla Public License v2.0 |
github.com/hashicorp/vault/api/auth/approle |
Mozilla Public License v2.0 |
github.com/hashicorp/vault/sdk |
Mozilla Public License v2.0 |
github.com/nrednav/cuid2 |
MIT license |
github.com/prometheus/client_golang |
Apache-2.0 license |
github.com/stretchr/testify |
MIT license |
go.uber.org/zap |
MIT license |
gopkg.in/alecthomas/kingpin.v2 |
MIT license |
gopkg.in/natefinch/lumberjack.v2 |
MIT license |
gopkg.in/yaml.v3 |
Apache-2.0 license |
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent