Skip to content

Commit

Permalink
feat: add documentation for metric-scaler-format
Browse files Browse the repository at this point in the history
Signed-off-by: Friedrich Albert Kyuri <friedrichak42@gmail.com>
  • Loading branch information
Friedrich Albert Kyuri committed Mar 1, 2024
1 parent d5d67b1 commit ca2e91f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion content/docs/2.14/scalers/metrics-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ triggers:
- type: metrics-api
metadata:
targetValue: "8.8"
format: "json"
activationTargetValue: "3.8"
url: "http://api:3232/api/v1/stats"
valueLocation: "components.worker.tasks"
Expand All @@ -27,7 +28,10 @@ triggers:
**Parameter list:**
- `url` - Full URL of the API operation to call to get the metric value (eg. `http://app:1317/api/v1/stats`).
- `valueLocation` - [GJSON path notation](https://github.com/tidwall/gjson#path-syntax) to refer to the field in the payload containing the metric value.
- `format` - One of the following formats: `json`, `xml`, `yaml`, `prometheus`. (Default: `json`, Optional)
- `valueLocation` - The location of the metric value in the response payload. The value is format specific.
* `json` - [GJSON path notation](https://github.com/tidwall/gjson#path-syntax) to refer to the field in the payload containing the metric value.
* `yaml`, `xml`, `prometheus` - We use internal implementation that retrieves a value using a dot-separated path: [#2633](https://github.com/kedacore/keda/issues/2633).
- `targetValue` - Target value to scale on. When the metric provided by the API is equal or higher to this value, KEDA will start scaling out. When the metric is 0 or less, KEDA will scale down to 0. (This value can be a float)
- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float)
- `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional)
Expand Down

0 comments on commit ca2e91f

Please sign in to comment.