Overview Config (v0.14.7)

# Probes to run.
probe <cloudprober.probes.ProbeDef>:
    # Probe name. It should be unique across all probes.
  - name: <string>

    type: (PING|HTTP|DNS|EXTERNAL|UDP|UDP_LISTENER|GRPC|TCP|BROWSER|SYSTEM|STARLARK|SQL|EXTERNAL_GRPC|EXTENSION|USER_DEFINED): <enum>

    # Interval between two probe runs in milliseconds.
    # Only one of "interval" and "inteval_msec" should be defined.
    # Default interval is 2s.
    interval_msec: <int32>

    # Interval between two probe runs in string format, e.g. 10s.
    # Only one of "interval" and "inteval_msec" should be defined.
    # Default interval is 2s.
    interval: <string>

    # Timeout for each probe in milliseconds
    # Only one of "timeout" and "timeout_msec" should be defined.
    # Default timeout is 1s.
    timeout_msec: <int32>

    # Timeout for each probe in string format, e.g. 10s.
    # Only one of "timeout" and "timeout_msec" should be defined.
    # Default timeout is 1s.
    timeout: <string>

    # Targets for the probe. Targets are required for all probes except
    # for external, user_defined, extension, browser, sql and system probe
    # types.
    targets: <cloudprober.targets.TargetsDef>

    # Latency distribution. If specified, latency is stored as a distribution.
    latency_distribution: <cloudprober.metrics.Dist>

    # Latency unit. Any string that's parseable by time.ParseDuration.
    # Valid values: "ns", "us" (or "µs"), "ms", "s", "m", "h".
    latency_unit: <string> | default: us

    # Latency metric name. You may want to change the latency metric name, if:
    # you're using latency_distribution for some probes, and regular metric for
    # other probes, and you want to differentiate between the two.
    # For example:
    #   probe {
    #     name: "web1_latency"
    #     latency_distribution: {...}
    #     latency_metric_name: "latency_dist"
    #     ...
    #   }
    #   probe {
    #     name: "app1"
    #     ...
    #   }
    latency_metric_name: <string> | default: latency

    # Validators for this probe. Validators are run on the data returned by the
    # probe. See https://cloudprober.org/docs/how-to/validators/ for more info.
    validator: <cloudprober.validators.Validator>

    # Set the source IP to send packets from, either by providing an IP address
    # directly, or a network interface.
    [source_ip <string> | source_interface <string>]: <oneof>

    ip_version: (IP_VERSION_UNSPECIFIED|IPV4|IPV6): <enum>

    # How often to export stats. Probes usually run at a higher frequency (e.g.
    # every second); stats from individual probes are aggregated within
    # cloudprober until exported. In most cases, users don't need to change the
    # default.
    #
    # By default this field is set in the following way:
    # For all probes except UDP:
    #   stats_export_interval=max(interval, 10s)
    # For UDP:
    #   stats_export_interval=max(2*max(interval, timeout), 10s)
    stats_export_interval_msec: <int32>

    # Additional labels to add to the probe results. Label's value can either be
    # static or can be derived from target's labels.
    #
    # Example:
    #   additional_label {
    #     key: "app"
    #     value: "@target.label.app@"
    #   }
    # (More detailed example at: examples/additional_label/cloudprober.cfg)
    additional_label: <cloudprober.probes.AdditionalLabel>

    # (Experimental) If set, test is inversed, i.e. we count it as success if
    # target doesn't respond. This is useful, for example, that your firewall is
    # working as expected.
    #
    # This is currently implemented only by PING, TCP, and HTTP probes.
    # Note: This field is currently experimental, and may change in future.
    negative_test: <bool>

    # Alerts configuration. If specified, cloudprober will generate alerts on
    # probe failures. You can specify multiple alerts.
    # Example:
    #  alert {
    #    name: "alert1"
    #    condition {...}
    #    notify {
    #      pagerduty { ...}
    #    }
    #  }
    #  alert {
    #    name: "alert2"
    #    notify { ... }
    #  }
    alert: <cloudprober.alerting.AlertConf>

    [ping_probe <cloudprober.probes.ping.ProbeConf> | http_probe <cloudprober.probes.http.ProbeConf> | 
     dns_probe <cloudprober.probes.dns.ProbeConf> | external_probe <cloudprober.probes.external.ProbeConf> | 
     udp_probe <cloudprober.probes.udp.ProbeConf> | udp_listener_probe <cloudprober.probes.udplistener.ProbeConf> | 
     grpc_probe <cloudprober.probes.grpc.ProbeConf> | tcp_probe <cloudprober.probes.tcp.ProbeConf> | 
     browser_probe <cloudprober.probes.browser.ProbeConf> | system_probe <cloudprober.probes.system.ProbeConf> | 
     starlark_probe <cloudprober.probes.starlark.ProbeConf> | sql_probe <cloudprober.probes.sql.ProbeConf> | 
     external_grpc_probe <cloudprober.probes.grpcext.ProbeConf> | user_defined_probe <string>]: <oneof>

    # Which machines this probe should run on. If defined, cloudprober will run
    # this probe only if machine's hostname matches this value. This is useful
    # for large deployments, where you may want to use the same prober config
    # everywhere but run this probe only on a subset of machines.
    run_on: <string>

    # How often to re-evaluate (discover) targets in seconds. This controls the
    # probe scheduler's target update interval — how often new targets start
    # being probed and removed targets stop being probed. If not set, defaults
    # to 1 minute.
    targets_update_sec: <int32>

    # Duration to wait before starting the probe.
    #
    # This delay is applied only once, at the very beginning of the probe execution
    # loop. It is useful for manually staggering the startup of multiple probes,
    # especially when the probe interval is large and the default automatic
    # staggering (capped at 1 minute) is not sufficient.
    #
    # Note: This delay is additive to the default automatic staggering.
    startup_delay_msec: <uint32>

    # Schedule for the probe. You can use a schedule to specify when a probe
    # should or should not run. This is useful for running probes only during
    # business hours.
    #
    # You can specify multiple schedules. Probe will not run if any of the 
    # "DISABLE" schedules are active. If both "ENABLE" and "DISABLE" schedules
    # overlap, "DISABLE" takes precedence.
    #
    # For example, to disable a probe during weekends and on Tuesday between 7pm
    # and 8pm, e.g. for rollouts:
    #   schdule {
    #     type: DISABLE
    #     start_weekday: FRIDAY
    #     start_time: "20:00"
    #     end_weekday: SUNDAY
    #     end_time: "17:00" 
    #     timezone: "America/New_York"
    #   }
    #   schdule {
    #     type: DISABLE
    #     start_weekday: TUESDAY
    #     start_time: "19:00"
    #     end_weekday: TUESDAY
    #     end_time: "20:00" 
    #     timezone: "America/New_York"
    #   }
    schedule: <cloudprober.probes.Schedule>

    # Debug options. Currently only used to enable logging metrics.
    debug_options: <cloudprober.probes.DebugOptions>

