NetApp Harvest

https://github.com/netapp/harvest
Admin
NetApp Harvest is an open-source metrics collection and observability platform that gathers...
Tokens:916,656
Snippets:5,496
Trust Score:8.3
License:Apache-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Example output of certificate installation

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Example output from the security certificate install command, showing the certificate content and reference information.

```bash
jamaica::> security certificate install -type client-ca -vserver jamaica 

Please enter Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE-----                       
MIIDETCCAfmgAwIBAgIUP9EUXyl2BDSUOkNEcDU0yqbJ29IwDQYJKoZIhvcNAQEL
BQAwGDEWMBQGA1UEAwwNaGFydmVzdDItY2xpMzAeFw0yMDEwMDkxMjA0MDhaFw0y
MzEwMDktcGFueSBMdGQxFzAVBgNVBAMlc3QyLWNsaTMwggEiMA0tcGFueSBGCSqG
SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCVVy25BeCRoGCJWFOlyUL7Ddkze4Hl2/6u
qye/3mk5vBNsGuXUrtad5XfBB70Ez9hWl5sraLiY68ro6MyX1icjiUTeaYDvS/76
Iw7HeXJ5Pyb/fWth1nePunytoLyG/vaTCySINkIV5nlxC+k0X3wWFJdfJzhloPtt
1Vdm7aCF2q6a2oZRnUEBGQb6t5KyF0/Xh65mvfgB0pl/AS2HY5Gz+~L54Xyvs+BY
V7UmTop7WBYl0L3QXLieERpHXnyOXmtwlm1vG5g4n/0DVBNTBXjEdvc6oRh8sxBN
ZlQWRApE7pa/I1bLD7G2AiS4UcPmR4cEpPRVEsOFOaAN3Z3YskvnAgMBAAGjUzBR
MB0GA1UdDgQWBBQr4syV6TCcgO/5EcU/F8L2YYF15jAfBgNVHSMEGDAWgBQr4syV
6TCcgO/5EcU/F8L2YYF15jAPBgNVHRMdfdfwerH/MA0GCSqGSIb^ECd3DQEBCwUA
A4IBAQBjP1BVhClRKkO/M3zlWa2L9Ztce6SuGwSnm6Ebmbs+iMc7o2N9p3RmV6Xl
h6NcdXRzzPAVrUoK8ewhnBzdghgIPoCI6inAf1CUhcCX2xcnE/osO+CfvKuFnPYE
WQ7UNLsdfka0a9kTK13r3GMs09z/VsDs0gD8UhPjoeO7LQhdU9tJ/qOaSP3s48pv
sYzZurHUgKmVOaOE4t9DAdevSECEWCETRETA$Vbn%@@@%%rcdrctru65ryFaByb+
hTtGhDnoHwzt/cAGvLGV/RyWdGFAbu7Fb1rV94ceggE7nh1FqbdLH9siot6LlnQN
MhEWp5PYgndOW49dDYUxoauCCkiA
-----END CERTIFICATE-----


You should keep a copy of the CA-signed digital certificate for future reference.

The installed certificate's CA and serial number for reference:
CA: harvest2
Serial: 3FD1145F2976043012213d3009095534CCRDBD2

The certificate's generated name for reference: harvest2

```

--------------------------------

### Install go-version with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/go-version/README.md

Install the go-version library using the standard go get command.

```shell
$ go get github.com/hashicorp/go-version
```

--------------------------------

### Install tablewriter with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/olekukonko/tablewriter/README.md

Install the tablewriter library using the go get command.

```bash
go get github.com/olekukonko/tablewriter
```

--------------------------------

### Install Pretty with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/pretty/README.md

Install the Pretty library using the go get command. This retrieves the library for use in your Go project.

```sh
$ go get -u github.com/tidwall/pretty

```

--------------------------------

### Install Match with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/match/README.md

Use this command to install the Match library. It fetches the package from GitHub.

```bash
go get -u github.com/tidwall/match
```

--------------------------------

### Install Mergo with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/mergo/README.md

Install the Mergo library using the go get command.

```bash
go get dario.cat/mergo
```

--------------------------------

### Install uniseg with go get

Source: https://github.com/netapp/harvest/blob/main/vendor/github.com/rivo/uniseg/README.md

Install the uniseg package using the go get command.

```bash
go get github.com/rivo/uniseg
```

--------------------------------

### Install pflag with go get

Source: https://github.com/netapp/harvest/blob/main/vendor/github.com/spf13/pflag/README.md

Install the pflag package using the standard go get command.

```bash
go get github.com/spf13/pflag
```

--------------------------------

### Install goccy/go-yaml with go get

Source: https://github.com/netapp/harvest/blob/main/vendor/github.com/goccy/go-yaml/README.md

Install the library using the standard Go module command.

```sh
go get github.com/goccy/go-yaml
```

--------------------------------

### Install GJSON with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

Run this command to install the GJSON library. It requires Go to be installed.

```sh
$ go get -u github.com/tidwall/gjson
```

--------------------------------

### Install SJSON with go get

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/sjson/README.md

Install the SJSON library using the go get command. This retrieves the library for use in your Go project.

