API Reference

AlertSpec defines the desired state of a Coralogix Alert. For more info check - https://coralogix.com/docs/getting-started-with-coralogix-alerts/.

Name	Type	Description	Required
alertType	object	Type of alert. Validations: (has(self.logsImmediate) ? 1 : 0) + (has(self.logsThreshold) ? 1 : 0) + (has(self.logsRatioThreshold) ? 1 : 0) + (has(self.logsTimeRelativeThreshold) ? 1 : 0) + (has(self.metricThreshold) ? 1 : 0) + (has(self.tracingThreshold) ? 1 : 0) + (has(self.tracingImmediate) ? 1 : 0) + (has(self.flow) ? 1 : 0) + (has(self.logsAnomaly) ? 1 : 0) + (has(self.metricAnomaly) ? 1 : 0) + (has(self.logsNewValue) ? 1 : 0) + (has(self.logsUniqueCount) ? 1 : 0) == 1: Exactly one of logsImmediate, logsThreshold, logsRatioThreshold, logsTimeRelativeThreshold, metricThreshold, tracingThreshold, tracingImmediate, flow, logsAnomaly, metricAnomaly, logsNewValue or logsUniqueCount must be set	true
name	string	Name of the alert	true
priority	enum	Priority of the alert. Enum: p1, p2, p3, p4, p5 Default: p5	true
description	string	Description of the alert	false
enabled	boolean	Enable/disable the alert. Default: true	false
entityLabels	map[string]string	Labels attached to the alert.	false
groupByKeys	[]string	Grouping fields for multiple alerts.	false
incidentsSettings	object	Settings for the attached incidents.	false
notificationGroup	object	Where notifications should be sent to. Validations: !(has(self.destinations) && has(self.router)): At most one of Destinations or Router can be set.	false
notificationGroupExcess	[]object	Do not use. Deprecated: Legacy field for when multiple notification groups were attached.	false
phantomMode	boolean	Default: false	false
schedule	object	Alert activity schedule. Will be activated all the time if not specified.	false

Type of alert.

Name	Type	Description	Required
flow	object	Flow alerts chaining multiple alerts together.	false
logsAnomaly	object	Anomaly alerts for logs.	false
logsImmediate	object	Immediate alerts for logs.	false
logsNewValue	object	Alerts when a new log value appears.	false
logsRatioThreshold	object	Alerts for when a log exceeds a defined ratio.	false
logsThreshold	object	Alerts for when a log crosses a threshold.	false
logsTimeRelativeThreshold	object	Alerts are sent when the number of logs matching a filter is more than or less than a threshold over a specific time window.	false
logsUniqueCount	object	Alerts for unique count changes.	false
metricAnomaly	object	Anomaly alerts for metrics.	false
metricThreshold	object	Alerts for when a metric crosses a threshold.	false
tracingImmediate	object	Immediate alerts for traces.	false
tracingThreshold	object	Alerts for when traces crosses a threshold.	false

Flow alerts chaining multiple alerts together.

Name	Type	Description	Required
enforceSuppression	boolean	Default: false	true
stages	[]object		true

Stages to go through.

Name	Type	Description	Required
flowStagesType	object	Type of stage.	true
timeframeMs	integer	Format: int64	true
timeframeType	enum	Type of timeframe. Enum: unspecified, upTo	true

Type of stage.

Name	Type	Description	Required
groups	[]object		true

Flow stage grouping.

Name	Type	Description	Required
alertDefs	[]object	Alerts to group.	true
alertsOp	enum	Operation for the alert. Enum: and, or	true
nextOp	enum	Link to the next alert. Enum: and, or	true

Alert references.

Name	Type	Description	Required
alertRef	object	Reference for an alert, backend or Kubernetes resource Validations: has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	true
not	boolean	Inversion. Default: false	true

Reference for an alert, backend or Kubernetes resource

Name	Type	Description	Required
backendRef	object	Coralogix id reference. Validations: has(self.id) != has(self.name): One of id or name is required	false
resourceRef	object	Kubernetes resource reference.	false

Coralogix id reference.

Name	Type	Description	Required
id	string	Alert ID.	false
name	string	Name of the alert.	false