# Surfacers are used to export probe results for further processing.
# If no surfacer is configured, a prometheus and a file surfacer are
# initialized:
#  - Prometheus makes probe results available at http://<host>:9313/metrics.
#  - File surfacer writes results to stdout.
#
# You can disable default surfacers (in case you want no surfacer at all), by
# adding the following to your config:
#   surfacer {}
surfacer <cloudprober.surfacer.SurfacerDef>:
    # This name is used for logging. If not defined, it's derived from the type.
    # Note that this field is required for the USER_DEFINED surfacer type and
    # should match with the name that you used while registering the user defined
    # surfacer.
  - name: <string>

    type: (NONE|PROMETHEUS|STACKDRIVER|FILE|POSTGRES|PUBSUB|CLOUDWATCH|DATADOG|PROBESTATUS|BIGQUERY|OTEL|EXTENSION|USER_DEFINED): <enum>

    # How many metrics entries (EventMetrics) to buffer. This is the buffer
    # between incoming metrics and the metrics that are being processed. Default
    # value should work in most cases. You may need to increase it on a busy
    # system, but that's usually a sign that you metrics processing pipeline is
    # slow for some reason, e.g. slow writes to a remote file.
    # Note: Only file and pubsub surfacer supports this option right now.
    metrics_buffer_size: <int64> | default: 10000

    # If specified, only allow metrics that match any of these label filters.
    # Example:
    # allow_metrics_with_label {
    #   key: "probe",
    #   value: "check_homepage",
    # }
    allow_metrics_with_label: <cloudprober.surfacer.LabelFilter>

    # Ignore metrics that match any of these label filters. Ignore has precedence
    # over allow filters.
    # Example:
    # ignore_metrics_with_label {
    #   key: "probe",
    #   value: "sysvars",
    # }
    ignore_metrics_with_label: <cloudprober.surfacer.LabelFilter>

    # Allow and ignore metrics based on their names. You can specify regexes
    # here. Ignore has precendence over allow.
    # Examples:
    #  ignore_metrics_with_name: "validation_failure"
    #  allow_metrics_with_name: "(total|success|latency)"
    allow_metrics_with_name: <string>

    ignore_metrics_with_name: <string>

    # Whether to add failure metric or not. This option is enabled by default.
    add_failure_metric: <bool> | default: true

    # If set to true, cloudprober will export all metrics as gauge metrics. Note
    # that cloudprober inherently generates only cumulative metrics. To create
    # gauge metrics from cumulative metrics, we keep a copy of the old metrics
    # and subtract new metrics from the previous metrics. This transformation in
    # metrics has an increased memory-overhead because extra copies required.
    # However, it should not be noticeable unless you're producing large number
    # of metrics (say > 10000 metrics per second).
    export_as_gauge: <bool>

    # Latency metric name pattern, used to identify latency metrics, and add
    # EventMetric's LatencyUnit to it.
    latency_metric_pattern: <string> | default: ^(.+_|)latency$

    # Environment variable containing additional labels to be added to all
    # metrics exported by this surfacer.
    # e.g. "CLOUDPROBER_ADDITIONAL_LABELS=env=prod,app=identity-service"
    # You can disable this feature by setting this field to an empty string.
    # Note: These additional labels have no effect if metrics already have the
    # same label.
    additional_labels_env_var: <string> | default: CLOUDPROBER_ADDITIONAL_LABELS

    # Matching surfacer specific configuration (one for each type in the above
    # enum)
    [prometheus_surfacer <cloudprober.surfacer.prometheus.SurfacerConf> | stackdriver_surfacer <cloudprober.surfacer.stackdriver.SurfacerConf> | 
     file_surfacer <cloudprober.surfacer.file.SurfacerConf> | postgres_surfacer <cloudprober.surfacer.postgres.SurfacerConf> | 
     pubsub_surfacer <cloudprober.surfacer.pubsub.SurfacerConf> | cloudwatch_surfacer <cloudprober.surfacer.cloudwatch.SurfacerConf> | 
     datadog_surfacer <cloudprober.surfacer.datadog.SurfacerConf> | probestatus_surfacer <cloudprober.surfacer.probestatus.SurfacerConf> | 
     bigquery_surfacer <cloudprober.surfacer.bigquery.SurfacerConf> | otel_surfacer <cloudprober.surfacer.otel.SurfacerConf>]: <oneof>

