Skip to main content

splunk-probe

Last updated on

The Splunk Observability probe allows you to query Splunk Observability (SignalFx) metrics and compare the results against specified criteria.

When to use

  • Validate infrastructure or application metrics tracked in Splunk Observability during fault injection
  • Use SignalFx metric time series as steady-state indicators for chaos experiments
  • Monitor host-level metrics (CPU, memory, network) from Splunk while running chaos on the underlying infrastructure

Prerequisites

  • An active Splunk Observability (SignalFx) account
  • Access to the Splunk Observability API from the Kubernetes execution plane
  • An API token for authentication

Steps to configure

  1. Navigate to Project Settings > Chaos Probes and click + New Probe

  2. Select APM Probe, provide a name, and select Splunk Observability under APM Type

  3. Under Variables, define any reusable values you want to reference in probe properties or run properties. For each variable, specify the type (String or Number), name, value (fixed or runtime input), and whether it's required at runtime.

  4. Under Splunk Observability Connector, select an existing connector or click + New Connector to create one. Provide the Splunk Observability credentials and API token, configure the delegate, verify the connection, and click Finish.

  5. Under Probe Properties, configure:

    FieldDescription
    Splunk Observability QuerySearch criteria for the metric time series (MTS) you want to retrieve. Supports metrics, dimensions, properties, and tags.
    Example: sf_metric:cpu.utilization AND host.name:gke-default-pool-667be17c-t588.c.test.internal. See Splunk Observability API docs
    Lookback Window (in minutes)Time range from the specified number of minutes ago to now, over which data is aggregated

    Under Splunk Observability Data Comparison, provide:

    FieldDescription
    TypeData type for comparison: Float or Int
    Comparison CriteriaComparison operator: >=, <=, ==, !=, >, <, oneOf, between
    ValueThe expected value to compare against the metric result
  6. Provide the Run Properties:

    FieldDescription
    TimeoutMaximum time for probe execution (e.g., 10s)
    IntervalTime between successive executions (e.g., 2s)
    AttemptNumber of retry attempts (e.g., 1)
    Polling IntervalTime between retries (e.g., 30s)
    Initial DelayDelay before first execution (e.g., 5s)
    VerbosityLog detail level
    Stop On Failure (optional)Stop the experiment if the probe fails
  7. Click Create Probe