```sh
$ go get -u github.com/tidwall/sjson
```

--------------------------------

### Start Harvest directly

Source: https://github.com/netapp/harvest/blob/main/docs/quickstart.md

Starts Harvest directly from the installation directory without creating a service file, useful for testing.

```bash
cd ${HARVEST_INSTALL_PATH}/harvest-${HARVEST_VERSION}-1_linux_amd64
bin/harvest start
```

--------------------------------

### Setup SSL on ONTAP 7-mode

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-7mode-clusters.md

Run this command to set up SSL. Choose a key length of 2048 bits when prompted. The output shows the interactive prompts and example responses.

```bash
secureadmin setup ssl
```

```text
SSL Setup has already been done before. Do you want to proceed? [no] yes
Country Name (2 letter code) [US]: NL
State or Province Name (full name) [California]: Noord-Holland
Locality Name (city, town, etc.) [Santa Clara]: Schiphol
Organization Name (company) [Your Company]: NetApp
Organization Unit Name (division): SalesEngineering
Common Name (fully qualified domain name) [sdt-7dot1a.nltestlab.hq.netapp.com]:
Administrator email: noreply@netapp.com
Days until expires [5475] :5475 Key length (bits) [512] :2048
```

--------------------------------

### Install Rancher Desktop with brew

Source: https://github.com/netapp/harvest/blob/main/docs/install/containerd.md

Installs Rancher Desktop using Homebrew. After installation, start Rancher and wait for the VM and image downloads to complete.

```sh
brew install rancher
```

--------------------------------

### Quadlet install and service section for restart on boot

Source: https://github.com/netapp/harvest/blob/main/docs/install/quadlet.md

Section to add to Quadlet files to enable starting on boot and restarting the service automatically.

```ini
[Install]
# Start by default on boot
WantedBy=multi-user.target default.target

[Service]
Restart=always

```

--------------------------------

### Install ycat from source

Source: https://github.com/netapp/harvest/blob/main/vendor/github.com/goccy/go-yaml/README.md

Clone the go-yaml repository and install the ycat command using go install. This requires Go to be installed and the repository to be cloned.

```sh
git clone https://github.com/goccy/go-yaml.git
cd go-yaml/cmd/ycat && go install .
```

--------------------------------

### Install Cobra library with go get

Source: https://github.com/netapp/harvest/blob/main/vendor/github.com/spf13/cobra/README.md

Use this command to install the latest version of the Cobra library. Run it in your terminal before importing Cobra in your Go application.

```bash
go get -u github.com/spf13/cobra@latest
```

--------------------------------

### Output of gjson.Get example

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

This is the output produced by the preceding Go example.

```text
Prichard
```

--------------------------------

### Path syntax examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/sjson/README.md

Examples of dot syntax paths and their resulting values from the sample JSON document.

```text
"name.last"          >> "Anderson"
"age"                >> 37
"children.1"         >> "Alex"
"friends.1.last"     >> "Craig"
```

--------------------------------

### Query syntax examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

These examples demonstrate querying arrays for matches using comparison and pattern matching operators.

```text
friends.#(last=="Murphy").first    >> "Dale"
friends.#(last=="Murphy")#.first   >> ["Dale","Jane"]
friends.#(age>45)#.last            >> ["Craig","Murphy"]
friends.#(first%"D*").last         >> "Murphy"
friends.#(first!%"D*").last        >> "Craig"
friends.#(nets.#(=="fb"))#.first   >> ["Dale","Roger"]
```

--------------------------------

### Path syntax examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

These examples show how to access values using dot notation, wildcards, array indices, and the '#' character.

```text
"name.last"          >> "Anderson"
"age"                >> 37
"children"           >> ["Sara","Alex","Jack"]
"children.#"         >> 3
"children.1"         >> "Alex"
"child*.2"           >> "Jack"
"c?ildren.0"         >> "Sara"
"fav\.movie"         >> "Deer Hunter"
"friends.#.first"    >> ["Dale","Roger","Jane"]
"friends.1.last"     >> "Craig"
```

--------------------------------

### Install Server Certificate with SAN on Cluster

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Installs the server certificate (with SAN) and its private key on the cluster using the ONTAP CLI command 'security certificate install -type server'. Paste the certificate, private key, and optionally the CA chain when prompted.

```text
umeng-aff300-05-06::*> security certificate install -type server

Please enter Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE-----
..
-----END CERTIFICATE-----

Please enter Private Key: Press <Enter> when done
-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----

Please enter certificates of Certification Authorities (CA) which form the certificate chain of the server certificate. This starts with the issuing CA certificate of the server certificate and can range up to the root CA certificate.

Do you want to continue entering root and/or intermediate certificates {y|n}: n
```

--------------------------------

### Start Docker containers with updated configuration

Source: https://github.com/netapp/harvest/blob/main/docs/install/containers.md

Starts the containers using the custom prom-stack-prod.yml and harvest-compose.yml files.

```sh
docker compose -f prom-stack-prod.yml -f harvest-compose.yml up -d --remove-orphans
```

--------------------------------

### Start Podman socket service

Source: https://github.com/netapp/harvest/blob/main/docs/install/podman.md