Kubernetes resource reference.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

Anomaly alerts for logs.

Name	Type	Description	Required
rules	[]object	Rules that match the alert to the data.	true
logsFilter	object	Filter to filter the logs with.	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match to.	true

Condition to match to.

Name	Type	Description	Required
minimumThreshold	int or string	Minimum value Default: 0	true
timeWindow	object	Time window to evaluate.	true

Time window to evaluate.

Name	Type	Description	Required
specificValue	enum	Logs time window type Enum: 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	false

Filter to filter the logs with.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Immediate alerts for logs.

Name	Type	Description	Required
logsFilter	object	Filter to filter the logs with.	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false

Filter to filter the logs with.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Alerts when a new log value appears.

Name	Type	Description	Required
logsFilter	object	Filter to filter the logs with.	true
rules	[]object	Rules that match the alert to the data.	true
notificationPayloadFilter	[]string	Filter for the notification payload.	false

Filter to filter the logs with.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match to	true

Condition to match to

Name	Type	Description	Required
keypathToTrack	string	Where to look	true
timeWindow	object	Which time window.	true

Which time window.

Name	Type	Description	Required
specificValue	enum	Time windows. Enum: 12h, 24h, 48h, 72h, 1w, 1mo, 2mo, 3mo	false

Alerts for when a log exceeds a defined ratio.

Name	Type	Description	Required
denominator	object	A filter for logs.	true
denominatorAlias	string		true
numerator	object	A filter for logs.	true
numeratorAlias	string		true
rules	[]object	Rules that match the alert to the data.	true

A filter for logs.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

A filter for logs.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match	true
override	object	Override alert properties	false

Condition to match

Name	Type	Description	Required
conditionType	enum	Condition to evaluate with. Enum: moreThan, lessThan	true
threshold	int or string	Threshold to pass.	true
timeWindow	object	Time window to evaluate.	true

Time window to evaluate.

Name	Type	Description	Required
specificValue	enum	Time window type. Enum: 5m, 10m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	false

Override alert properties

Name	Type	Description	Required
priority	enum	Priority to override it Enum: p1, p2, p3, p4, p5	true

Alerts for when a log crosses a threshold.

Name	Type	Description	Required
rules	[]object	Rules that match the alert to the data.	true
logsFilter	object	Filter to filter the logs with.	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false
undetectedValuesManagement	object	How to work with undetected values.	false

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match	true
override	object	Alert overrides.	false

Condition to match

Name	Type	Description	Required
logsThresholdConditionType	enum	Condition type. Enum: moreThan, lessThan	true
threshold	int or string	Threshold to match to.	true
timeWindow	object	Time window in which the condition is checked.	true

Time window in which the condition is checked.

Name	Type	Description	Required
specificValue	enum	Logs time window type Enum: 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	false

Alert overrides.

Name	Type	Description	Required
priority	enum	Priority to override it Enum: p1, p2, p3, p4, p5	true

Filter to filter the logs with.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

How to work with undetected values.

Name	Type	Description	Required
autoRetireTimeframe	enum	Automatically retire the alerts after this time. Enum: never, 5m, 10m, 1h, 2h, 6h, 12h, 24h Default: never	true
triggerUndetectedValues	boolean	Deactivate triggering the alert on undetected values. Default: false	true

Alerts are sent when the number of logs matching a filter is more than or less than a threshold over a specific time window.

Name	Type	Description	Required
ignoreInfinity	boolean	Ignore infinity on the threshold value. Default: false	true
logsFilter	object	A filter for logs.	true
rules	[]object	Rules that match the alert to the data.	true
notificationPayloadFilter	[]string	Filter for the notification payload.	false
undetectedValuesManagement	object	How to work with undetected values.	false

A filter for logs.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	The condition to match to.	true
override	object	Override alert properties	false

The condition to match to.

Name	Type	Description	Required
comparedTo	enum	Comparison window. Enum: previousHour, sameHourYesterday, sameHourLastWeek, yesterday, sameDayLastWeek, sameDayLastMonth	true
conditionType	enum	How to compare. Enum: moreThan, lessThan	true
threshold	int or string	Threshold to match.	true

Override alert properties

