Hardware Sentry Configuration

Hardware Sentry configuration file

Type object
File match *hws-config*.yaml *hws-config*.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/hardware-sentry-configuration/latest.json
Source https://www.schemastore.org/hws-config.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

collectPeriod integer | string
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.

1 nested properties
otlp object | null

Overrides Hardware Sentry's internal OTLP Exporter configuration.

3 nested properties
headers object

Sets Hardware Sentry's OTLP Exporter headers, such as the Authorization header used to authenticate the Exporter with the OTLP gRPC Receiver.

trustedCertificatesFile string

Sets Hardware Sentry's OTLP Exporter trusted certificates file (Default: security/otel.crt).

Default: "security/otel.crt"
endpoint string

Configures the OTLP Receiver endpoint (Default: https://localhost:4317).

Default: "https://localhost:4317"
extraLabels object
extraMetrics object

Adds additional static metrics to be exposed by Hardware Sentry.

hardwareProblemTemplate string
Default: "Hardware problem on \${FQDN\} with \${MONITOR_NAME\}.\${NEWLINE\}\${NEWLINE\}\${ALERT_DETAILS\}\${NEWLINE\}\${NEWLINE\}\${FULLREPORT\}"
hosts 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"
Values: "all" "trace" "debug" "info" "warn" "error" "fatal" "off"
otelCollector object

Customizes the OpenTelemetry Collector sub-process.

5 nested properties
commandLine string[]

Overrides the OpenTelemetry Collector command line.

environment object
output string

Configures where to print the OpenTelemetry Collector's output (Default: log).

Default: "log"
Values: "log" "console" "silent"
workingDir string

Configures the working directory of the OpenTelemetry Collector.

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

Definitions

duration integer | string
loggerLevel string
transportProtocols string
namespace string

Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).

outputDirectory string
sequential boolean
hardwareProblemTemplate string
hostType string
keyValuePairVariables object