# Servers to run inside cloudprober. These servers can serve as targets for
# other probes.
server <cloudprober.servers.ServerDef>:
  - type: (HTTP|UDP|GRPC|EXTERNAL): <enum>

    [http_server <cloudprober.servers.http.ServerConf> | udp_server <cloudprober.servers.udp.ServerConf> | 
     grpc_server <cloudprober.servers.grpc.ServerConf> | external_server <cloudprober.servers.external.ServerConf>]: <oneof>

# Shared targets allow you to re-use the same targets copy across multiple
# probes.
# Example:
# shared_targets {
#   name: "internal-vms"
#   targets {
#     rds_targets {...}
#   }
# }
#
# probe {
#   name: "vm-ping"
#   type: PING
#   targets {
#     shared_targets: "internal-vms"
#   }
# }
#
# probe {
#   name: "vm-http"
#   type: HTTP
#   targets {
#     shared_targets: "internal-vms"
#   }
# }
shared_targets <cloudprober.SharedTargets>:
  - name: <string>

    targets: <cloudprober.targets.TargetsDef>

# Resource discovery server
rds_server <cloudprober.rds.ServerConf>:
  # List of providers that server supports.
  provider: <cloudprober.rds.Provider>

# Port for the default HTTP server. This port is also used for prometheus
# exporter (URL /metrics). Default port is 9313. If not specified in the
# config, default port can be overridden by the environment variable
# CLOUDPROBER_PORT.
port: <int32>

# Port to run the default gRPC server on. If not specified, and if
# environment variable CLOUDPROBER_GRPC_PORT is set, CLOUDPROBER_GRPC_PORT is
# used for the default gRPC server. If CLOUDPROBER_GRPC_PORT is not set as
# well, default gRPC server is not started.
grpc_port: <int32>

# TLS config, it can be used to:
# - Specify client's CA cert for client cert verification:
#     grpc_tls_config {
#       ca_cert_file: "...."
#     }
#
# - Specify TLS cert and key:
#     grpc_tls_config {
#       tls_cert_file: "..."
#       tls_key_file: "..."
#     }
grpc_tls_config <cloudprober.tlsconfig.TLSConfig>:
  # CA certificate file to verify certificates provided by the other party.
  ca_cert_file: <string>

  # Local certificate file.
  tls_cert_file: <string>

  # Private key file corresponding to the certificate above.
  tls_key_file: <string>

  # Whether to ignore the cert validation.
  disable_cert_validation: <bool>

  # ServerName override
  server_name: <string>

  min_tls_version: (TLS_AUTO|TLS_1_0|TLS_1_1|TLS_1_2|TLS_1_3): <enum>

  max_tls_version: (TLS_AUTO|TLS_1_0|TLS_1_1|TLS_1_2|TLS_1_3): <enum>

  # Certificate reload interval in seconds. If configured, the TLS cert will
  # be reloaded every reload_interval_sec seconds. This is useful when
  # certificates are generated and refreshed dynamically.
  reload_interval_sec: <int32>