Name	Type	Description	Required
priority	enum	Priority to override it Enum: p1, p2, p3, p4, p5	true

How to work with undetected values.

Name	Type	Description	Required
autoRetireTimeframe	enum	Automatically retire the alerts after this time. Enum: never, 5m, 10m, 1h, 2h, 6h, 12h, 24h Default: never	true
triggerUndetectedValues	boolean	Deactivate triggering the alert on undetected values. Default: false	true

Alerts for unique count changes.

Name	Type	Description	Required
logsFilter	object	Filter to filter the logs with.	true
rules	[]object	Rules that match the alert to the data.	true
uniqueCountKeypath	string		true
maxUniqueCountPerGroupByKey	integer	Format: int64	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false

Filter to filter the logs with.

Name	Type	Description	Required
simpleFilter	object	Simple lucene filter.	false

Simple lucene filter.

Name	Type	Description	Required
labelFilters	object	Filter for labels.	false
luceneQuery	string	The query.	false

Filter for labels.

Name	Type	Description	Required
applicationName	[]object	Application name to filter for.	false
severity	[]enum	Severity to filter for. Enum: debug, info, warning, error, critical, verbose	false
subsystemName	[]object	Subsystem name to filter for.	false

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

Label filter specifications

Name	Type	Description	Required
operation	enum	Operation to apply. Enum: is, includes, endsWith, startsWith Default: is	true
value	string	The value	true

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match to.	true

Condition to match to.

Name	Type	Description	Required
threshold	integer	Threshold to cross Format: int64	true
timeWindow	object	Time window to evaluate.	true

Time window to evaluate.

Name	Type	Description	Required
specificValue	enum	Time windows for Logs Unique Count Enum: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	true

Anomaly alerts for metrics.

Name	Type	Description	Required
metricFilter	object	PromQL filter for metrics	true
rules	[]object	Rules that match the alert to the data.	true

PromQL filter for metrics

Name	Type	Description	Required
promql	string	PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/	false

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	Condition to match to.	true

Condition to match to.

Name	Type	Description	Required
conditionType	enum	Condition type. Enum: moreThanUsual, lessThanUsual	true
forOverPct	integer	Percentage for the threshold Format: int32 Maximum: 100	true
minNonNullValuesPct	integer	Replace with a number Format: int32 Maximum: 100	true
ofTheLast	object	Time window to match within	true
threshold	int or string	Threshold to clear.	true

Time window to match within

Name	Type	Description	Required
specificValue	enum	Time window type. Enum: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	true

Alerts for when a metric crosses a threshold.

Name	Type	Description	Required
metricFilter	object	Filter for metrics	true
missingValues	object	Missing values strategies.	true
rules	[]object	Rules that match the alert to the data.	true
undetectedValuesManagement	object	How to work with undetected values.	false

Filter for metrics

Name	Type	Description	Required
promql	string	PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/	false

Missing values strategies.

Name	Type	Description	Required
minNonNullValuesPct	integer	Replace with a number Format: int32 Maximum: 100	false
replaceWithZero	boolean	Replace missing values with 0s Default: false	false

Rules that match the alert to the data.

Name	Type	Description	Required
condition	object	Conditions to match for the rule.	true
override	object	Alert property overrides	false

Conditions to match for the rule.

Name	Type	Description	Required
conditionType	enum	ConditionType type. Enum: moreThan, lessThan, moreThanOrEquals, lessThanOrEquals	true
forOverPct	integer	Format: int32 Maximum: 100	true
ofTheLast	object	Time window type. Validations: has(self.specificValue) != has(self.dynamicDuration): Exactly one of specificValue or dynamicDuration is required	true
threshold	int or string		true

Time window type.

Name	Type	Description	Required
dynamicDuration	string		false
specificValue	enum	Time window type. Enum: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	false

Alert property overrides

Name	Type	Description	Required
priority	enum	Priority to override it Enum: p1, p2, p3, p4, p5	true

How to work with undetected values.

Name	Type	Description	Required
autoRetireTimeframe	enum	Automatically retire the alerts after this time. Enum: never, 5m, 10m, 1h, 2h, 6h, 12h, 24h Default: never	true
triggerUndetectedValues	boolean	Deactivate triggering the alert on undetected values. Default: false	true