Starts the Podman systemd socket-activated service. Requires sudo.

```bash
sudo systemctl start podman.socket
```

--------------------------------

### Install yaml.v3 for tests

Source: https://github.com/netapp/harvest/blob/main/third_party/mergo/README.md

Install the yaml.v3 package if tests are failing due to a missing package.

```bash
go get gopkg.in/yaml.v3
```

--------------------------------

### EseriesMel export_options YAML example

Source: https://github.com/netapp/harvest/blob/main/docs/configure-eseries.md

Example export_options section listing instance_keys that are included on every exported series.

```yaml
export_options:
  instance_keys:
    - component_type
    - event_type
    - location
    - message
    - severity
```

--------------------------------

### Example output of copy command

Source: https://github.com/netapp/harvest/blob/main/docs/MigratePrometheusDocker.md

Example output showing files being copied from the old volume to the new one.

```bash
'./wal' -> '/to/./wal'
'./wal/00000000' -> '/to/./wal/00000000'
'./chunks_head' -> '/to/./chunks_head'
...
```

--------------------------------

### Install Root CA Certificate on Cluster

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Logs into the cluster via SSH and installs the server CA certificate using the ONTAP CLI command 'security certificate install -type server-ca'. Paste the certificate content when prompted.

```text
ssh admin@IP
umeng-aff300-05-06::*> security certificate install -type server-ca

Please enter Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----

You should keep a copy of the CA-signed digital certificate for future reference.

The installed certificate's CA and serial number for reference:
CA: ntap
Serial: 46AFFC7A3A9999999E8FB2FEB0

The certificate's generated name for reference: ntap
```

--------------------------------

### Install Harvest Helm chart

Source: https://github.com/netapp/harvest/blob/main/deploy/helm/harvest/README.md

Installs the Harvest Helm chart into the 'harvest' namespace, creating it if necessary, and uses the specified values file.

```bash
helm install harvest ./deploy/helm/harvest --namespace harvest --create-namespace --values values.yaml
```

--------------------------------

### Sample JSON for path syntax examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

This JSON object is used by the path syntax examples that follow.

```json
{
  "name": {"first": "Tom", "last": "Anderson"},
  "age":37,
  "children": ["Sara","Alex","Jack"],
  "fav.movie": "Deer Hunter",
  "friends": [
    {"first": "Dale", "last": "Murphy", "age": 44, "nets": ["ig", "fb", "tw"]},
    {"first": "Roger", "last": "Craig", "age": 68, "nets": ["fb", "tw"]},
    {"first": "Jane", "last": "Murphy", "age": 47, "nets": ["ig", "tw"]}
  ]
}
```

--------------------------------

### Complete Merge Example

Source: https://github.com/netapp/harvest/blob/main/third_party/mergo/README.md

A complete example showing how to merge two structs. The destination struct's zero-value fields are filled from the source. The output is printed.

```go
package main

import (
	"fmt"
	"dario.cat/mergo"
)

type Foo struct {
	A string
	B int64
}

func main() {
	src := Foo{
		A: "one",
		B: 2,
	}
	dest := Foo{
		A: "two",
	}
	mergo.Merge(&dest, src)
	fmt.Println(dest)
	// Will print
	// {two 2}
}
```

--------------------------------

### Reload systemd and start Prometheus

Source: https://github.com/netapp/harvest/blob/main/docs/quickstart.md

Reloads the systemd daemon, enables the Prometheus service to start on boot, and starts it immediately.

```bash
sudo systemctl daemon-reload
sudo systemctl enable prometheus
sudo systemctl start prometheus
```

--------------------------------

### Example output of volume list

Source: https://github.com/netapp/harvest/blob/main/docs/MigratePrometheusDocker.md

Example output showing the historical volume and the new volume. The new volume may be missing if it hasn't been created yet.

```bash
harvest-22080-1_linux_amd64_prometheus_data  # historical Prometheus data here
harvest_prometheus_data                      # it is fine if this line is missing
```

--------------------------------

### Install client CA certificate

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Run this command on the cluster to install the client CA certificate. Paste the certificate content when prompted. The output shows the certificate's CA, serial number, and generated name.

```bash
ssh admin@IP
umeng-aff300-05-06::*>  security certificate install -type client-ca -vserver umeng-aff300-05-06

Please enter Certificate: Press <Enter> when done
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----

You should keep a copy of the CA-signed digital certificate for future reference.

The installed certificate's CA and serial number for reference:
CA: cbg
Serial: B77B59444444CCCC

The certificate's generated name for reference: cbg_B77B59444444CCCC
```

--------------------------------

### Install Docker Compose for Podman

Source: https://github.com/netapp/harvest/blob/main/docs/install/podman.md

Downloads and installs Docker Compose version 1.29.2 to /usr/local/bin and creates a symlink in /usr/bin. Requires sudo and curl.

```bash
VERSION=1.29.2
sudo curl -L "https://github.com/docker/compose/releases/download/$VERSION/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
```

--------------------------------

### Example disk_labels metric

Source: https://github.com/netapp/harvest/blob/main/docs/resources/templates-and-metrics.md

Reformatted example of the disk_labels metric showing key-value pairs for a monitored disk instance.