# Host for the default HTTP server. Default listens on all addresses. If not
# specified in the config, default port can be overridden by the environment
# variable CLOUDPROBER_HOST.
host: <string>

# Probes are staggered across time to avoid executing all of them at the
# same time. This behavior can be disabled by setting the following option
# to true.
disable_jitter: <bool> | default: false

# How often to export system variables. To learn more about system variables:
# http://godoc.org/github.com/cloudprober/cloudprober/internal/sysvars.
sysvars_interval_msec: <int32> | default: 10000

# Variables specified in this environment variable are exported as it is.
# This is specifically useful to export information about system environment,
# for example, docker image tag/digest-id, OS version etc. See
# tools/cloudprober_startup.sh in the cloudprober directory for an example on
# how to use these variables.
sysvars_env_var: <string> | default: SYSVARS

# Time between triggering cancelation of various goroutines and exiting the
# process. If --stop_time flag is also configured, that gets priority.
# You may want to set it to 0 if cloudprober is running as a backend for
# the probes and you don't want time lost in stop and start.
stop_time_sec: <int32> | default: 5

# Global targets options. Per-probe options are specified within the probe
# stanza.
global_targets_options <cloudprober.targets.GlobalTargetsOptions>:
  # RDS server address
  # Deprecated: This option is now deprecated, please use rds_server_options
  # instead.
  rds_server_address: <string>

  # RDS server options, for example:
  # rds_server_options {
  #   server_address: "rds-server.xyz:9314"
  #   oauth_config: {
  #     ...
  #   }
  # }
  rds_server_options: <cloudprober.rds.ClientConf.ServerOptions>

  # GCE targets options.
  global_gce_targets_options: <cloudprober.targets.gce.GlobalOptions>

  # Lame duck options. If provided, targets module checks for the lame duck
  # targets and removes them from the targets list.
  lame_duck_options: <cloudprober.targets.lameduck.Options>

# Artifacts options, applicable to probes that generate artifacts. There is
# only one such probe type right now (2025/03/16) -- BROWSER. These options
# specify where artifacts will be stored and if they will be served on
# Cloudprober's default webserver. Example:
#
# global_artifacts_options {
#   serve_on_web: true
#   web_server_root: "/output" # local storage's dir
#   storage {
#     local_storage {
#       dir: "/output"
#     }
#     s3 {
#       bucket: "my-bucket"
#     }
#   }
# }
global_artifacts_options <cloudprober.probes.browser.artifacts.ArtifactsOptions>:
  # Serve test artifacts on Cloudprober's default webserver. This is
  # disabled by default for security reasons. If it's set to true and no
  # local storage is configured, we return an error.
  serve_on_web: <bool>

  # Specify web server path to serve test artifacts on.
  # Default is "/artifacts/<probename>".
  web_server_path: <string>

  # Web server root directory. If not provided (recommended), we just use
  # the first local storage directory if configured, and if provided, we
  # verify that it is one of the local storages directories.
  web_server_root: <string>

  # Storage for test artifacts. Note that test artifacts are always
  # written to the workdir first, and uploaded to the storage backend in a
  # parallel goroutine. This is to make sure that uploads don't block the
  # main probe execution.
  storage: <cloudprober.probes.browser.artifacts.Storage>

# Distributed tracing configuration. When set, Cloudprober initializes a
# global OpenTelemetry TracerProvider that exports spans to the configured
# OTLP collector, and all tracing-capable probes (HTTP today) are
# instrumented automatically.
tracing <cloudprober.tracing.TracingConfig>:
  [otlp_http_exporter <cloudprober.otel.HTTPExporter> | otlp_grpc_exporter <cloudprober.otel.GRPCExporter>]: <oneof>

  resource_attribute: <cloudprober.tracing.TracingConfig.Attribute>

  # Fraction of probe requests to trace, in the range [0.0, 1.0]. Cloudprober
  # is the root of the trace, so this is the probability that a given request
  # starts a sampled trace. Defaults to 1.0: once a tracing config is
  # present, every probe request is traced unless you lower the sampling
  # rate.
  sampling_fraction: <double> | default: 1

  # Context propagators used to inject trace context into outgoing requests.
  # Values are names of OpenTelemetry propagators, e.g. "tracecontext",
  # "baggage", "b3", "b3multi", "jaeger", "xray", "ottrace", or "none". If
  # unset, the OTEL_PROPAGATORS environment variable is used, falling back to
  # ["tracecontext", "baggage"].
  propagator: <string>

  # Service name reported on the trace resource (service.name attribute).
  # Defaults to "cloudprober".
  service_name: <string> | default: cloudprober

