Skip to content

Commit 3f94573

Browse files
kalantarsriumcp
andauthored
update links to istio-prom.tpl (#67)
Signed-off-by: Michael Kalantar <[email protected]> Co-authored-by: Srinivasan Parthasarathy <[email protected]>
1 parent 3f52c38 commit 3f94573

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/tutorials/custom-metrics/one-version.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Validate [SLOs](../../getting-started/concepts.md#service-level-objectives) for
3737
```shell
3838
iter8 k launch \
3939
--set "tasks={custommetrics,assess}" \
40-
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl" \
40+
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl" \
4141
--set custommetrics.values.labels.namespace=default \
4242
--set custommetrics.values.labels.destination_app=httpbin \
4343
--set assess.SLOs.upper.istio-prom/error-rate=0 \
@@ -49,7 +49,7 @@ iter8 k launch \
4949
??? note "About this experiment"
5050
This experiment consists of two [tasks](../../getting-started/concepts.md#iter8-experiment), namely, [custommetrics](../../user-guide/tasks/custommetrics.md), and [assess](../../user-guide/tasks/assess.md).
5151

52-
The `custommetrics` task in this experiment [works](../../user-guide/tasks/custommetrics.md#how-it-works) by downloading a [provider template](../../user-guide/tasks/custommetrics.md#provider-template) named `istio-prom` from a URL, [substituting the template variables with values](../../user-guide/tasks/custommetrics.md#computing-variable-values), using the resulting [provider spec](../../user-guide/tasks/custommetrics.md#provider-spec) to query Prometheus for metrics, and [processing the response from Prometheus](../../user-guide/tasks/custommetrics.md#processing-response) to extract the metric values. Metrics defined by this template include `error-rate` and `latency-mean`; the [Prometheus labels](https://istio.io/latest/docs/reference/config/metrics/#labels) used by this template are stored in `labels`; all the metrics and variables associated with this template are [documented as part of the template](https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl).
52+
The `custommetrics` task in this experiment [works](../../user-guide/tasks/custommetrics.md#how-it-works) by downloading a [provider template](../../user-guide/tasks/custommetrics.md#provider-template) named `istio-prom` from a URL, [substituting the template variables with values](../../user-guide/tasks/custommetrics.md#computing-variable-values), using the resulting [provider spec](../../user-guide/tasks/custommetrics.md#provider-spec) to query Prometheus for metrics, and [processing the response from Prometheus](../../user-guide/tasks/custommetrics.md#processing-response) to extract the metric values. Metrics defined by this template include `error-rate` and `latency-mean`; the [Prometheus labels](https://istio.io/latest/docs/reference/config/metrics/#labels) used by this template are stored in `labels`; all the metrics and variables associated with this template are [documented as part of the template](https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl).
5353

5454
The [assess](../../user-guide/tasks/assess.md) task verifies if the app satisfies the specified SLOs: i) there are no errors, and ii) the mean latency of the app does not exceed 100 msec.
5555

docs/tutorials/custom-metrics/two-or-more-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Validate [SLOs](../../getting-started/concepts.md#service-level-objectives) for
2727
```shell
2828
iter8 k launch \
2929
--set "tasks={custommetrics,assess}" \
30-
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl" \
30+
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl" \
3131
--set custommetrics.values.labels.namespace=default \
3232
--set custommetrics.values.labels.destination_app=httpbin \
3333
--set custommetrics.values.labels.reporter=destination \

docs/user-guide/tasks/custommetrics.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ In this example, the `custommetrics` task fetches metrics from the Prometheus da
1313
```shell
1414
iter8 k launch \
1515
--set "tasks={custommetrics,assess}" \
16-
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl" \
16+
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl" \
1717
--set custommetrics.values.labels.destination_app=httpbin \
1818
--set custommetrics.values.labels.namespace=default \
1919
--set assess.SLOs.upper.istio-prom/error-rate=0 \
@@ -109,7 +109,7 @@ The `ProviderSpec` and `Metric` data structures together supply Iter8 with all t
109109
Rather than supplying [provider specs](#provider-spec) directly, Iter8 enables users to supply one or more [Golang templates](https://pkg.go.dev/text/template) for provider specs. Iter8 combines the provider templates with [values](#computing-variable-values), in order to generate [provider specs](#provider-spec) in YAML format, and uses them to query for the metrics.
110110

111111
Example providers specs:
112-
* [istio-prom](https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl) for [Istio's Prometheus plugin](https://istio.io/latest/docs/ops/integrations/prometheus/)
112+
* [istio-prom](https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl) for [Istio's Prometheus plugin](https://istio.io/latest/docs/ops/integrations/prometheus/)
113113

114114
In order to create [provider templates](#provider-template) and use them in experiments, it is necessary to have a clear understanding of how variable values are computed, and how the response from the database is processed by Iter8. We describe these steps next.
115115

@@ -128,7 +128,7 @@ Variable values are configured explicitly by the user during experiment launch.
128128
```shell
129129
iter8 k launch \
130130
--set "tasks={custommetrics,assess}" \
131-
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/iter8-0.13.0/templates/custommetrics/istio-prom.tpl" \
131+
--set custommetrics.templates.istio-prom="https://raw.githubusercontent.com/iter8-tools/hub/main/templates/custommetrics/istio-prom.tpl" \
132132
--set custommetrics.values.labels.namespace=default \
133133
--set custommetrics.values.labels.destination_app=httpbin \
134134
--set custommetrics.values.labels.reporter=destination \

0 commit comments

Comments
 (0)