Alert Thresholds

Language:

Thresholds can be set to create custom alert watches. The following table lists typical properties for managing an alert threshold. For a complete reference, see the CLI help.

Table 7 Alert Thresholds

Property	Type	Description
`uuid`	Default	Unique identifier for the watch (“immutable”)
`statname`	AnalyticsStatistics	Statistic to watch [“cpu.utilization”, “arc.accesses”, “arc.size”, “arc.l2_bytes”, “arc.l2_accesses”, “arc.l2_size”, “syscap.bytesused”, “syscap.percentused”, “metacap.bytesused”, “metacap.percentused”, “repl.bytes”, “repl.ops”, “shadow.kilobytes”, “shadow.ops”, “shadow.requests”, “io.bytes”, “io.ops”, “datalink.kilobytes”, “nic.kilobytes”, “net.kilobytes”, “ftp.kilobytes”, “fc.bytes”, “fc.ops”, “http.reqs”, “ndmp.bytes”, “ndmp.diskkb”, “ndmp.ops”, “nfs2.bytes”, “nfs2.ops”, “nfs3.bytes”, “nfs3.ops”, “nfs4.bytes”, “nfs4.ops”, "nfs4-1.bytes", "nfs4-1.ops", “sftp.kilobytes”, “smb.ops”, “srp.bytes”, “srp.ops”, “iscsi.bytes”, “iscsi.ops”]
`type`	ChooseOne	Whether to post alert when the stat exceeds the limit (normal) or falls below the limit (inverted) [“normal”, “inverted”]
`limit`	PositiveInteger	Limit value for the statistic
`minpost`	Duration	Minimum time condition must hold before posting alert
`days`	ChooseOne	Only post alert on particular days [“all”, “weekdays”, “weekends”]
`window_start`	TimeOfDay	Only post alerts between window_start and window_end [“none”, “00:00”, “00:30”, “01:00”, “01:30”, “02:00”, “02:30”, “03:00”, “03:30”, “04:00”, “04:30”, “05:00”, “05:30”, “06:00”, “06:30”, “07:00”, “07:30”, “08:00”, “08:30”, “09:00”, “09:30”, “10:00”, “10:30”, “11:00”, “11:30”, “12:00”, “12:30”, “13:00”, “13:30”, “14:00”, “14:30”, “15:00”, “15:30”, “16:00”, “16:30”, “17:00”, “17:30”, “18:00”, “18:30”, “19:00”, “19:30”, “20:00”, “20:30”, “21:00”, “21:30”, “22:00”, “22:30”, “23:00”, “23:30”]
`window_end`	TimeOfDay	Only post alerts between window_start and window_end [“none”, “00:00”, “00:30”, “01:00”, “01:30”, “02:00”, “02:30”, “03:00”, “03:30”, “04:00”, “04:30”, “05:00”, “05:30”, “06:00”, “06:30”, “07:00”, “07:30”, “08:00”, “08:30”, “09:00”, “09:30”, “10:00”, “10:30”, “11:00”, “11:30”, “12:00”, “12:30”, “13:00”, “13:30”, “14:00”, “14:30”, “15:00”, “15:30”, “16:00”, “16:30”, “17:00”, “17:30”, “18:00”, “18:30”, “19:00”, “19:30”, “20:00”, “20:30”, “21:00”, “21:30”, “22:00”, “22:30”, “23:00”, “23:30”] (“immutable”)
`frequency`	Duration	Minimum time before reposting an alert
`minclear`	Duration	Minimum time of normality before reposting “all clear” alert

List Alert Thresholds

Lists all of the configured alert thresholds.

Example Request:

GET /api/alert/v1/thresholds HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfs-storage.example.com:215
Accept: application/json

Example Response:

HTTP/1.1 200 OK
Date: Tue, 27 Aug 2013 17:38:40 GMT
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 689

{
    "thresholds": [
        {
            "days": "all",
            "frequency": 300,
            "href": "/api/alert/v1/thresholds/
                     bec758cb-346e-6a7d-c211-b320c09ef6a6",
            "limit": 500,
            "minclear": 300,
            "minpost": 300,
            "statname": "cpu.utilization",
            "threshold": "threshold-000",
            "type": "normal",
            "uuid": "bec758cb-346e-6a7d-c211-b320c09ef6a6",
            "window_end": 0,
            "window_start": -1
        },
        {
            "days": "all",
            "frequency": 300,
            "href": "/api/alert/v1/thresholds/
                     475799d8-32c8-6ff6-882c-aa3b66e3a5a2",
            "limit": 100000,
            "minclear": 600,
            "minpost": 300,
            "statname": "datalink.kilobytes",
            "threshold": "threshold-001",
            "type": "normal",
            "uuid": "475799d8-32c8-6ff6-882c-aa3b66e3a5a2",
            "window_end": 300,
            "window_start": 1200
        }
    ]
}

Get Alert Threshold

Lists the properties for a single alert threshold.

Example Request:

GET /api/alert/v1/thresholds/1b15d405-75c4-4c0c-e0f6-8a108165b874
    HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfs-storage.example.com:215
Accept: application/json

Example Result:

HTTP/1.1 200 OK
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 363

{
    "threshold": {
        "days": "weekdays",
        "frequency": 300,
        "href": "/api/alert/v1/thresholds/
                 1b15d405-75c4-4c0c-e0f6-8a108165b874",
        "limit": 100000,
        "minclear": 300,
        "minpost": 300,
        "statname": "datalink.kilobytes",
        "type": "normal",
        "uuid": "1b15d405-75c4-4c0c-e0f6-8a108165b874",
        "window_end": 0,
        "window_start": -1
    }
}

Create Alert Threshold

Creates an alert threshold.

Example Request:

POST /api/alert/v1/thresholds HTTP/1.1
Host: zfs-storage.example.com
X-Auth-User: root
X-Auth-Key: password
Content-Type: application/json
Content-Length: 50

{"statname": "datalink.kilobytes", "limit": 100000}

Example Response:

HTTP/1.1 201 Created
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 321
Location: /api/alert/v1/thresholds
          /1b15d405-75c4-4c0c-e0f6-8a108165b874

{
    "threshold": {
        "href": "/api/alert/v1/alerts/thresholds
                 /1b15d405-75c4-4c0c-e0f6-8a108165b874",
        ...
    }
}

Modify Alert Threshold

Modifies any of the properties for the specified alert threshold.

Example Request:

PUT /api/alert/v1/thresholds/1b15d405-75c4-4c0c-e0f6-8a108165b874
    HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfs-storage.example.com:215

{"days":"weekdays"}

Example Response:

HTTP/1.1 202 Accepted
X-Zfssa-Appliance-Api: 1.0
Content-Type: application/json
Content-Length: 326

{
    "threshold": {
        "days": "weekdays",
        ...
    }
}

Delete Alert Threshold

Delete the specified alert threshold.

Example Request:

DELETE /api/alert/v1/thresholds/475799d8-32c8-6ff6-882c-aa3b66e3a5a2
       HTTP/1.1
Authorization: Basic abcd123MWE=
Host: zfs-storage.example.com:215

Example Response:

HTTP/1.1 204 No Content
X-Zfssa-Appliance-Api: 1.0