docs(scalers): add Honeycomb scaler documentation #1587
Conversation
Signed-off-by: kmoonwright <[email protected]>
✅ Deploy Preview for keda ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Thank you for your contribution! 🙏 We will review your PR as soon as possible.
Learn more about:
|
JorTurFer
left a comment
JorTurFer
left a comment
There was a problem hiding this comment.
Please move this to v2.18. KEDA v2.17 is the current one and new features will be included in the next version
| @@ -0,0 +1,152 @@ | |||
| +++ | |||
| title = "Honeycomb" | |||
| availability = "v2.17+" | |||
There was a problem hiding this comment.
| availability = "v2.17+" | |
| availability = "v2.18+" |
| triggers: | ||
| - type: honeycomb | ||
| metadata: | ||
| apiKey: <HONEYCOMB_API_KEY> |
There was a problem hiding this comment.
We don't read secret values from trigger metadata.
|
|
||
| ### Parameter List | ||
|
|
||
| - `apiKey` – Honeycomb API key. (Required) |
There was a problem hiding this comment.
We don't read secret values from trigger metadata.
| - `apiKey` – Honeycomb API key. (Required) |
| ### Parameter List | ||
|
|
||
| - `apiKey` – Honeycomb API key. (Required) | ||
| - `dataset` – Name of the Honeycomb dataset to query. (Required) |
There was a problem hiding this comment.
"Required" isn't necessary
| - `dataset` – Name of the Honeycomb dataset to query. (Required) | |
| - `dataset` – Name of the Honeycomb dataset to query. |
| - `limit` – Maximum number of results to retrieve. (Default: 1, Optional) | ||
| - `timeRange` – Time range in seconds for the query. (Default: 60, Optional) | ||
| - `resultField` – Field name in the query result to extract as the metric value. If not set, the first numeric field is used. (Optional) | ||
| - `threshold` – Value at which to scale out the target. (Required) |
There was a problem hiding this comment.
| - `threshold` – Value at which to scale out the target. (Required) | |
| - `threshold` – Value at which to scale out the target. |
| **Maintainer:** @kmoonwright | ||
| **Availability:** KEDA v2.17+ | ||
|
|
There was a problem hiding this comment.
| **Maintainer:** @kmoonwright | |
| **Availability:** KEDA v2.17+ |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions. |
|
This issue has been automatically closed due to inactivity. |
2 participants
Description
This PR adds documentation for the new Honeycomb scaler introduced in kedacore/keda#6896.
It provides a detailed overview of the scaler’s capabilities, configuration parameters, authentication options, and example YAML for end users.
ScaledObjectandTriggerAuthenticationChecklist
Relates to kedacore/keda#6896