```promql
disk_labels{
  datacenter="dc-1",
  cluster="umeng-aff300-05-06",
  node="umeng-aff300-06",
  disk="1.1.23",
  type="SSD",
  model="X371_S1643960ATE",
  outage="",
  owner_node="umeng-aff300-06",
  shared="true",
  shelf="1",
  shelf_bay="23",
  serial_number="S3SENE0K500532",
  failed="false",
  container_type="shared"
}
```

--------------------------------

### Export options example

Source: https://github.com/netapp/harvest/blob/main/docs/configure-eseries.md

Example of the export_options section. instance_keys lists primary identifier labels from ^^ counters; instance_labels lists all labels to export in the <object>_labels metric.

```yaml
export_options:
  instance_keys:      # Primary identifier(s)
    - volume          
  instance_labels:    # Labels to include in <object>_labels metric
    - hosts
    - luns
    - mapping_types
    - offline
    - pool
    - raid_level
    - status
    - volume
    - workload
    - wwid    
```

--------------------------------

### Install curl via Homebrew and test client auth

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Install a newer curl via Homebrew, then verify the version and test client authentication. The output shows a successful request returning disk records.

```bash
brew install curl

curl --version
curl 7.80.0 (x86_64-apple-darwin20.6.0) libcurl/7.80.0 (SecureTransport) OpenSSL/1.1.1l zlib/1.2.11 brotli/1.0.9 zstd/1.5.0 libidn2/2.3.2 libssh2/1.10.0 nghttp2/1.46.0 librtmp/2.3 OpenLDAP/2.6.0
Release-Date: 2021-11-10
Protocols: dict file ftp ftps gopher gophers http https imap imaps ldap ldaps mqtt pop3 pop3s rtmp rtsp scp sftp smb smbs smtp smtps telnet tftp 
Features: alt-svc AsynchDNS brotli GSS-API HSTS HTTP2 HTTPS-proxy IDN IPv6 Kerberos Largefile libz MultiSSL NTLM NTLM_WB SPNEGO SSL TLS-SRP UnixSockets zstd

curl --cacert umeng-aff300-05-06.crt --key cert/cgrindst-mac-0.key --cert cert/cgrindst-mac-0.pem https://umeng-aff300-05-06-cm.rtp.openenglab.netapp.com/api/storage/disks

{
  "records": [
    {
      "name": "1.1.22",
      "_links": {
        "self": {
          "href": "/api/storage/disks/1.1.22"
        }
      }
    }
  ]
}

```

--------------------------------

### Example collector configuration for ASA r2

Source: https://github.com/netapp/harvest/blob/main/docs/asar2.md

Example YAML configuration showing the recommended collector order for ASA r2 systems. StatPerf must be listed first to collect performance metrics not available via KeyPerf.

```yaml
collectors:
    - StatPerf
    - Rest
    - RestPerf
```

--------------------------------

### Install client CA certificate on ONTAP

Source: https://github.com/netapp/harvest/blob/main/docs/prepare-cdot-clusters.md

Run this ONTAP CLI command to install the client CA certificate. Replace CLUSTER with your cluster name, then paste the public key content when prompted.

```bash
security certificate install -type client-ca -vserver CLUSTER

```

--------------------------------

### Output of custom separator example

Source: https://github.com/netapp/harvest/blob/main/third_party/olekukonko/tablewriter/README.md

The output produced by the custom separator example, showing the table with the custom separators.

```text
*------------*-----------*---------*
╪ FIRST NAME ╪ LAST NAME ╪   SSN   ╪
*------------*-----------*---------*
╪ John       ╪ Barry     ╪ 123456  ╪
*------------*-----------*---------*
╪ Kathy      ╪ Smith     ╪ 687987  ╪
*------------*-----------*---------*
╪ Bob        ╪ McCornick ╪ 3979870 ╪
*------------*-----------*---------*
```

--------------------------------

### Example: Add instance and labels

Source: https://github.com/netapp/harvest/blob/main/docs/resources/matrix.md

Shows how to create an instance and set labels. If NewInstance fails, the instance is nil and the error should be handled.

```go
var (
    instance *matrix.Instance
    err error
)
if instance, err = myMatrix.NewInstance("SomeCarMark"); err != nil {
    return err
    // or handle err, but beware that instance is nil
}
instance.SetLabel("mark", "SomeCarMark")
instance.SetLabel("color", "red")
instance.SetLabel("style", "coupe")
// add as many labels as you like
instance.GetLabel("color") // return "red"
instance.GetLabel("owner") // returns ""
```

--------------------------------

### Example harvest.yml with password

Source: https://github.com/netapp/harvest/wiki/Pre-commit-Secret-Scanning

Example harvest.yml configuration with an uncommented password line to demonstrate Talisman's secret detection.

```yaml
cluster-01:
  datacenter: DC-01
  addr: 10.0.0.1
  auth_style: basic_auth
  username: myuser
  password: mypasw
```

--------------------------------

### EseriesMel counters YAML example

Source: https://github.com/netapp/harvest/blob/main/docs/configure-eseries.md

Example counters configuration using ^^ for instance keys and ^ for labels, with arrow renaming.