Immediate alerts for traces.

Name	Type	Description	Required
notificationPayloadFilter	[]string	Filter for the notification payload.	false
tracingFilter	object	A simple tracing filter.	false

A simple tracing filter.

Name	Type	Description	Required
simple	object	Simple tracing filter paired with a latency.	false

Simple tracing filter paired with a latency.

Name	Type	Description	Required
latencyThresholdMs	integer	Format: int64	false
tracingLabelFilters	object	Filter for traces.	false

Filter for traces.

Name	Type	Description	Required
applicationName	[]object		false
operationName	[]object		false
serviceName	[]object		false
spanFields	[]object		false
subsystemName	[]object		false

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter for spans

Name	Type	Description	Required
filterType	object	Filter - values and operation.	true
key	string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Alerts for when traces crosses a threshold.

Name	Type	Description	Required
rules	[]object	Rules that match the alert to the data.	true
notificationPayloadFilter	[]string	Filter for the notification payload.	false
tracingFilter	object	Filter the base collection.	false

The rule to match the alert's conditions.

Name	Type	Description	Required
condition	object	The condition to match to.	true

The condition to match to.

Name	Type	Description	Required
spanAmount	int or string	Threshold amount.	true
timeWindow	object	Time window to evaluate.	true

Time window to evaluate.

Name	Type	Description	Required
specificValue	enum	Time window type for tracing. Enum: 5m, 10m, 15m, 20m, 30m, 1h, 2h, 4h, 6h, 12h, 24h, 36h	false

Filter the base collection.

Name	Type	Description	Required
simple	object	Simple tracing filter paired with a latency.	false

Simple tracing filter paired with a latency.

Name	Type	Description	Required
latencyThresholdMs	integer	Format: int64	false
tracingLabelFilters	object	Filter for traces.	false

Filter for traces.

Name	Type	Description	Required
applicationName	[]object		false
operationName	[]object		false
serviceName	[]object		false
spanFields	[]object		false
subsystemName	[]object		false

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter for spans

Name	Type	Description	Required
filterType	object	Filter - values and operation.	true
key	string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Filter - values and operation.

Name	Type	Description	Required
operation	enum	Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is	true
values	[]string		true

Settings for the attached incidents.

Name	Type	Description	Required
notifyOn	enum	When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly	false
retriggeringPeriod	object	When to re-notify.	false

When to re-notify.

Name	Type	Description	Required
minutes	integer	Delay between re-triggered alerts. Format: int32	false

Where notifications should be sent to.

Name	Type	Description	Required
destinations	[]object	The destinations for notifications (Notification Center feature).	false
groupByKeys	[]string	Group notification by these keys.	false
router	object	The router for notifications (Notification Center feature).	false
webhooks	[]object	Webhooks to trigger for notifications.	false

Connector is the connector for the destination. Should be one of backendRef or resourceRef.

Name	Type	Description	Required
backendRef	object	BackendRef is a reference to a backend resource.	false
resourceRef	object	ResourceRef is a reference to a Kubernetes resource.	false

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

ResourceRef is a reference to a Kubernetes resource.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

The routing configuration to override from the connector/preset for triggered notifications.

Name	Type	Description	Required
configOverrides	object		false

Preset is the preset for the destination. Should be one of backendRef or resourceRef.

Name	Type	Description	Required
backendRef	object	BackendRef is a reference to a backend resource.	false
resourceRef	object	ResourceRef is a reference to a Kubernetes resource.	false

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

ResourceRef is a reference to a Kubernetes resource.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

Optional routing configuration to override from the connector/preset for resolved notifications.

Name	Type	Description	Required
configOverrides	object		false

The router for notifications (Notification Center feature).

Name	Type	Description	Required
notifyOn	enum	When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly	true

Settings for a notification webhook.

Name	Type	Description	Required
integration	object	Type and spec of webhook. Validations: has(self.integrationRef) || has(self.recipients): Exactly one of integrationRef or recipients is required	true
notifyOn	enum	When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly	true
retriggeringPeriod	object	When to re-trigger.	true

Type and spec of webhook.

Name	Type	Description	Required
integrationRef	object	Reference to the webhook. Validations: has(self.backendRef) || has(self.resourceRef): Exactly one of backendRef or resourceRef is required	false
recipients	[]string	Recipients for the notification.	false

Reference to the webhook.

Name	Type	Description	Required
backendRef	object	Backend reference for the outbound webhook. Validations: has(self.id) != has(self.name): One of id or name is required	false
resourceRef	object	Resource reference for use with the alert notification.	false

Backend reference for the outbound webhook.

Name	Type	Description	Required
id	integer	Webhook ID. Format: int32	false
name	string	Name of the webhook.	false

Resource reference for use with the alert notification.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

When to re-trigger.

Name	Type	Description	Required
minutes	integer	Delay between re-triggered alerts. Format: int32	false

Notification group to use for alert notifications.

Name	Type	Description	Required
destinations	[]object	The destinations for notifications (Notification Center feature).	false
groupByKeys	[]string	Group notification by these keys.	false
router	object	The router for notifications (Notification Center feature).	false
webhooks	[]object	Webhooks to trigger for notifications.	false

Connector is the connector for the destination. Should be one of backendRef or resourceRef.

Name	Type	Description	Required
backendRef	object	BackendRef is a reference to a backend resource.	false
resourceRef	object	ResourceRef is a reference to a Kubernetes resource.	false

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

ResourceRef is a reference to a Kubernetes resource.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

The routing configuration to override from the connector/preset for triggered notifications.

Name	Type	Description	Required
configOverrides	object		false

Preset is the preset for the destination. Should be one of backendRef or resourceRef.

Name	Type	Description	Required
backendRef	object	BackendRef is a reference to a backend resource.	false
resourceRef	object	ResourceRef is a reference to a Kubernetes resource.	false

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

ResourceRef is a reference to a Kubernetes resource.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

Optional routing configuration to override from the connector/preset for resolved notifications.

Name	Type	Description	Required
configOverrides	object		false

The router for notifications (Notification Center feature).

Name	Type	Description	Required
notifyOn	enum	When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly	true

Settings for a notification webhook.

Name	Type	Description	Required
integration	object	Type and spec of webhook. Validations: has(self.integrationRef) || has(self.recipients): Exactly one of integrationRef or recipients is required	true
notifyOn	enum	When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly	true
retriggeringPeriod	object	When to re-trigger.	true

Type and spec of webhook.

Name	Type	Description	Required
integrationRef	object	Reference to the webhook. Validations: has(self.backendRef) || has(self.resourceRef): Exactly one of backendRef or resourceRef is required	false
recipients	[]string	Recipients for the notification.	false

Reference to the webhook.

Name	Type	Description	Required
backendRef	object	Backend reference for the outbound webhook. Validations: has(self.id) != has(self.name): One of id or name is required	false
resourceRef	object	Resource reference for use with the alert notification.	false

Backend reference for the outbound webhook.

Name	Type	Description	Required
id	integer	Webhook ID. Format: int32	false
name	string	Name of the webhook.	false

Resource reference for use with the alert notification.

Name	Type	Description	Required
name	string	Name of the resource.	true
namespace	string	Kubernetes namespace.	false

When to re-trigger.

Name	Type	Description	Required
minutes	integer	Delay between re-triggered alerts. Format: int32	false

Alert activity schedule. Will be activated all the time if not specified.

Name	Type	Description	Required
timeZone	string	Time zone. Default: UTC+00	true
activeOn	object	Schedule to have the alert active.	false

Schedule to have the alert active.

Name	Type	Description	Required
dayOfWeek	[]enum	Enum: sunday, monday, tuesday, wednesday, thursday, friday, saturday	true
endTime	string	Time of day. Default: 23:59	false
startTime	string	Time of day. Default: 00:00	false

AlertStatus defines the observed state of Alert

Name	Type	Description	Required
conditions	[]object		false
id	string		false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

AlertSchedulerSpec defines the desired state Coralogix AlertScheduler.

Name	Type	Description	Required
filter	object	Alert Scheduler filter. Exactly one of `metaLabels` or `alerts` can be set. If none of them set, all alerts will be affected. Validations: has(self.metaLabels) != has(self.alerts): Exactly one of metaLabels or alerts must be set	true
name	string	Alert Scheduler name.	true
schedule	object	Alert Scheduler schedule. Exactly one of `oneTime` or `recurring` must be set. Validations: has(self.oneTime) != has(self.recurring): Exactly one of oneTime or recurring must be set	true
description	string	Alert Scheduler description.	false
enabled	boolean	Alert Scheduler enabled. If set to `false`, the alert scheduler will be disabled. True by default. Default: true	false
metaLabels	[]object	Alert Scheduler meta labels.	false

Alert Scheduler filter. Exactly one of metaLabels or alerts can be set. If none of them set, all alerts will be affected.

Name	Type	Description	Required
whatExpression	string	DataPrime query expression - https://coralogix.com/docs/dataprime-query-language.	true
alerts	[]object	Alert references. Conflicts with `metaLabels`.	false
metaLabels	[]object	Alert Scheduler meta labels. Conflicts with `alerts`.	false

Alert custom resource name and namespace. If namespace is not set, the AlertScheduler namespace will be used.

Name	Type	Description	Required
name	string	Name of the resource (not id).	true
namespace	string	Kubernetes namespace.	false

Alert Scheduler schedule. Exactly one of oneTime or recurring must be set.

Name	Type	Description	Required
operation	enum	The operation to perform. Can be `mute` or `activate`. Enum: mute, activate	true
oneTime	object	One-time schedule. Conflicts with `recurring`. Validations: has(self.endTime) != has(self.duration): Exactly one of endTime or duration must be set	false
recurring	object	Recurring schedule. Conflicts with `oneTime`. Validations: has(self.always) != has(self.dynamic): Exactly one of always or dynamic must be set	false

One-time schedule. Conflicts with recurring.

Name	Type	Description	Required
startTime	string	The start time of the time frame. In isodate format. For example, `2021-01-01T00:00:00.000`.	true
timezone	string	The timezone of the time frame. For example, `UTC-4` or `UTC+10`.	true
duration	object	The duration from the start time to wait before the operation is performed. Conflicts with `endTime`.	false
endTime	string	The end time of the time frame. In isodate format. For example, `2021-01-01T00:00:00.000`. Conflicts with `duration`.	false

The duration from the start time to wait before the operation is performed. Conflicts with endTime.

Name	Type	Description	Required
forOver	integer	The number of time units to wait before the alert is triggered. For example, if the frequency is set to `hours` and the value is set to `2`, the alert will be triggered after 2 hours. Format: int32	true
frequency	enum	The time unit to wait before the alert is triggered. Can be `minutes`, `hours` or `days`. Enum: minutes, hours, days	true

Recurring schedule. Conflicts with oneTime.

Name	Type	Description	Required
always	object	Recurring always.	false
dynamic	object	Dynamic schedule.	false

Dynamic schedule.

Name	Type	Description	Required
frequency	object	The rule will be activated in a recurring mode (daily, weekly or monthly).	true
repeatEvery	integer	The rule will be activated in a recurring mode according to the interval. Format: int32	true
timeFrame	object	The time frame of the rule. Validations: has(self.endTime) != has(self.duration): Exactly one of endTime or duration must be set	true
terminationDate	string	The termination date of the rule.	false

The rule will be activated in a recurring mode (daily, weekly or monthly).

Name	Type	Description	Required
daily	object		false
monthly	object		false
weekly	object		false

The time frame of the rule.

Name	Type	Description	Required
startTime	string	The start time of the time frame. In isodate format. For example, `2021-01-01T00:00:00.000`.	true
timezone	string	The timezone of the time frame. For example, `UTC-4` or `UTC+10`.	true
duration	object	The duration from the start time to wait before the operation is performed. Conflicts with `endTime`.	false
endTime	string	The end time of the time frame. In isodate format. For example, `2021-01-01T00:00:00.000`. Conflicts with `duration`.	false

The duration from the start time to wait before the operation is performed. Conflicts with endTime.