# Probes to run.
probe <cloudprober.probes.ProbeDef> {
  # Probe name. It should be unique across all probes.
  name: <string>

  type: (PING|HTTP|DNS|EXTERNAL|UDP|UDP_LISTENER|GRPC|TCP|BROWSER|SYSTEM|STARLARK|SQL|EXTERNAL_GRPC|EXTENSION|USER_DEFINED): <enum>

  # Interval between two probe runs in milliseconds.
  # Only one of "interval" and "inteval_msec" should be defined.
  # Default interval is 2s.
  interval_msec: <int32>

  # Interval between two probe runs in string format, e.g. 10s.
  # Only one of "interval" and "inteval_msec" should be defined.
  # Default interval is 2s.
  interval: <string>

  # Timeout for each probe in milliseconds
  # Only one of "timeout" and "timeout_msec" should be defined.
  # Default timeout is 1s.
  timeout_msec: <int32>

  # Timeout for each probe in string format, e.g. 10s.
  # Only one of "timeout" and "timeout_msec" should be defined.
  # Default timeout is 1s.
  timeout: <string>

  # Targets for the probe. Targets are required for all probes except
  # for external, user_defined, extension, browser, sql and system probe
  # types.
  targets: <cloudprober.targets.TargetsDef>

  # Latency distribution. If specified, latency is stored as a distribution.
  latency_distribution: <cloudprober.metrics.Dist>

  # Latency unit. Any string that's parseable by time.ParseDuration.
  # Valid values: "ns", "us" (or "µs"), "ms", "s", "m", "h".
  latency_unit: <string> | default: us

  # Latency metric name. You may want to change the latency metric name, if:
  # you're using latency_distribution for some probes, and regular metric for
  # other probes, and you want to differentiate between the two.
  # For example:
  #   probe {
  #     name: "web1_latency"
  #     latency_distribution: {...}
  #     latency_metric_name: "latency_dist"
  #     ...
  #   }
  #   probe {
  #     name: "app1"
  #     ...
  #   }
  latency_metric_name: <string> | default: latency

  # Validators for this probe. Validators are run on the data returned by the
  # probe. See https://cloudprober.org/docs/how-to/validators/ for more info.
  validator: <cloudprober.validators.Validator>

  # Set the source IP to send packets from, either by providing an IP address
  # directly, or a network interface.
  [source_ip <string> | source_interface <string>]: <oneof>

  ip_version: (IP_VERSION_UNSPECIFIED|IPV4|IPV6): <enum>

  # How often to export stats. Probes usually run at a higher frequency (e.g.
  # every second); stats from individual probes are aggregated within
  # cloudprober until exported. In most cases, users don't need to change the
  # default.
  #
  # By default this field is set in the following way:
  # For all probes except UDP:
  #   stats_export_interval=max(interval, 10s)
  # For UDP:
  #   stats_export_interval=max(2*max(interval, timeout), 10s)
  stats_export_interval_msec: <int32>

  # Additional labels to add to the probe results. Label's value can either be
  # static or can be derived from target's labels.
  #
  # Example:
  #   additional_label {
  #     key: "app"
  #     value: "@target.label.app@"
  #   }
  # (More detailed example at: examples/additional_label/cloudprober.cfg)
  additional_label: <cloudprober.probes.AdditionalLabel>

  # (Experimental) If set, test is inversed, i.e. we count it as success if
  # target doesn't respond. This is useful, for example, that your firewall is
  # working as expected.
  #
  # This is currently implemented only by PING, TCP, and HTTP probes.
  # Note: This field is currently experimental, and may change in future.
  negative_test: <bool>

  # Alerts configuration. If specified, cloudprober will generate alerts on
  # probe failures. You can specify multiple alerts.
  # Example:
  #  alert {
  #    name: "alert1"
  #    condition {...}
  #    notify {
  #      pagerduty { ...}
  #    }
  #  }
  #  alert {
  #    name: "alert2"
  #    notify { ... }
  #  }
  alert: <cloudprober.alerting.AlertConf>

  [ping_probe <cloudprober.probes.ping.ProbeConf> | http_probe <cloudprober.probes.http.ProbeConf> | 
   dns_probe <cloudprober.probes.dns.ProbeConf> | external_probe <cloudprober.probes.external.ProbeConf> | 
   udp_probe <cloudprober.probes.udp.ProbeConf> | udp_listener_probe <cloudprober.probes.udplistener.ProbeConf> | 
   grpc_probe <cloudprober.probes.grpc.ProbeConf> | tcp_probe <cloudprober.probes.tcp.ProbeConf> | 
   browser_probe <cloudprober.probes.browser.ProbeConf> | system_probe <cloudprober.probes.system.ProbeConf> | 
   starlark_probe <cloudprober.probes.starlark.ProbeConf> | sql_probe <cloudprober.probes.sql.ProbeConf> | 
   external_grpc_probe <cloudprober.probes.grpcext.ProbeConf> | user_defined_probe <string>]: <oneof>

  # Which machines this probe should run on. If defined, cloudprober will run
  # this probe only if machine's hostname matches this value. This is useful
  # for large deployments, where you may want to use the same prober config
  # everywhere but run this probe only on a subset of machines.
  run_on: <string>

  # How often to re-evaluate (discover) targets in seconds. This controls the
  # probe scheduler's target update interval — how often new targets start
  # being probed and removed targets stop being probed. If not set, defaults
  # to 1 minute.
  targets_update_sec: <int32>

  # Duration to wait before starting the probe.
  #
  # This delay is applied only once, at the very beginning of the probe execution
  # loop. It is useful for manually staggering the startup of multiple probes,
  # especially when the probe interval is large and the default automatic
  # staggering (capped at 1 minute) is not sufficient.
  #
  # Note: This delay is additive to the default automatic staggering.
  startup_delay_msec: <uint32>

  # Schedule for the probe. You can use a schedule to specify when a probe
  # should or should not run. This is useful for running probes only during
  # business hours.
  #
  # You can specify multiple schedules. Probe will not run if any of the 
  # "DISABLE" schedules are active. If both "ENABLE" and "DISABLE" schedules
  # overlap, "DISABLE" takes precedence.
  #
  # For example, to disable a probe during weekends and on Tuesday between 7pm
  # and 8pm, e.g. for rollouts:
  #   schdule {
  #     type: DISABLE
  #     start_weekday: FRIDAY
  #     start_time: "20:00"
  #     end_weekday: SUNDAY
  #     end_time: "17:00" 
  #     timezone: "America/New_York"
  #   }
  #   schdule {
  #     type: DISABLE
  #     start_weekday: TUESDAY
  #     start_time: "19:00"
  #     end_weekday: TUESDAY
  #     end_time: "20:00" 
  #     timezone: "America/New_York"
  #   }
  schedule: <cloudprober.probes.Schedule>

  # Debug options. Currently only used to enable logging metrics.
  debug_options: <cloudprober.probes.DebugOptions>
}

