Scrutiny¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Scrutiny is a hard drive health monitoring tool that tracks S.M.A.R.T. metrics for your drives.
Deployment¶
sb install scrutiny
Usage¶
Visit https://scrutiny.iYOUR_DOMAIN_NAMEi.
Basics¶
Scrutiny monitors hard drive health using S.M.A.R.T. metrics. The omnibus container includes WebUI, Collector, and InfluxDB. It automatically detects drives, collects metrics, and displays health status with historical tracking. Data persists in /opt/scrutiny/.
The container runs in privileged mode to access hardware S.M.A.R.T. data. Configuration is largely zero-config with settings available through the web interface.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
Example override
scrutiny_name: "custom_value"Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likescrutiny_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.Instead, use the corresponding
_customvariable (likescrutiny_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
scrutiny_name
# Type: string
scrutiny_name: scrutiny
scrutiny_role_web_subdomain
# Type: string
scrutiny_role_web_subdomain: "{{ scrutiny_name }}"
scrutiny_role_web_domain
# Type: string
scrutiny_role_web_domain: "{{ user.domain }}"
scrutiny_role_web_port
# Type: string
scrutiny_role_web_port: "8080"
scrutiny_role_web_url
# Type: string
scrutiny_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='scrutiny') + '.' + lookup('role_var', '_web_domain', role='scrutiny')
if (lookup('role_var', '_web_subdomain', role='scrutiny') | length > 0)
else lookup('role_var', '_web_domain', role='scrutiny')) }}"
scrutiny_role_dns_record
# Type: string
scrutiny_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='scrutiny') }}"
scrutiny_role_dns_zone
# Type: string
scrutiny_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='scrutiny') }}"
scrutiny_role_dns_proxy
# Type: bool (true/false)
scrutiny_role_dns_proxy: "{{ dns_proxied }}"
scrutiny_role_traefik_sso_middleware
# Type: string
scrutiny_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
scrutiny_role_traefik_middleware_default
# Type: string
scrutiny_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
scrutiny_role_traefik_middleware_custom
# Type: string
scrutiny_role_traefik_middleware_custom: ""
scrutiny_role_traefik_certresolver
# Type: string
scrutiny_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
scrutiny_role_traefik_enabled
# Type: bool (true/false)
scrutiny_role_traefik_enabled: true
Container
scrutiny_role_docker_container
# Type: string
scrutiny_role_docker_container: "{{ scrutiny_name }}"
Image
scrutiny_role_docker_image_pull
# Type: bool (true/false)
scrutiny_role_docker_image_pull: true
scrutiny_role_docker_image_repo
# Type: string
scrutiny_role_docker_image_repo: "ghcr.io/analogj/scrutiny"
scrutiny_role_docker_image_tag
# Type: string
scrutiny_role_docker_image_tag: "master-omnibus"
scrutiny_role_docker_image
# Type: string
scrutiny_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='scrutiny') }}:{{ lookup('role_var', '_docker_image_tag', role='scrutiny') }}"
Envs
scrutiny_role_docker_envs_default
# Type: dict
scrutiny_role_docker_envs_default:
TZ: "{{ tz }}"
scrutiny_role_docker_envs_custom
# Type: dict
scrutiny_role_docker_envs_custom: {}
Volumes
scrutiny_role_docker_volumes_default
# Type: list
scrutiny_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='scrutiny') }}/scrutiny:/opt/scrutiny/config"
- "{{ lookup('role_var', '_paths_location', role='scrutiny') }}/influxdb:/opt/scrutiny/influxdb"
- "/run/udev:/run/udev:ro"
scrutiny_role_docker_volumes_custom
# Type: list
scrutiny_role_docker_volumes_custom: []
Hostname
scrutiny_role_docker_hostname
# Type: string
scrutiny_role_docker_hostname: "{{ scrutiny_name }}"
Networks
scrutiny_role_docker_networks_alias
# Type: string
scrutiny_role_docker_networks_alias: "{{ scrutiny_name }}"
scrutiny_role_docker_networks_default
# Type: list
scrutiny_role_docker_networks_default: []
scrutiny_role_docker_networks_custom
# Type: list
scrutiny_role_docker_networks_custom: []
Restart Policy
scrutiny_role_docker_restart_policy
# Type: string
scrutiny_role_docker_restart_policy: unless-stopped
State
scrutiny_role_docker_state
# Type: string
scrutiny_role_docker_state: started
Privileged
scrutiny_role_docker_privileged
# Type: bool (true/false)
scrutiny_role_docker_privileged: true
The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module
Resource Limits
scrutiny_role_docker_blkio_weight
# Type: int
scrutiny_role_docker_blkio_weight:
scrutiny_role_docker_cpu_period
# Type: int
scrutiny_role_docker_cpu_period:
scrutiny_role_docker_cpu_quota
# Type: int
scrutiny_role_docker_cpu_quota:
scrutiny_role_docker_cpu_shares
# Type: int
scrutiny_role_docker_cpu_shares:
scrutiny_role_docker_cpus
# Type: string
scrutiny_role_docker_cpus:
scrutiny_role_docker_cpuset_cpus
# Type: string
scrutiny_role_docker_cpuset_cpus:
scrutiny_role_docker_cpuset_mems
# Type: string
scrutiny_role_docker_cpuset_mems:
scrutiny_role_docker_kernel_memory
# Type: string
scrutiny_role_docker_kernel_memory:
scrutiny_role_docker_memory
# Type: string
scrutiny_role_docker_memory:
scrutiny_role_docker_memory_reservation
# Type: string
scrutiny_role_docker_memory_reservation:
scrutiny_role_docker_memory_swap
# Type: string
scrutiny_role_docker_memory_swap:
scrutiny_role_docker_memory_swappiness
# Type: int
scrutiny_role_docker_memory_swappiness:
scrutiny_role_docker_shm_size
# Type: string
scrutiny_role_docker_shm_size:
Security & Devices
scrutiny_role_docker_cap_drop
# Type: list
scrutiny_role_docker_cap_drop:
scrutiny_role_docker_cgroupns_mode
# Type: string
scrutiny_role_docker_cgroupns_mode:
scrutiny_role_docker_device_cgroup_rules
# Type: list
scrutiny_role_docker_device_cgroup_rules:
scrutiny_role_docker_device_read_bps
# Type: list
scrutiny_role_docker_device_read_bps:
scrutiny_role_docker_device_read_iops
# Type: list
scrutiny_role_docker_device_read_iops:
scrutiny_role_docker_device_requests
# Type: list
scrutiny_role_docker_device_requests:
scrutiny_role_docker_device_write_bps
# Type: list
scrutiny_role_docker_device_write_bps:
scrutiny_role_docker_device_write_iops
# Type: list
scrutiny_role_docker_device_write_iops:
scrutiny_role_docker_devices
# Type: list
scrutiny_role_docker_devices:
scrutiny_role_docker_devices_default
# Type: string
scrutiny_role_docker_devices_default:
scrutiny_role_docker_groups
# Type: list
scrutiny_role_docker_groups:
scrutiny_role_docker_security_opts
# Type: list
scrutiny_role_docker_security_opts:
scrutiny_role_docker_user
# Type: string
scrutiny_role_docker_user:
scrutiny_role_docker_userns_mode
# Type: string
scrutiny_role_docker_userns_mode:
Networking
scrutiny_role_docker_dns_opts
# Type: list
scrutiny_role_docker_dns_opts:
scrutiny_role_docker_dns_search_domains
# Type: list
scrutiny_role_docker_dns_search_domains:
scrutiny_role_docker_dns_servers
# Type: list
scrutiny_role_docker_dns_servers:
scrutiny_role_docker_domainname
# Type: string
scrutiny_role_docker_domainname:
scrutiny_role_docker_exposed_ports
# Type: list
scrutiny_role_docker_exposed_ports:
scrutiny_role_docker_hosts
# Type: dict
scrutiny_role_docker_hosts:
scrutiny_role_docker_hosts_use_common
# Type: bool (true/false)
scrutiny_role_docker_hosts_use_common:
scrutiny_role_docker_ipc_mode
# Type: string
scrutiny_role_docker_ipc_mode:
scrutiny_role_docker_links
# Type: list
scrutiny_role_docker_links:
scrutiny_role_docker_network_mode
# Type: string
scrutiny_role_docker_network_mode:
scrutiny_role_docker_pid_mode
# Type: string
scrutiny_role_docker_pid_mode:
scrutiny_role_docker_ports
# Type: list
scrutiny_role_docker_ports:
scrutiny_role_docker_uts
# Type: string
scrutiny_role_docker_uts:
Storage
scrutiny_role_docker_keep_volumes
# Type: bool (true/false)
scrutiny_role_docker_keep_volumes:
scrutiny_role_docker_mounts
# Type: list
scrutiny_role_docker_mounts:
scrutiny_role_docker_storage_opts
# Type: dict
scrutiny_role_docker_storage_opts:
scrutiny_role_docker_tmpfs
# Type: list
scrutiny_role_docker_tmpfs:
scrutiny_role_docker_volume_driver
# Type: string
scrutiny_role_docker_volume_driver:
scrutiny_role_docker_volumes_from
# Type: list
scrutiny_role_docker_volumes_from:
scrutiny_role_docker_volumes_global
# Type: bool (true/false)
scrutiny_role_docker_volumes_global:
scrutiny_role_docker_working_dir
# Type: string
scrutiny_role_docker_working_dir:
Monitoring & Lifecycle
scrutiny_role_docker_auto_remove
# Type: bool (true/false)
scrutiny_role_docker_auto_remove:
scrutiny_role_docker_cleanup
# Type: bool (true/false)
scrutiny_role_docker_cleanup:
scrutiny_role_docker_force_kill
# Type: string
scrutiny_role_docker_force_kill:
scrutiny_role_docker_healthcheck
# Type: dict
scrutiny_role_docker_healthcheck:
scrutiny_role_docker_healthy_wait_timeout
# Type: int
scrutiny_role_docker_healthy_wait_timeout:
scrutiny_role_docker_init
# Type: bool (true/false)
scrutiny_role_docker_init:
scrutiny_role_docker_kill_signal
# Type: string
scrutiny_role_docker_kill_signal:
scrutiny_role_docker_log_driver
# Type: string
scrutiny_role_docker_log_driver:
scrutiny_role_docker_log_options
# Type: dict
scrutiny_role_docker_log_options:
scrutiny_role_docker_oom_killer
# Type: bool (true/false)
scrutiny_role_docker_oom_killer:
scrutiny_role_docker_oom_score_adj
# Type: int
scrutiny_role_docker_oom_score_adj:
scrutiny_role_docker_output_logs
# Type: bool (true/false)
scrutiny_role_docker_output_logs:
scrutiny_role_docker_paused
# Type: bool (true/false)
scrutiny_role_docker_paused:
scrutiny_role_docker_recreate
# Type: bool (true/false)
scrutiny_role_docker_recreate:
scrutiny_role_docker_restart_retries
# Type: int
scrutiny_role_docker_restart_retries:
scrutiny_role_docker_stop_timeout
# Type: int
scrutiny_role_docker_stop_timeout:
Other Options
scrutiny_role_docker_capabilities
# Type: list
scrutiny_role_docker_capabilities:
scrutiny_role_docker_cgroup_parent
# Type: string
scrutiny_role_docker_cgroup_parent:
scrutiny_role_docker_commands
# Type: list
scrutiny_role_docker_commands:
scrutiny_role_docker_create_timeout
# Type: int
scrutiny_role_docker_create_timeout:
scrutiny_role_docker_entrypoint
# Type: string
scrutiny_role_docker_entrypoint:
scrutiny_role_docker_env_file
# Type: string
scrutiny_role_docker_env_file:
scrutiny_role_docker_labels
# Type: dict
scrutiny_role_docker_labels:
scrutiny_role_docker_labels_use_common
# Type: bool (true/false)
scrutiny_role_docker_labels_use_common:
scrutiny_role_docker_read_only
# Type: bool (true/false)
scrutiny_role_docker_read_only:
scrutiny_role_docker_runtime
# Type: string
scrutiny_role_docker_runtime:
scrutiny_role_docker_sysctls
# Type: list
scrutiny_role_docker_sysctls:
scrutiny_role_docker_ulimits
# Type: list
scrutiny_role_docker_ulimits:
scrutiny_role_autoheal_enabled
# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
scrutiny_role_autoheal_enabled: true
scrutiny_role_depends_on
# List of container dependencies that must be running before the container start
# Type: string
scrutiny_role_depends_on: ""
scrutiny_role_depends_on_delay
# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
scrutiny_role_depends_on_delay: "0"
scrutiny_role_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
scrutiny_role_depends_on_healthchecks:
scrutiny_role_diun_enabled
# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
scrutiny_role_diun_enabled: true
scrutiny_role_dns_enabled
# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
scrutiny_role_dns_enabled: true
scrutiny_role_docker_controller
# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
scrutiny_role_docker_controller: true
scrutiny_role_docker_image_repo
# Type: string
scrutiny_role_docker_image_repo:
scrutiny_role_docker_image_tag
# Type: string
scrutiny_role_docker_image_tag:
scrutiny_role_docker_volumes_download
# Type: bool (true/false)
scrutiny_role_docker_volumes_download:
scrutiny_role_paths_location
# Type: string
scrutiny_role_paths_location:
scrutiny_role_themepark_addons
# Type: string
scrutiny_role_themepark_addons:
scrutiny_role_themepark_app
# Type: string
scrutiny_role_themepark_app:
scrutiny_role_themepark_theme
# Type: string
scrutiny_role_themepark_theme:
scrutiny_role_traefik_api_endpoint
# Type: dict/omit
scrutiny_role_traefik_api_endpoint:
scrutiny_role_traefik_api_middleware
# Type: string
scrutiny_role_traefik_api_middleware:
scrutiny_role_traefik_api_middleware_http
# Type: string
scrutiny_role_traefik_api_middleware_http:
scrutiny_role_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
scrutiny_role_traefik_autodetect_enabled: false
scrutiny_role_traefik_certresolver
# Type: string
scrutiny_role_traefik_certresolver:
scrutiny_role_traefik_crowdsec_enabled
# Enable CrowdSec middleware for the container
# Type: bool (true/false)
scrutiny_role_traefik_crowdsec_enabled: false
scrutiny_role_traefik_error_pages_enabled
# Enable custom error pages middleware for the container
# Type: bool (true/false)
scrutiny_role_traefik_error_pages_enabled: false
scrutiny_role_traefik_gzip_enabled
# Enable gzip compression middleware for the container
# Type: bool (true/false)
scrutiny_role_traefik_gzip_enabled: false
scrutiny_role_traefik_middleware_http
# Type: string
scrutiny_role_traefik_middleware_http:
scrutiny_role_traefik_middleware_http_api_insecure
# Type: bool (true/false)
scrutiny_role_traefik_middleware_http_api_insecure:
scrutiny_role_traefik_middleware_http_insecure
# Type: bool (true/false)
scrutiny_role_traefik_middleware_http_insecure:
scrutiny_role_traefik_priority
# Type: string
scrutiny_role_traefik_priority:
scrutiny_role_traefik_robot_enabled
# Enable robots.txt middleware for the container
# Type: bool (true/false)
scrutiny_role_traefik_robot_enabled: true
scrutiny_role_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
scrutiny_role_traefik_tailscale_enabled: false
scrutiny_role_traefik_wildcard_enabled
# Enable wildcard certificate for the container
# Type: bool (true/false)
scrutiny_role_traefik_wildcard_enabled: true
scrutiny_role_web_domain
# Type: string
scrutiny_role_web_domain:
scrutiny_role_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
scrutiny_role_web_fqdn_override:
Example Override
scrutiny_role_web_fqdn_override:
- "{{ traefik_host }}"
- "scrutiny2.{{ user.domain }}"
- "scrutiny.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
scrutiny_role_web_host_override
# Override the Traefik web host configuration for the container
# Type: string
scrutiny_role_web_host_override:
Example Override
scrutiny_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'scrutiny2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
scrutiny_role_web_http_port
# Type: string (quoted number)
scrutiny_role_web_http_port:
scrutiny_role_web_http_scheme
# Type: string ("http"/"https")
scrutiny_role_web_http_scheme:
scrutiny_role_web_http_serverstransport
# Type: dict/omit
scrutiny_role_web_http_serverstransport:
scrutiny_role_web_scheme
# URL scheme to use for web access to the container
# Type: string ("http"/"https")
scrutiny_role_web_scheme:
scrutiny_role_web_serverstransport
# Type: dict/omit
scrutiny_role_web_serverstransport:
scrutiny_role_web_subdomain
# Type: string
scrutiny_role_web_subdomain: