Cost Events Audit API
Last updated
Last updated
Note: This feature is in a beta state. It has limitations. Please read the documentation carefully.
Note: This feature is only officially supported on Kubecost Enterprise plans.
The Cost Events Audit API aims to offer improved visibility on recent changes at cluster level and their estimated cost impact.
GET
http://<your-kubecost-address>/model/audit/events
Accesses the most recent cluster events and their predicted cost impact
Name | Type | Description |
---|---|---|
This API is disabled by default. It needs to be manually enabled first through Helm, using the following parameters:
You can also enable the Cost Events Audit API by setting the COST_EVENTS_AUDIT_ENABLED
environment variable to true
.
Changes at cluster level can range from actions triggered by declarative statements submitted by users (e.g. creation of a Deployment) to automated actions (e.g. cluster autoscaling) or performance events. We detect changes that would have an impact on the overall cluster cost using watchers on the Kubernetes API client.
The watchers are tracking change events across all namespaces within the local/primary cluster (the cluster that the instance of Kubecost you are interacting with via HTTP is running on).
Deployment creation
Deployment deletion
StatefulSet creation
StatefulSet deletion
Cost implications of cluster events are handled by passing the Kubernetes spec inferred from the change event to the Kubecost Predict API.
The Cost Events Audit API can return up to 1000 of the most recent cluster events. There is no time expiration limit on the events.
Events returned by the Cost Events Audit API are currently not persisted between Kubecost pod restarts.
The Cost Events Audit API does not track events for clusters other than the local/primary cluster.
count
int
Number of events to return. If unspecified, it returns all events available.
filterNamespaces
string
Comma-separated list of namespaces to match; e.g. namespace-one,namespace-two
will return change events that have occurred only in those two namespaces.
filterEventTypes
string
Filter query by event type. Currently, only add
and delete
are accepted. (more types coming soon) Also accepts comma-separated lists, like add,delete
.
filterResourceTypes
string
Resource type. Currently, only deployment
is accepted. (more types coming soon)
filterTotalCostLowerBound
float
Floating-point value representing the lower bound for the total event cost.
filterTotalCostUpperBound
float
Floating-point value representing the upper bound for the total event cost.