Disk Alerts Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/prometheus/$defs/diskAlerts

Definitions for disk alerts.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	config/schemas/config.yaml*

TYPE:

object (Disk Alerts)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
storage	`object`	Optional	cannot be null	Welkin Apps Config
inode	`object`	Optional	cannot be null	Welkin Apps Config
patternRules	`array`	Optional	cannot be null	Welkin Apps Config
patternRule	`object`	Optional	cannot be null	Welkin Apps Config
patterns	`object`	Optional	cannot be null	Welkin Apps Config
pattern	`object`	Optional	cannot be null	Welkin Apps Config
perf	`object`	Optional	cannot be null	Welkin Apps Config
perfEnabled	`boolean`	Optional	cannot be null	Welkin Apps Config
perfQueueSizeThreshold	`number`	Optional	cannot be null	Welkin Apps Config
perfReadWaitTimeThreshold	`number`	Optional	cannot be null	Welkin Apps Config
perfWriteWaitTimeThreshold	`number`	Optional	cannot be null	Welkin Apps Config

storage¶

Configure disk alerts based on storage usage.

storage

is optional
Type: object (Disk Alerts Storage)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alerts Storage)

inode¶

Configure disk alerts based on inode usage.

inode

is optional
Type: object (Disk Alerts Inode)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alerts Inode)

patternRules¶

Configure disk alerts when disk usage is predicted to reach the limit.

patternRules

is optional
Type: object[] (Disk Alert Pattern Rule)
cannot be null
defined in: Welkin Apps Config

TYPE:

object[] (Disk Alert Pattern Rule)

patternRule¶

Configure disk alerts when disk usage is predicted to reach the limit.

The hours key is only supported when configured under predictLinear.

patternRule

is optional
Type: object (Disk Alert Pattern Rule)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alert Pattern Rule)

patterns¶

Select applicable nodes and disks to include or exclude using patterns.

patterns

is optional
Type: object (Disk Alert Patterns)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alert Patterns)

pattern¶

Select applicable nodes and disks using patterns.

pattern

is optional
Type: object (Disk Alert Pattern)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alert Pattern)

perf¶

Configure performance disk alerts.

perf

is optional
Type: object (Disk Alerts Perf)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Disk Alerts Perf)

perfEnabled¶

perfEnabled

is optional
Type: boolean (Disk Alerts Perf Enabled)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (Disk Alerts Perf Enabled)

perfQueueSizeThreshold¶

perfQueueSizeThreshold

is optional
Type: number (Disk Alerts Perf Queue Size)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Disk Alerts Perf Queue Size)

DEFAULTS:

The default value is:

0.5

perfReadWaitTimeThreshold¶

perfReadWaitTimeThreshold

is optional
Type: number (Disk Alerts Perf Read Wait)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Disk Alerts Perf Read Wait)

DEFAULTS:

The default value is:

0.01

perfWriteWaitTimeThreshold¶

perfWriteWaitTimeThreshold

is optional
Type: number (Disk Alerts Perf Write Wait)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Disk Alerts Perf Write Wait)

DEFAULTS:

The default value is:

0.1

Return to the root config schema

Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main