Skip to content

KEP97: proposal for supporting aggregation functions for analysis values #106

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

Open
bacherfl wants to merge 2 commits into
base: main
Choose a base branch
from
Open

KEP97: proposal for supporting aggregation functions for analysis values #106

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39729ef
proposal for supporting aggregation functions for analysis values
bacherfl Jan 24, 2024
34c7f90
Update text/0097-support-aggregation-functions-in-analysis-value-temp…
bacherfl Feb 1, 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
34 changes: 34 additions & 0 deletions text/0097-support-aggregation-functions-in-analysis-value-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# KEP 97 Support Aggregation functions in AnalysisValueTemplate

## Motivation

Currently, only the `KeptnMetrics` CRD supports the use of aggregation functions
(see [here](https://github.com/keptn/lifecycle-toolkit/blob/5fac158a7ffed67f7502fe03683138d717ea1acd/metrics-operator/api/v1beta1/keptnmetric_types.go#L76)).
Supporting the same aggregation functions might also be useful for `AnalysisValueTemplates` as well,
to better support queries that return multiple data points of a time series.
This way, the provider returning the results for the AnalysisValueTemplate can check whether
there are multiple data points in the result for the query and apply the aggregation function in that case.

## Proposed Design

The proposal is to extend the specification of the `AnalysisValueTemplates` with an `spec.aggregation` field,
similar to what is available in the `KeptnMetric` (see [specification](https://keptn.sh/latest/docs/reference/api-reference/metrics/v1beta1/#rangespec)).
Using this field, the metrics operator can inspect the result for an analysis value returned by a metrics provider.,
and, if the aggregation function has been defined, use this function to aggregate the returned result if this is
an array of multiple values, as opposed to a single value.

## Benefits

- Unified way of defining aggregation functions for query results containing multiple time series data points
- More flexibility in terms of which queries can be used for each provider

## Open Questions

One argument that might speak against this feature is that usually monitoring provider
APIs support aggregation functions on their end already,
such as e.g. [DQL](https://docs.dynatrace.com/docs/platform/grail/dynatrace-query-language/functions#aggregation-functions),
so it might be sufficient to adapt queries for AnalysisValueTemplates to make use of the monitoring provider's aggregation capabilities.

## References

See the following Github discussion for more context: https://github.com/keptn/lifecycle-toolkit/issues/2650#issuecomment-1906038916