```yaml
counters:
  - ^^eventType       => event_type       # Instance key
  - ^^location        => location         # Instance key
  - ^componentType    => component_type   # Label
  - ^priority         => severity         # Label
```

--------------------------------

### Custom Transformer Example

Source: https://github.com/netapp/harvest/blob/main/third_party/mergo/README.md

A complete example showing how to create a custom transformer to merge time.Time fields. The transformer checks if the destination time is zero and sets it from the source.

```go
package main

import (
	"fmt"
	"dario.cat/mergo"
    "reflect"
    "time"
)

type timeTransformer struct {
}

func (t timeTransformer) Transformer(typ reflect.Type) func(dst, src reflect.Value) error {
	if typ == reflect.TypeOf(time.Time{}) {
		return func(dst, src reflect.Value) error {
			if dst.CanSet() {
				isZero := dst.MethodByName("IsZero")
				result := isZero.Call([]reflect.Value{})
				if result[0].Bool() {
					dst.Set(src)
				}
			}
			return nil
		}
	}
	return nil
}

type Snapshot struct {
	Time time.Time
	// ...
}

func main() {
	src := Snapshot{time.Now()}
	dest := Snapshot{}
	mergo.Merge(&dest, src, mergo.WithTransformers(timeTransformer{}))
	fmt.Println(dest)
	// Will print
	// { 2018-01-12 01:15:00 +0000 UTC m=+0.000000001 }
}
```

--------------------------------

### Basic table creation and rendering

Source: https://github.com/netapp/harvest/blob/main/third_party/olekukonko/tablewriter/README.md

Creates a table with a header and appends rows, then renders it to stdout. The output shows automatic padding and header capitalization.

```go
data := [][]string{
    []string{"A", "The Good", "500"},
    []string{"B", "The Very very Bad Man", "288"},
    []string{"C", "The Ugly", "120"},
    []string{"D", "The Gopher", "800"},
}

table := tablewriter.NewWriter(os.Stdout)
table.SetHeader([]string{"Name", "Sign", "Rating"})

for _, v := range data {
    table.Append(v)
}
table.Render() // Send output
```

--------------------------------

### Example output of harvest show system

Source: https://github.com/netapp/harvest/wiki/Troubleshooting-Harvest

Example output from running the harvest show system command, showing the ONTAP version and system details. Use this as a reference for what to include in your issue.

```text
./bin/harvest -p infinity show system
connected to infinity (NetApp Release 9.8P2: Tue Feb 16 03:49:46 UTC 2021)
[results]                             -                                   *
  [build-timestamp]                   -                          1613447386
  [is-clustered]                      -                                true
  [version]                           - NetApp Release 9.8P2: Tue Feb 16 03:49:46 UTC 2021
  [version-tuple]                     -                                   *
    [system-version-tuple]            -                                   *
      [generation]                    -                                   9
      [major]                         -                                   8
      [minor]                         -                                   0

```

--------------------------------

### Wildcard path examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

Demonstrates the use of wildcard characters * and ? in keys.

```go
child*.2               "Jack"
c?ildren.0             "Sara"
```

--------------------------------

### Example: writing values to a Matrix

Source: https://github.com/netapp/harvest/blob/main/docs/resources/matrix.md

Complete example showing how to reset a Matrix, set values using SetValueString and SetValueFloat64, add a new instance, and handle potential errors. Note that setting a negative value on an unsigned metric will overflow.

```go

if err = myMatrix.Reset(); err != nil {
    return
}
// write numbers to the matrix using the instance and the metrics we have created

// let the metric do the conversion for us
if err = speed.SetValueString(instance, "500"); err != nil {
    logger.Error(me.Prefix, "set speed value: ", err)
}
// here we ignore err since type is the metric type
length.SetValueFloat64(instance, 10000.00)

// safe to add new instances
var instance2 matrix.Instance
if instance2, err = myMatrix.NewInstance("SomeOtherCar"); err != nil {
    return err
}

// possible and safe even though speed has type Float32
length.SetValueInt64(instance2, 13000)

// possible, but will overflow since speed is unsigned
speed.SetValueInt64(instance2, -500)
```

--------------------------------

### Example yamllint warning output

Source: https://github.com/netapp/harvest/wiki/Troubleshooting-Harvest

Example output from yamllint showing a warning about too many blank lines. Warnings are fine; errors are not.

```text
harvest.yml
  64:1      warning  too many blank lines (3 > 0)  (empty-lines)
```

--------------------------------

### Create Prometheus values file and install kube-prometheus-stack

Source: https://github.com/netapp/harvest/blob/main/docs/install/k8.md

Creates a prometheus.yaml file with retention, storage, and resource settings, then adds the Prometheus community repo and installs kube-prometheus-stack into the monitoring namespace. The volume uses the default StorageClass; add storageClassName if none is marked default.

