Skip to content

Metrics mock

Mocking the value of a metric

Iter8 enables you to mock the values of a metric. This is useful for learning purposes and quickly trying out sample Iter8 experiments without having to set up metric databases.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
apiVersion: iter8.tools/v2alpha2
kind: Metric
metadata:
  name: user-engagement
spec:
  mock:
  - name: default
    level: "20.0"
  - name: canary
    level: "15.0"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
apiVersion: iter8.tools/v2alpha2
kind: Metric
metadata:
  name: request-count
spec:
  type: Counter
  mock:
  - name: default
    level: "20.0"
  - name: canary
    level: "15.0"

Explanation

  1. When the mock field is present within a metric spec, Iter8 will mock the values for this metric.
  2. The name field refers to the name of the version. Version names should be unique. Version name should match the name of a version in the experiment's versionInfo section. If not, any value generated for the non-matching name will be ignored.
  3. You can mock both Counter and Gauge metrics.
  4. The semantics of level field are as follows:
    • If the metric is a counter, level is x, and time elapsed since the start of the experiment is y seconds, then xy is the metric value. Note that the (mocked) metric value will keep increasing over time.
    • If the metric is gauge, if level is x, the metric value is a random value with mean x. The expected value of the (mocked) metric will be x but its observed value may increase or decrease over time.
Back to top