Name	Type	Description	Required
forOver	integer	The number of time units to wait before the alert is triggered. For example, if the frequency is set to `hours` and the value is set to `2`, the alert will be triggered after 2 hours. Format: int32	true
frequency	enum	The time unit to wait before the alert is triggered. Can be `minutes`, `hours` or `days`. Enum: minutes, hours, days	true

AlertSchedulerStatus defines the observed state of AlertScheduler.

Name	Type	Description	Required
conditions	[]object		false
id	string		false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

ApiKeySpec defines the desired state of a Coralogix ApiKey.

Name	Type	Description	Required
name	string	Name of the ApiKey	true
owner	object	Owner of the ApiKey. Validations: has(self.userId) != has(self.teamId): Exactly one of userId or teamId must be set	true
active	boolean	Whether the ApiKey Is active. Default: true	false
permissions	[]string	Permissions of the ApiKey	false
presets	[]string	Permission Presets that the ApiKey uses.	false

Owner of the ApiKey.

Name	Type	Description	Required
teamId	integer	Team that owns the key. Format: int32	false
userId	string	User that owns the key.	false

ApiKeyStatus defines the observed state of ApiKey.

Name	Type	Description	Required
conditions	[]object		false
id	string		false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

ArchiveLogsTargetSpec defines the desired state of a Coralogix archive logs target.

Name	Type	Description	Required
ibmCosTarget	object	The IBM COS target configuration.	false
s3Target	object	The S3 target configuration.	false

The IBM COS target configuration.

Name	Type	Description	Required
bucketCrn	string	BucketCrn is the CRN of the IBM COS bucket.	false
bucketType	enum	BucketType defines the type of the bucket. Enum: UNSPECIFIED, EXTERNAL, INTERNAL	false
endpoint	string	Endpoint is the endpoint URL for the IBM COS service.	false
serviceCrn	string	ServiceCrn is the CRN of the service instance.	false

The S3 target configuration.

Name	Type	Description	Required
bucketName	string		false
region	string	The region of the S3 bucket.	false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

ArchiveMetricsTargetSpec defines the desired state of a Coralogix archive logs target.

Name	Type	Description	Required
ibmCosTarget	object	The IBM COS target configuration.	false
resolutionPolicy	object	The resolution policy for the metrics.	false
retentionDays	integer	The retention days for the metrics. Format: int32	false
s3Target	object	The S3 target configuration.	false

The IBM COS target configuration.

Name	Type	Description	Required
bucketCrn	string	BucketCrn is the CRN of the IBM COS bucket.	false
bucketType	enum	BucketType defines the type of the bucket. Enum: UNSPECIFIED, EXTERNAL, INTERNAL	false
endpoint	string	Endpoint is the endpoint URL for the IBM COS service.	false
serviceCrn	string	ServiceCrn is the CRN of the service instance.	false

The resolution policy for the metrics.

Name	Type	Description	Required
fiveMinutesResolution	integer	Format: int32	false
oneHourResolution	integer	Format: int32	false
rawResolution	integer	Format: int32	false

The S3 target configuration.

Name	Type	Description	Required
bucketName	string		false
region	string	The region of the S3 bucket.	false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

ConnectorSpec defines the desired state of Connector. See also https://coralogix.com/docs/user-guides/notification-center/introduction/connectors-explained/

Name	Type	Description	Required
connectorConfig	object	ConnectorConfig is the configuration of the connector.	true
description	string	Description is the description of the connector.	true
name	string	Name is the name of the connector.	true
type	enum	Type is the type of the connector. Can be one of slack, genericHttps, or pagerDuty. Enum: slack, genericHttps, pagerDuty	true
configOverrides	[]object	ConfigOverrides are the entity type config overrides for the connector.	false

ConnectorConfig is the configuration of the connector.

Name	Type	Description	Required
fields	[]object	Fields are the fields of the connector config.	true

ConnectorStatus defines the observed state of Connector.

Name	Type	Description	Required
conditions	[]object		false
id	string		false

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

CustomRoleSpec defines the desired state of a Coralogix Custom Role.

Name	Type	Description	Required
description	string	Description of the custom role.	true
name	string	Name of the custom role.	true
parentRoleName	string	Parent role name.	true
permissions	[]string	Custom role permissions.	true