```bash
cat > prometheus.yaml <<'EOF'
prometheus:
  prometheusSpec:
    retention: 1y                 # keep one year of data
    retentionSize: 45GiB          # stop before the volume is full
    resources:
      requests:
        memory: 400Mi             # no limits
    storageSpec:                  # keep data when the pod restarts
      volumeClaimTemplate:
        spec:
          accessModes: ["ReadWriteOnce"]
          resources:
            requests:
              storage: 50Gi       # <====== adjust to your clusters
EOF

helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
helm repo update

helm install kube-prometheus-stack prometheus-community/kube-prometheus-stack \
  --namespace monitoring --create-namespace --values prometheus.yaml

```

--------------------------------

### Basic GJSON path examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

Shows how to retrieve values by object name or array index.

```go
name.last              "Anderson"
name.first             "Tom"
age                    37
children               ["Sara","Alex","Jack"]
children.0             "Sara"
children.1             "Alex"
friends.1              {"first": "Roger", "last": "Craig", "age": 68}
friends.1.first        "Roger"
```

--------------------------------

### Start containers with nerdctl compose

Source: https://github.com/netapp/harvest/blob/main/docs/install/containerd.md

Starts the containers using nerdctl compose with the combined both.yml file. Includes commands to list containers, view logs, and stop containers, along with URLs for Prometheus, Grafana, and poller metrics.

```sh
nerdctl compose -f both.yml up -d

nerdctl ps -a

CONTAINER ID    IMAGE                               COMMAND                   CREATED               STATUS    PORTS                       NAMES
bd7131291960    docker.io/grafana/grafana:latest    "/run.sh"                 About a minute ago    Up        0.0.0.0:3000->3000/tcp      grafana
f911553a14e2    docker.io/prom/prometheus:latest    "/bin/prometheus --c…"    About a minute ago    Up        0.0.0.0:9090->9090/tcp      prometheus
037a4785bfad    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15007->15007/tcp    poller_simple7_v21.11.0513
03fb951cfe26    docker.io/library/cbg:latest        "bin/poller --poller…"    59 seconds ago        Up        0.0.0.0:15025->15025/tcp    poller_simple25_v21.11.0513
049d0d65b434    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:16050->16050/tcp    poller_simple49_v21.11.0513
0b77dd1bc0ff    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:16067->16067/tcp    poller_u2_v21.11.0513
1cabd1633c6f    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15015->15015/tcp    poller_simple15_v21.11.0513
1d78c1bf605f    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15062->15062/tcp    poller_sandhya_v21.11.0513
286271eabc1d    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15010->15010/tcp    poller_simple10_v21.11.0513
29710da013d4    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:12990->12990/tcp    poller_simple1_v21.11.0513
321ae28637b6    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15020->15020/tcp    poller_simple20_v21.11.0513
39c91ae54d68    docker.io/library/cbg:latest        "bin/poller --poller…"    About a minute ago    Up        0.0.0.0:15053->15053/tcp    poller_simple-53_v21.11.0513

nerdctl logs poller_simple1_v21.11.0513
nerdctl compose -f both.yml down

# http://localhost:9090/targets   Prometheus
# http://localhost:3000           Grafana
# http://localhost:15062/metrics  Poller metrics
```

--------------------------------

### Iterate over instances with PrintKeys

Source: https://github.com/netapp/harvest/blob/main/docs/resources/matrix.md

This example shows how to iterate over all instances in a Matrix and print their keys using the GetInstances method.

```go
func PrintKeys(x *matrix.Matrix) {
    for instanceKey, _ := range x.GetInstances() {
        fmt.Println("instance key=", instanceKey)
    }
}
```

--------------------------------

### include_regex example with vol_type

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example of include_regex that exports all instances whose label 'vol_type' starts with 'flex'.

```yaml
include_regex:
  - vol_type `^flex`
# all instances, which have label "vol_type" which starts with
# "flex" will be exported
```

--------------------------------

### Check version constraints with go-version

Source: https://github.com/netapp/harvest/blob/main/third_party/go-version/README.md

Shows how to create a constraint and check if a version satisfies it.

```go
v1, err := version.NewVersion("1.2")

// Constraints example.
constraints, err := version.NewConstraint(">= 1.0, < 1.4")
if constraints.Check(v1) {
	fmt.Printf("%s satisfies constraints %s", v1, constraints)
}
```

--------------------------------

### Start Grafana directly with nohup

Source: https://github.com/netapp/harvest/blob/main/docs/quickstart.md

Alternative to using a service file: starts Grafana in the background with nohup, redirecting output to grafana.log. Useful for testing before creating a service file.

```bash
nohup ${HARVEST_INSTALL_PATH}/grafana-${GRAFANA_VERSION}/bin/grafana-server --config=${HARVEST_INSTALL_PATH}/grafana-${GRAFANA_VERSION}/conf/defaults.ini --homepath=${HARVEST_INSTALL_PATH}/grafana-${GRAFANA_VERSION} > grafana.log 2>&1 &
```

--------------------------------

### Install Podman packages on RHEL 8

Source: https://github.com/netapp/harvest/blob/main/docs/install/podman.md

Removes Docker CE and installs Podman and related packages using the container-tools module. Requires sudo and an up-to-date OS.

```bash
sudo yum remove docker-ce
sudo yum module enable -y container-tools:rhel8
sudo yum module install -y container-tools:rhel8
sudo yum install podman podman-docker podman-plugins
```

--------------------------------

### Query examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