# Surfacers are used to export probe results for further processing.
# If no surfacer is configured, a prometheus and a file surfacer are
# initialized:
#  - Prometheus makes probe results available at http://<host>:9313/metrics.
#  - File surfacer writes results to stdout.
#
# You can disable default surfacers (in case you want no surfacer at all), by
# adding the following to your config:
#   surfacer {}
surfacer <cloudprober.surfacer.SurfacerDef> {
  # This name is used for logging. If not defined, it's derived from the type.
  # Note that this field is required for the USER_DEFINED surfacer type and
  # should match with the name that you used while registering the user defined
  # surfacer.
  name: <string>

  type: (NONE|PROMETHEUS|STACKDRIVER|FILE|POSTGRES|PUBSUB|CLOUDWATCH|DATADOG|PROBESTATUS|BIGQUERY|OTEL|EXTENSION|USER_DEFINED): <enum>

  # How many metrics entries (EventMetrics) to buffer. This is the buffer
  # between incoming metrics and the metrics that are being processed. Default
  # value should work in most cases. You may need to increase it on a busy
  # system, but that's usually a sign that you metrics processing pipeline is
  # slow for some reason, e.g. slow writes to a remote file.
  # Note: Only file and pubsub surfacer supports this option right now.
  metrics_buffer_size: <int64> | default: 10000

  # If specified, only allow metrics that match any of these label filters.
  # Example:
  # allow_metrics_with_label {
  #   key: "probe",
  #   value: "check_homepage",
  # }
  allow_metrics_with_label: <cloudprober.surfacer.LabelFilter>

  # Ignore metrics that match any of these label filters. Ignore has precedence
  # over allow filters.
  # Example:
  # ignore_metrics_with_label {
  #   key: "probe",
  #   value: "sysvars",
  # }
  ignore_metrics_with_label: <cloudprober.surfacer.LabelFilter>

  # Allow and ignore metrics based on their names. You can specify regexes
  # here. Ignore has precendence over allow.
  # Examples:
  #  ignore_metrics_with_name: "validation_failure"
  #  allow_metrics_with_name: "(total|success|latency)"
  allow_metrics_with_name: <string>

  ignore_metrics_with_name: <string>

  # Whether to add failure metric or not. This option is enabled by default.
  add_failure_metric: <bool> | default: true

  # If set to true, cloudprober will export all metrics as gauge metrics. Note
  # that cloudprober inherently generates only cumulative metrics. To create
  # gauge metrics from cumulative metrics, we keep a copy of the old metrics
  # and subtract new metrics from the previous metrics. This transformation in
  # metrics has an increased memory-overhead because extra copies required.
  # However, it should not be noticeable unless you're producing large number
  # of metrics (say > 10000 metrics per second).
  export_as_gauge: <bool>

  # Latency metric name pattern, used to identify latency metrics, and add
  # EventMetric's LatencyUnit to it.
  latency_metric_pattern: <string> | default: ^(.+_|)latency$

  # Environment variable containing additional labels to be added to all
  # metrics exported by this surfacer.
  # e.g. "CLOUDPROBER_ADDITIONAL_LABELS=env=prod,app=identity-service"
  # You can disable this feature by setting this field to an empty string.
  # Note: These additional labels have no effect if metrics already have the
  # same label.
  additional_labels_env_var: <string> | default: CLOUDPROBER_ADDITIONAL_LABELS

  # Matching surfacer specific configuration (one for each type in the above
  # enum)
  [prometheus_surfacer <cloudprober.surfacer.prometheus.SurfacerConf> | stackdriver_surfacer <cloudprober.surfacer.stackdriver.SurfacerConf> | 
   file_surfacer <cloudprober.surfacer.file.SurfacerConf> | postgres_surfacer <cloudprober.surfacer.postgres.SurfacerConf> | 
   pubsub_surfacer <cloudprober.surfacer.pubsub.SurfacerConf> | cloudwatch_surfacer <cloudprober.surfacer.cloudwatch.SurfacerConf> | 
   datadog_surfacer <cloudprober.surfacer.datadog.SurfacerConf> | probestatus_surfacer <cloudprober.surfacer.probestatus.SurfacerConf> | 
   bigquery_surfacer <cloudprober.surfacer.bigquery.SurfacerConf> | otel_surfacer <cloudprober.surfacer.otel.SurfacerConf>]: <oneof>
}

