Skip to content

Docs : add timeout parameter to Metrics API scaler #1720

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

Merged
rickbrouwer merged 2 commits into from
May 7, 2026
+2 −0
Merged

Docs : add timeout parameter to Metrics API scaler #1720

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b9d7a7
Docs : add timeout parameter to Metrics API scaler
rvijayakumar-rpx Mar 16, 2026
d9c3a43
Merge branch 'main' into feature/metrics-api-scaler-timeout
rickbrouwer May 7, 2026
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
2 changes: 2 additions & 0 deletions content/docs/2.20/scalers/metrics-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ triggers:
activationTargetValue: "3.8"
url: "http://api:3232/api/v1/stats"
valueLocation: "components.worker.tasks"
timeout: "1000" # Optional. Custom timeout for the HTTP client used in this scaler
```

**Parameter list:**
Expand All @@ -43,6 +44,7 @@ triggers:
- `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)
- `timeout` - Timeout for this specific trigger. Can be given as a number (in milliseconds) or in a human-readable format like "30s". This value will override the value defined in KEDA_HTTP_DEFAULT_TIMEOUT. (Optional)
- `aggregateFromKubeServiceEndpoints` - Whether to treat `url` as a kubernetes service and scrape/aggregate metrics for all of this service's endpoints. (Values: `true`, `false`, Default: `false`, Optional)
- `aggregationType` - How to aggregate metrics when `aggregateFromKubeServiceEndpoints` is set to `true`, ignored otherwise. (Values: `average`, `sum`, `max`, `min`, Default: `average`, Optional)

Expand Down
Loading