services.nginx.virtualHosts.\.enablePhare

Whether to enable Whether to enable phare.io management for the virtualhost.

Type: boolean

Default: false

Example: true

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.alertPolicyId

The ID of the associated alert policy.

Type: positive integer, meaning >0

Default: 1

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.incidentConfirmations

Number of uninterrupted failed checks required to create an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.interval

Monitoring interval in seconds.

Type: one of 30, 60, 120, 180, 300, 600, 900, 1800, 3600

Default: 60

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.name

The name of the monitor. Defaults to attribute name in monitors.

Type: null or string

Default: null

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.projectId

The associated project.

Type: null or (positive integer, meaning >0)

Default: null

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.protocol

Whether the monitor should use http of tcp to access the resource.

Type: one of “http”, “tcp”

Default: "http"

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.recoveryConfirmations

Number of uninterrupted successful checks required to resolve an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.regions

List of regions where monitoring checks are performed

Type: list of (one of “as-jpn-hnd”, “as-sgp-sin”, “eu-deu-fra”, “eu-gbr-lhr”, “eu-swe-arn”, “na-mex-mex”, “na-usa-sea”, “na-usa-iad”, “as-jpn-hnd”, “eu-deu-fra”, “na-usa-iad”, “na-usa-sea”, “oc-aus-syd”, “sa-bra-gru”)

Default:

[
  "eu-deu-fra"
  "eu-swe-arn"
]

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.request

Monitoring request, depends of the chosen protocol.

Type: attribute set

Default: { }

Declared by: - module/default.nix

services.nginx.virtualHosts.\.phare.timeout

Monitoring timeout in milliseconds.

Type: one of 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 15000, 20000, 25000, 30000

Default: 7000

Declared by: - module/default.nix

services.phare.enable

Whether to enable Whether to enable phare.io management.

Type: boolean

Default: false

Example: true

Declared by: - module/default.nix

services.phare.enableMaintenaceModeOnRebuild

Whether to enable Whether all monitors are paused before a rebuild…

Type: boolean

Default: false

Example: true

Declared by: - module/default.nix

services.phare.alertPolicyId

The ID of the associated alert policy.

Type: positive integer, meaning >0

Default: 1

Declared by: - module/default.nix

services.phare.incidentConfirmations

Number of uninterrupted failed checks required to create an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.phare.interval

Monitoring interval in seconds.

Type: one of 30, 60, 120, 180, 300, 600, 900, 1800, 3600

Default: 60

Declared by: - module/default.nix

services.phare.monitors

Declarative phare.io monitor config

Type: attribute set of (submodule)

Default: { }

Declared by: - module/default.nix

services.phare.monitors.\.alertPolicyId

The ID of the associated alert policy.

Type: positive integer, meaning >0

Default: 1

Declared by: - module/default.nix

services.phare.monitors.\.incidentConfirmations

Number of uninterrupted failed checks required to create an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.phare.monitors.\.interval

Monitoring interval in seconds.

Type: one of 30, 60, 120, 180, 300, 600, 900, 1800, 3600

Default: 60

Declared by: - module/default.nix

services.phare.monitors.\.name

The name of the monitor. Defaults to attribute name in monitors.

Type: null or string

Default: null

Declared by: - module/default.nix

services.phare.monitors.\.projectId

The associated project.

Type: null or (positive integer, meaning >0)

Default: null

Declared by: - module/default.nix

services.phare.monitors.\.protocol

Whether the monitor should use http of tcp to access the resource.

Type: one of “http”, “tcp”

Default: "http"

Declared by: - module/default.nix

services.phare.monitors.\.recoveryConfirmations

Number of uninterrupted successful checks required to resolve an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.phare.monitors.\.regions

List of regions where monitoring checks are performed

Type: list of (one of “as-jpn-hnd”, “as-sgp-sin”, “eu-deu-fra”, “eu-gbr-lhr”, “eu-swe-arn”, “na-mex-mex”, “na-usa-sea”, “na-usa-iad”, “as-jpn-hnd”, “eu-deu-fra”, “na-usa-iad”, “na-usa-sea”, “oc-aus-syd”, “sa-bra-gru”)

Default:

[
  "eu-deu-fra"
  "eu-swe-arn"
]

Declared by: - module/default.nix

services.phare.monitors.\.request

Monitoring request, depends of the chosen protocol.

Type: attribute set

Default: { }

Declared by: - module/default.nix

services.phare.monitors.\.timeout

Monitoring timeout in milliseconds.

Type: one of 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 15000, 20000, 25000, 30000

Default: 7000

Declared by: - module/default.nix

services.phare.recoveryConfirmations

Number of uninterrupted successful checks required to resolve an incident

Type: one of 1, 2, 3, 4, 5

Default: 1

Declared by: - module/default.nix

services.phare.regions

List of regions where monitoring checks are performed

Type: list of (one of “as-jpn-hnd”, “as-sgp-sin”, “eu-deu-fra”, “eu-gbr-lhr”, “eu-swe-arn”, “na-mex-mex”, “na-usa-sea”, “na-usa-iad”, “as-jpn-hnd”, “eu-deu-fra”, “na-usa-iad”, “na-usa-sea”, “oc-aus-syd”, “sa-bra-gru”)

Default:

[
  "eu-deu-fra"
  "eu-swe-arn"
]

Declared by: - module/default.nix

services.phare.timeout

Monitoring timeout in milliseconds.

Type: one of 1000, 2000, 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000, 15000, 20000, 25000, 30000

Default: 7000

Declared by: - module/default.nix

services.phare.tokenFile

Path to a file with the API key to access phare.io. It needs read and write access to ‘Uptime’.

Type: string

Default: null

Declared by: - module/default.nix