# Servers to run inside cloudprober. These servers can serve as targets for
# other probes.
server <cloudprober.servers.ServerDef> {
  type: (HTTP|UDP|GRPC|EXTERNAL): <enum>

  [http_server <cloudprober.servers.http.ServerConf> | udp_server <cloudprober.servers.udp.ServerConf> | 
   grpc_server <cloudprober.servers.grpc.ServerConf> | external_server <cloudprober.servers.external.ServerConf>]: <oneof>
}

# Shared targets allow you to re-use the same targets copy across multiple
# probes.
# Example:
# shared_targets {
#   name: "internal-vms"
#   targets {
#     rds_targets {...}
#   }
# }
#
# probe {
#   name: "vm-ping"
#   type: PING
#   targets {
#     shared_targets: "internal-vms"
#   }
# }
#
# probe {
#   name: "vm-http"
#   type: HTTP
#   targets {
#     shared_targets: "internal-vms"
#   }
# }
shared_targets <cloudprober.SharedTargets> {
  name: <string>

  targets: <cloudprober.targets.TargetsDef>
}

# Resource discovery server
rds_server <cloudprober.rds.ServerConf> {
  # List of providers that server supports.
  provider: <cloudprober.rds.Provider>
}

# Port for the default HTTP server. This port is also used for prometheus
# exporter (URL /metrics). Default port is 9313. If not specified in the
# config, default port can be overridden by the environment variable
# CLOUDPROBER_PORT.
port: <int32>

# Port to run the default gRPC server on. If not specified, and if
# environment variable CLOUDPROBER_GRPC_PORT is set, CLOUDPROBER_GRPC_PORT is
# used for the default gRPC server. If CLOUDPROBER_GRPC_PORT is not set as
# well, default gRPC server is not started.
grpc_port: <int32>

# TLS config, it can be used to:
# - Specify client's CA cert for client cert verification:
#     grpc_tls_config {
#       ca_cert_file: "...."
#     }
#
# - Specify TLS cert and key:
#     grpc_tls_config {
#       tls_cert_file: "..."
#       tls_key_file: "..."
#     }
grpc_tls_config <cloudprober.tlsconfig.TLSConfig> {
  # CA certificate file to verify certificates provided by the other party.
  ca_cert_file: <string>

  # Local certificate file.
  tls_cert_file: <string>

  # Private key file corresponding to the certificate above.
  tls_key_file: <string>

  # Whether to ignore the cert validation.
  disable_cert_validation: <bool>

  # ServerName override
  server_name: <string>

  min_tls_version: (TLS_AUTO|TLS_1_0|TLS_1_1|TLS_1_2|TLS_1_3): <enum>

  max_tls_version: (TLS_AUTO|TLS_1_0|TLS_1_1|TLS_1_2|TLS_1_3): <enum>

  # Certificate reload interval in seconds. If configured, the TLS cert will
  # be reloaded every reload_interval_sec seconds. This is useful when
  # certificates are generated and refreshed dynamically.
  reload_interval_sec: <int32>
}

