Hardware Sentry Configuration
Hardware Sentry configuration file
*hws-config*.yaml*hws-config*.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
*hws-config*.yaml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
collectPeriod | oneOf | — |
disableAlerts | boolean | Disables Hardware Sentry's alerts for all the monitored hosts (Default: false). default: false |
discoveryCycle | integer | Sets the cycle that Hardware Sentry uses to perform discoveries and detect new components in your monitored environment. By default, Hardware Sentry runs a discovery after 30 collects. default: "30" |
exporter | object | Sets Hardware Sentry's internal Exporter configuration. |
exporter.otlp | anyOf | Overrides Hardware Sentry's internal OTLP Exporter configuration. |
extraLabels | object | — |
extraMetrics | object | Adds additional static metrics to be exposed by Hardware Sentry. |
hardwareProblemTemplate | string | — default: "Hardware problem on \\${FQDN\\} with… |
hosts | array<object> | Configures the hosts to monitor. |
jobPoolSize | integer | Sets the number of jobs that Hardware Sentry can run simultaneously (Default: 20). default: "20" |
loggerLevel | string | — default: "off"one of: "all", "trace", "debug", "info", "warn", "error" … (+2) |
otelCollector | object | Customizes the OpenTelemetry Collector sub-process. |
otelCollector.commandLine | array<string> | Overrides the OpenTelemetry Collector command line. |
otelCollector.environment | object | — |
otelCollector.output | string | Configures where to print the OpenTelemetry Collector's output (Default: log). default: "log"one of: "log", "console", "silent" |
otelCollector.workingDir | string | Configures the working directory of the OpenTelemetry Collector. |
otelCollector.disabled | boolean | Disables the OpenTelemetry Collector (Default: false). default: false |
outputDirectory | string | — default: "logs" |
resolveHostnameToFqdn | boolean | Displays the configured hostname in the Host Resource `host.name` attribute instead of the resolved FQDN (Default: false). default: false |
sequential | boolean | — default: false |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- Has 10 place(s) where keywords sit beside
$ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at#/properties/collectPeriod. - 94 properties, 97% carrying a description, max nesting depth 16.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
anyOf | JSON Schema Core, draft 2020-12 | §10.2.1.2 — "anyOf" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
patternProperties | JSON Schema Core, draft 2020-12 | §10.3.2.2 — "patternProperties" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
propertyNames | JSON Schema Core, draft 2020-12 | §10.3.2.4 — "propertyNames" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.