Demonstrates querying arrays with comparison and pattern matching operators.

```go
friends.#(last=="Murphy").first     "Dale"
friends.#(last=="Murphy")#.first    ["Dale","Jane"]
friends.#(age>45)#.last             ["Craig","Murphy"]
friends.#(first%"D*").last          "Murphy"
friends.#(first!%"D*").last         "Craig"
```

--------------------------------

### Install Harvest with specific release tag

Source: https://github.com/netapp/harvest/blob/main/docs/install/k8.md

Installs Harvest with a specific release tag. Release tags end in -1, for example 26.08.0-1.

```bash
helm install harvest ./deploy/helm/harvest --namespace harvest --values values.yaml \
  --set image.tag=<release-tag>
```

--------------------------------

### Start poller with only one collector

Source: https://github.com/netapp/harvest/wiki/Troubleshooting-Harvest

Use the --collectors and --objects flags to start a single collector-object pair for troubleshooting. This example starts only the ZapiPerf collector with the SystemNode object. To find the correct object name, check the conf/COLLECTOR/default.yaml file of the collector.

```bash
harvest start my_poller --collectors ZapiPerf --objects SystemNode
```

--------------------------------

### Get a JSON value with gjson.Get

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

This example retrieves the value at the path "name.last" from a JSON string and prints it. The output is "Prichard".

```go
package main

import "github.com/netapp/harvest/v2/third_party/tidwall/gjson"


const json = `{"name":{"first":"Janet","last":"Prichard"},"age":47}`

func main() {
	value := gjson.Get(json, "name.last")
	println(value.String())
}
```

--------------------------------

### bin/harvest status Output for Port Range

Source: https://github.com/netapp/harvest/blob/main/docs/prometheus-exporter.md

Shows the output of bin/harvest status after starting the pollers from the port range example. Disabled pollers are skipped and their ports are not assigned.

```text
  Datacenter  |    Poller    | PID  | PromPort |  Status     
--------------+--------------+------+----------+----------
  dc-01       | cluster-01   | 2339 |          | disabled  
  dc-01       | cluster-02   | 2343 |  2001    | running  
  dc-01       | cluster-03   | 2351 |  2002    | running  
...
  dc-01       | cluster-14   | 2405 |  2013    | running  
  dc-01       | cluster-15   | 2502 |  2014    | running  
  dc-01       | cluster-16   | 2514 |  2015    | running  
```

--------------------------------

### GJSON Dot vs Pipe Path Examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

Examples comparing the dot (.) and pipe (|) separators in GJSON paths. They return the same results in most cases, but differ after the # character for arrays and queries. The output shows the result for each path.

```go
friends.0.first                     "Dale"
friends|0.first                     "Dale"
friends.0|first                     "Dale"
friends|0|first                     "Dale"
friends|#                           3
friends.#                           3
friends.#(last="Murphy")#           [{"first": "Dale", "last": "Murphy", "age": 44},{"first": "Jane", "last": "Murphy", "age": 47}]
friends.#(last="Murphy")#.first     ["Dale","Jane"]
friends.#(last="Murphy")#|first     <non-existent>
friends.#(last="Murphy")#.0         []
friends.#(last="Murphy")#|0         {"first": "Dale", "last": "Murphy", "age": 44}
friends.#(last="Murphy")#.#         []
friends.#(last="Murphy")#|#         2
```

--------------------------------

### Rotate in response to SIGHUP example

Source: https://github.com/netapp/harvest/blob/main/vendor/gopkg.in/natefinch/lumberjack.v2/README.md

Example of how to rotate logs in response to SIGHUP. Sets the logger as the output for the standard log package, creates a channel for SIGHUP signals, and runs a goroutine that calls Rotate on each signal.

```go
l := &lumberjack.Logger{}
log.SetOutput(l)
c := make(chan os.Signal, 1)
signal.Notify(c, syscall.SIGHUP)

go func() {
    for {
        <-c
        l.Rotate()
    }
}()
```

--------------------------------

### Resulting poller order

Source: https://github.com/netapp/harvest/blob/main/docs/configure-harvest-basic.md

At runtime, all files are read and combined into a single configuration. The example above results in the following set of pollers in this order. When using glob patterns, the list of matching paths is sorted before reading. Errors are logged for duplicate pollers and Harvest refuses to start.

```yaml
- u2
- ntap3
- ntap4
- ntap5
- ntap1
- ntap2

```

--------------------------------

### Simple Parse and Get - Equivalent GJSON Calls

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/README.md

Three equivalent ways to retrieve the 'last' name from a JSON string using GJSON. The first uses Parse and two Get calls, the second uses Get with a chained Get, and the third uses Get with a dot-notation path.

```go
gjson.Parse(json).Get("name").Get("last")
gjson.Get(json, "name").Get("last")
gjson.Get(json, "name.last")
```

--------------------------------

### Match pattern matching examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/match/README.md

Shows how to use the Match function with different patterns. '*' matches any number of characters and '?' matches exactly one character.

```go
match.Match("hello", "*llo") 
match.Match("jello", "?ello") 
match.Match("hello", "h*o") 
```

--------------------------------