# Host for the default HTTP server. Default listens on all addresses. If not
# specified in the config, default port can be overridden by the environment
# variable CLOUDPROBER_HOST.
host: <string>

# Probes are staggered across time to avoid executing all of them at the
# same time. This behavior can be disabled by setting the following option
# to true.
disable_jitter: <bool> | default: false

# How often to export system variables. To learn more about system variables:
# http://godoc.org/github.com/cloudprober/cloudprober/internal/sysvars.
sysvars_interval_msec: <int32> | default: 10000

# Variables specified in this environment variable are exported as it is.
# This is specifically useful to export information about system environment,
# for example, docker image tag/digest-id, OS version etc. See
# tools/cloudprober_startup.sh in the cloudprober directory for an example on
# how to use these variables.
sysvars_env_var: <string> | default: SYSVARS

# Time between triggering cancelation of various goroutines and exiting the
# process. If --stop_time flag is also configured, that gets priority.
# You may want to set it to 0 if cloudprober is running as a backend for
# the probes and you don't want time lost in stop and start.
stop_time_sec: <int32> | default: 5

# Global targets options. Per-probe options are specified within the probe
# stanza.
global_targets_options <cloudprober.targets.GlobalTargetsOptions> {
  # RDS server address
  # Deprecated: This option is now deprecated, please use rds_server_options
  # instead.
  rds_server_address: <string>

  # RDS server options, for example:
  # rds_server_options {
  #   server_address: "rds-server.xyz:9314"
  #   oauth_config: {
  #     ...
  #   }
  # }
  rds_server_options: <cloudprober.rds.ClientConf.ServerOptions>

  # GCE targets options.
  global_gce_targets_options: <cloudprober.targets.gce.GlobalOptions>

  # Lame duck options. If provided, targets module checks for the lame duck
  # targets and removes them from the targets list.
  lame_duck_options: <cloudprober.targets.lameduck.Options>
}

# Artifacts options, applicable to probes that generate artifacts. There is
# only one such probe type right now (2025/03/16) -- BROWSER. These options
# specify where artifacts will be stored and if they will be served on
# Cloudprober's default webserver. Example:
#
# global_artifacts_options {
#   serve_on_web: true
#   web_server_root: "/output" # local storage's dir
#   storage {
#     local_storage {
#       dir: "/output"
#     }
#     s3 {
#       bucket: "my-bucket"
#     }
#   }
# }
global_artifacts_options <cloudprober.probes.browser.artifacts.ArtifactsOptions> {
  # Serve test artifacts on Cloudprober's default webserver. This is
  # disabled by default for security reasons. If it's set to true and no
  # local storage is configured, we return an error.
  serve_on_web: <bool>

  # Specify web server path to serve test artifacts on.
  # Default is "/artifacts/<probename>".
  web_server_path: <string>

  # Web server root directory. If not provided (recommended), we just use
  # the first local storage directory if configured, and if provided, we
  # verify that it is one of the local storages directories.
  web_server_root: <string>

  # Storage for test artifacts. Note that test artifacts are always
  # written to the workdir first, and uploaded to the storage backend in a
  # parallel goroutine. This is to make sure that uploads don't block the
  # main probe execution.
  storage: <cloudprober.probes.browser.artifacts.Storage>
}

# Distributed tracing configuration. When set, Cloudprober initializes a
# global OpenTelemetry TracerProvider that exports spans to the configured
# OTLP collector, and all tracing-capable probes (HTTP today) are
# instrumented automatically.
tracing <cloudprober.tracing.TracingConfig> {
  [otlp_http_exporter <cloudprober.otel.HTTPExporter> | otlp_grpc_exporter <cloudprober.otel.GRPCExporter>]: <oneof>

  resource_attribute: <cloudprober.tracing.TracingConfig.Attribute>

  # Fraction of probe requests to trace, in the range [0.0, 1.0]. Cloudprober
  # is the root of the trace, so this is the probability that a given request
  # starts a sampled trace. Defaults to 1.0: once a tracing config is
  # present, every probe request is traced unless you lower the sampling
  # rate.
  sampling_fraction: <double> | default: 1

  # Context propagators used to inject trace context into outgoing requests.
  # Values are names of OpenTelemetry propagators, e.g. "tracecontext",
  # "baggage", "b3", "b3multi", "jaeger", "xray", "ottrace", or "none". If
  # unset, the OTEL_PROPAGATORS environment variable is used, falling back to
  # ["tracecontext", "baggage"].
  propagator: <string>

  # Service name reported on the trace resource (service.name attribute).
  # Defaults to "cloudprober".
  service_name: <string> | default: cloudprober
}