dotcircle.monitoring
dotcircle.monitoring.enable
Whether to enable dotcircle monitoring stack.
Type: boolean
Default:
false
Example:
true
Declared by:
dotcircle.monitoring.admin_email
Grafana default admin email address
Type: string
Default:
"admin@localhost"
Declared by:
dotcircle.monitoring.admin_password
Grafana default admin password
Type: string
Default:
"admin"
Declared by:
dotcircle.monitoring.admin_user
Grafana default admin username
Type: string
Default:
"admin"
Declared by:
dotcircle.monitoring.backend
Prometheus storage backend. Can be either ‘prometheus’ or ‘mimir’ (default).
Type: one of “mimir”, “prometheus”
Default:
"mimir"
Example:
"mimir"
Declared by:
dotcircle.monitoring.base_domain
Base domain name. Prometheus will be accessible at prometheus.$domain. Grafana will be accessible at grafana.$domain. Mimir (if used) will be accessible at mimir.$domain.
Type: string
Example:
"example.com"
Declared by:
dotcircle.monitoring.prometheus
Prometheus settings
Type: submodule
Declared by:
dotcircle.monitoring.prometheus.alertmanager
Alertmanager config.
Type: submodule
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.alertmanager.extraConfig
Extra alertmanager configuration. To be merged with the default one.
Type: attribute set
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver
Alertmanager receiver configuration
Type: submodule
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.discord
Discord receiver config
Type: submodule
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.discord.enable
Whether to enable Enable discord receiver.
Type: boolean
Default:
false
Example:
true
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.discord.webhook_url
Discord webhook url, as a sops secret object
Type: null or string
Default:
null
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.slack
Slack receiver config
Type: submodule
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.slack.enable
Whether to enable Enable slack receiver.
Type: boolean
Default:
false
Example:
true
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.slack.channel
Slack channel
Type: null or string
Default:
null
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.slack.webhook_url
Slack webhook url, as a sops secret object
Type: null or string
Default:
null
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.teams
Microsoft Teams receiver config
Type: submodule
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.teams.enable
Whether to enable Enable teams receiver.
Type: boolean
Default:
false
Example:
true
Declared by:
dotcircle.monitoring.prometheus.alertmanager.receiver.teams.webhook_url
Teams webhook url, as a sops secret object
Type: null or string
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs
Short form helpers for the scrapeConfigs. Using the options here will automatically set the correct relabel configs etc.
Type: submodule
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.airgradient
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.airgradient.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.airgradient.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox
Blackbox target configurations
Type: submodule
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_2xx
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_2xx.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_2xx.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_401
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_401.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.http_401.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.qlm
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.qlm.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.qlm.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.ssh
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.ssh.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.blackbox.ssh.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.cadvisor
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.cadvisor.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.cadvisor.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.coredns
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.coredns.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.coredns.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.dcontrol
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.dcontrol.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.dcontrol.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.kea
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.kea.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.kea.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.node_exporter
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.node_exporter.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.node_exporter.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches
Switch target configurations
Type: submodule
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.cisco
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.cisco.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.cisco.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_routeros
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_routeros.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_routeros.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_switchos
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_switchos.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.switches.mikrotik_switchos.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.truenas
Whether to enable TrueNAS graphite exporter.
Type: boolean
Default:
false
Example:
true
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.ups
List of labeled target groups for this job.
Type: null or (list of (submodule))
Default:
null
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.ups.*.labels
Labels assigned to all metrics scraped from the targets.
Type: attribute set of string
Default:
{ }
Declared by:
dotcircle.monitoring.prometheus.managedConfigs.ups.*.targets
The targets specified by the target group.
Type: list of string
Declared by:
dotcircle.monitoring.prometheus.rawScrapeConfigs
A list of scrape configurations.
Type: list of (attribute set)
Default:
[ ]
Declared by:
dotcircle.monitoring.retentionTime
Retention time for metrics
Type: string
Default:
"90d"
Declared by:
dotcircle.monitoring.site_name
Short descriptive site name. Set as site_name label for all prometheus metrics.
Used as the default tenant in mimir and org_name in grafana.
Type: string
Example:
"dotcircle"
Declared by: