Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add documentation for metric-scaler-format #1325

Merged
merged 3 commits into from
Mar 25, 2024
Merged

feat: add documentation for metric-scaler-format #1325

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49d9ea6
feat: add documentation for metric-scaler-format
Mar 1, 2024
823da03
Update content/docs/2.14/scalers/metrics-api.md
fira42073 Mar 25, 2024
1c9d3b7
add examples
Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion content/docs/2.14/scalers/metrics-api.md
View file
Open in desktop
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).
JorTurFer marked this conversation as resolved.
Show resolved Hide resolved
fira42073 marked this conversation as resolved.
Show resolved Hide resolved
- `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