### Reload systemd and start Grafana service

Source: https://github.com/netapp/harvest/blob/main/docs/quickstart.md

Reloads the systemd daemon, enables Grafana to start on boot, and starts the Grafana service.

```bash
sudo systemctl daemon-reload
sudo systemctl enable grafana
sudo systemctl start grafana
```

--------------------------------

### JSON for tilde examples

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

The JSON payload used for tilde comparison examples.

```json
{
  "vals": [
    { "a": 1, "b": "data" },
    { "a": 2, "b": true },
    { "a": 3, "b": false },
    { "a": 4, "b": "0" },
    { "a": 5, "b": 0 },
    { "a": 6, "b": "1" },
    { "a": 7, "b": 1 },
    { "a": 8, "b": "true" },
    { "a": 9, "b": false },
    { "a": 10, "b": null },
    { "a": 11 }
  ]
}
```

--------------------------------

### include_equals example

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example including instances with label vol_type equal to flexgroup_constituent.

```yaml
include_equals:
  - vol_type `flexgroup_constituent`
# all instances, which have label "vol_type" with value
# "flexgroup_constituent" will be exported
```

--------------------------------

### exclude_contains example

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example excluding instances with label vol_type containing flexgroup_.

```yaml
exclude_contains:
  - vol_type `flexgroup_`
# all instances, which have label "vol_type" which contain
# "flexgroup_" will not be exported
```

--------------------------------

### exclude_equals example

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example excluding instances with label vol_type equal to flexgroup_constituent.

```yaml
exclude_equals:
  - vol_type `flexgroup_constituent`
# all instances, which have label "vol_type" with value
# "flexgroup_constituent" will not be exported
```

--------------------------------

### Start poller and verify HTTPS URL in logs

Source: https://github.com/netapp/harvest/blob/main/docs/prometheus-exporter.md

Starts the poller with bin/harvest start -f my-cluster. The log line shows the exporter URL as https://localhost:16001/metrics, indicating TLS is active.

```bash
bin/harvest start -f my-cluster
2023-06-23T10:02:03-04:00 INF prometheus/httpd.go:40 > server listen Poller=my-cluster exporter=my-exporter url=https://localhost:16001/metrics
```

--------------------------------

### Enable HTTP service discovery in Harvest

Source: https://github.com/netapp/harvest/blob/main/docs/prometheus-exporter.md

Add this to harvest.yml to start an HTTP service discovery endpoint on 0.0.0.0:8887. Use 127.0.0.1:<port> to listen only on localhost. Start the SD process with 'bin/harvest admin start'.

```yaml
Admin:
  httpsd:
    listen: :8887
```

--------------------------------

### Nested query example

Source: https://github.com/netapp/harvest/blob/main/third_party/tidwall/gjson/SYNTAX.md

Demonstrates nested queries.

```go
friends.#(nets.#(=="fb"))#.first  >> ["Dale","Roger"]
```

--------------------------------

### exclude_regex example

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example excluding instances with label vol_type matching the regular expression ^flex.

```yaml
exclude_regex:
  - vol_type `^flex`
# all instances, which have label "vol_type" which starts with
# "flex" will not be exported
```

--------------------------------

### EseriesMel metric example output

Source: https://github.com/netapp/harvest/blob/main/docs/configure-eseries.md

Example of the `eseries_mel_events` metric output with labels and timestamp value.

```text
eseries_mel_events{datacenter="rtp",management_version="11.90",array="VolumeBlockSizes1",chassis_serial="1111111111",component_type="drive",event_type="8812",location="Tray 1, Slot 5",message="MEL_EV_CFG_DRIVE_FAILURE",severity="critical"} 1788274734
```

--------------------------------

### include_contains example with vol_type

Source: https://github.com/netapp/harvest/blob/main/docs/plugins.md

Example of include_contains that exports all instances whose label 'vol_type' contains 'flexgroup_'.

```yaml
include_contains:
  - vol_type `flexgroup_`
# all instances, which have label "vol_type" which contain
# "flexgroup_" will be exported
```

--------------------------------

### Render table into a string using strings.Builder

Source: https://github.com/netapp/harvest/blob/main/third_party/olekukonko/tablewriter/README.md

Shows how to render a table into a string instead of stdout by using strings.Builder, which implements io.Writer. The example includes a placeholder comment for filling the table.

```go
package main

import (
    "strings"
    "fmt"

    "github.com/olekukonko/tablewriter"
)

func main() {
    tableString := &strings.Builder{}
    table := tablewriter.NewWriter(tableString)

    /*
     * Code to fill the table
     */

    table.Render()

    fmt.Println(tableString.String())
}
```

--------------------------------

### Example: Add metrics to Matrix

Source: https://github.com/netapp/harvest/blob/main/docs/resources/matrix.md

Creates a uint64 metric for max speed and a float64 metric for length. Each NewMetric call returns an error if the key is not unique.

```go
var (
    speed, length matrix.Metric
    err error
)

if speed, err = myMatrix.NewMetricUint64("max_speed"); err != nil {
    return err
}
if length, err = myMatrix.NewMetricFloat64("length_in_mm"); err != nil {
    return err
}
```
Tokens:
Raw