API Reference
Packages:
coralogix.com/v1beta1
Alert
Samples:
- flow.yaml
- logs_anomaly.yaml
- logs_immediate.yaml
- logs_new_value.yaml
- logs_ratio_threshold.yaml
- logs_threshold.yaml
- logs_time_relative_threshold.yaml
- logs_unique_count.yaml
- metric_anomaly.yaml
- metric_threshold.yaml
- tracing_immediate.yaml
- tracing_threshold.yaml
Alert is the Schema for the Alerts API.
Note that this is only for the latest version of the Alerts API. If your account has been created before March 2025, make sure that your account has been migrated before using advanced features of alerts.
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1beta1 | true |
kind | string | Alert | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | AlertSpec defines the desired state of a Coralogix Alert. For more info check - https://coralogix.com/docs/getting-started-with-coralogix-alerts/. Validations: | false |
status | object | AlertStatus defines the observed state of Alert | false |
Alert.spec
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: | 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: | 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 |
Alert.spec.alertType
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 |
Alert.spec.alertType.flow
Flow alerts chaining multiple alerts together.
Name | Type | Description | Required |
---|---|---|---|
enforceSuppression | boolean | Default: false | true |
stages | []object | true |
Alert.spec.alertType.flow.stages[index]
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 |
Alert.spec.alertType.flow.stages[index].flowStagesType
Type of stage.
Name | Type | Description | Required |
---|---|---|---|
groups | []object | true |
Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index]
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.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index]
Alert references.
Name | Type | Description | Required |
---|---|---|---|
alertRef | object | Reference for an alert, backend or Kubernetes resource Validations: | true |
not | boolean | Inversion. Default: false | true |
Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index].alertRef
Reference for an alert, backend or Kubernetes resource
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Coralogix id reference. Validations: | false |
resourceRef | object | Kubernetes resource reference. | false |
Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index].alertRef.backendRef
Coralogix id reference.
Name | Type | Description | Required |
---|---|---|---|
id | string | Alert ID. | false |
name | string | Name of the alert. | false |
Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index].alertRef.resourceRef
Kubernetes resource reference.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.alertType.logsAnomaly
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 |
Alert.spec.alertType.logsAnomaly.rules[index]
The rule to match the alert's conditions.
Name | Type | Description | Required |
---|---|---|---|
condition | object | Condition to match to. | true |
Alert.spec.alertType.logsAnomaly.rules[index].condition
Condition to match to.
Name | Type | Description | Required |
---|---|---|---|
minimumThreshold | int or string | Minimum value Default: 0 | true |
timeWindow | object | Time window to evaluate. | true |
Alert.spec.alertType.logsAnomaly.rules[index].condition.timeWindow
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 |
Alert.spec.alertType.logsAnomaly.logsFilter
Filter to filter the logs with.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsAnomaly.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsAnomaly.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsAnomaly.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsAnomaly.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsImmediate
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 |
Alert.spec.alertType.logsImmediate.logsFilter
Filter to filter the logs with.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsImmediate.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsImmediate.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsImmediate.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsImmediate.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsNewValue
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 |
Alert.spec.alertType.logsNewValue.logsFilter
Filter to filter the logs with.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsNewValue.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsNewValue.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsNewValue.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsNewValue.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsNewValue.rules[index]
The rule to match the alert's conditions.
Name | Type | Description | Required |
---|---|---|---|
condition | object | Condition to match to | true |
Alert.spec.alertType.logsNewValue.rules[index].condition
Condition to match to
Name | Type | Description | Required |
---|---|---|---|
keypathToTrack | string | Where to look | true |
timeWindow | object | Which time window. | true |
Alert.spec.alertType.logsNewValue.rules[index].condition.timeWindow
Which time window.
Name | Type | Description | Required |
---|---|---|---|
specificValue | enum | Time windows. Enum: 12h, 24h, 48h, 72h, 1w, 1mo, 2mo, 3mo | false |
Alert.spec.alertType.logsRatioThreshold
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 |
Alert.spec.alertType.logsRatioThreshold.denominator
A filter for logs.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsRatioThreshold.denominator.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsRatioThreshold.denominator.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsRatioThreshold.denominator.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsRatioThreshold.denominator.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsRatioThreshold.numerator
A filter for logs.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsRatioThreshold.numerator.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsRatioThreshold.numerator.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsRatioThreshold.numerator.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsRatioThreshold.numerator.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsRatioThreshold.rules[index]
Alert.spec.alertType.logsRatioThreshold.rules[index].condition
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 |
Alert.spec.alertType.logsRatioThreshold.rules[index].condition.timeWindow
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 |
Alert.spec.alertType.logsRatioThreshold.rules[index].override
Override alert properties
Name | Type | Description | Required |
---|---|---|---|
priority | enum | Priority to override it Enum: p1, p2, p3, p4, p5 | true |
Alert.spec.alertType.logsThreshold
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 |
Alert.spec.alertType.logsThreshold.rules[index]
Alert.spec.alertType.logsThreshold.rules[index].condition
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 |
Alert.spec.alertType.logsThreshold.rules[index].condition.timeWindow
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.spec.alertType.logsThreshold.rules[index].override
Alert overrides.
Name | Type | Description | Required |
---|---|---|---|
priority | enum | Priority to override it Enum: p1, p2, p3, p4, p5 | true |
Alert.spec.alertType.logsThreshold.logsFilter
Filter to filter the logs with.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsThreshold.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsThreshold.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsThreshold.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsThreshold.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsThreshold.undetectedValuesManagement
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 |
Alert.spec.alertType.logsTimeRelativeThreshold
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 |
Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter
A filter for logs.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsTimeRelativeThreshold.rules[index]
Alert.spec.alertType.logsTimeRelativeThreshold.rules[index].condition
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 |
Alert.spec.alertType.logsTimeRelativeThreshold.rules[index].override
Override alert properties
Name | Type | Description | Required |
---|---|---|---|
priority | enum | Priority to override it Enum: p1, p2, p3, p4, p5 | true |
Alert.spec.alertType.logsTimeRelativeThreshold.undetectedValuesManagement
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 |
Alert.spec.alertType.logsUniqueCount
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 |
Alert.spec.alertType.logsUniqueCount.logsFilter
Filter to filter the logs with.
Name | Type | Description | Required |
---|---|---|---|
simpleFilter | object | Simple lucene filter. | false |
Alert.spec.alertType.logsUniqueCount.logsFilter.simpleFilter
Simple lucene filter.
Name | Type | Description | Required |
---|---|---|---|
labelFilters | object | Filter for labels. | false |
luceneQuery | string | The query. | false |
Alert.spec.alertType.logsUniqueCount.logsFilter.simpleFilter.labelFilters
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 |
Alert.spec.alertType.logsUniqueCount.logsFilter.simpleFilter.labelFilters.applicationName[index]
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 |
Alert.spec.alertType.logsUniqueCount.logsFilter.simpleFilter.labelFilters.subsystemName[index]
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 |
Alert.spec.alertType.logsUniqueCount.rules[index]
The rule to match the alert's conditions.
Name | Type | Description | Required |
---|---|---|---|
condition | object | Condition to match to. | true |
Alert.spec.alertType.logsUniqueCount.rules[index].condition
Condition to match to.
Name | Type | Description | Required |
---|---|---|---|
threshold | integer | Threshold to cross Format: int64 | true |
timeWindow | object | Time window to evaluate. | true |
Alert.spec.alertType.logsUniqueCount.rules[index].condition.timeWindow
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 |
Alert.spec.alertType.metricAnomaly
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 |
Alert.spec.alertType.metricAnomaly.metricFilter
PromQL filter for metrics
Name | Type | Description | Required |
---|---|---|---|
promql | string | PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/ | false |
Alert.spec.alertType.metricAnomaly.rules[index]
The rule to match the alert's conditions.
Name | Type | Description | Required |
---|---|---|---|
condition | object | Condition to match to. | true |
Alert.spec.alertType.metricAnomaly.rules[index].condition
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 |
Alert.spec.alertType.metricAnomaly.rules[index].condition.ofTheLast
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 |
Alert.spec.alertType.metricThreshold
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 |
Alert.spec.alertType.metricThreshold.metricFilter
Filter for metrics
Name | Type | Description | Required |
---|---|---|---|
promql | string | PromQL query: https://coralogix.com/academy/mastering-metrics-in-coralogix/promql-fundamentals/ | false |
Alert.spec.alertType.metricThreshold.missingValues
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 |
Alert.spec.alertType.metricThreshold.rules[index]
Alert.spec.alertType.metricThreshold.rules[index].condition
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: | true |
threshold | int or string | true |
Alert.spec.alertType.metricThreshold.rules[index].condition.ofTheLast
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.spec.alertType.metricThreshold.rules[index].override
Alert property overrides
Name | Type | Description | Required |
---|---|---|---|
priority | enum | Priority to override it Enum: p1, p2, p3, p4, p5 | true |
Alert.spec.alertType.metricThreshold.undetectedValuesManagement
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 |
Alert.spec.alertType.tracingImmediate
Immediate alerts for traces.
Name | Type | Description | Required |
---|---|---|---|
notificationPayloadFilter | []string | Filter for the notification payload. | false |
tracingFilter | object | A simple tracing filter. | false |
Alert.spec.alertType.tracingImmediate.tracingFilter
A simple tracing filter.
Name | Type | Description | Required |
---|---|---|---|
simple | object | Simple tracing filter paired with a latency. | false |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple
Simple tracing filter paired with a latency.
Name | Type | Description | Required |
---|---|---|---|
latencyThresholdMs | integer | Format: int64 | false |
tracingLabelFilters | object | Filter for traces. | false |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters
Filter for traces.
Name | Type | Description | Required |
---|---|---|---|
applicationName | []object | false | |
operationName | []object | false | |
serviceName | []object | false | |
spanFields | []object | false | |
subsystemName | []object | false |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.applicationName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.operationName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.serviceName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.spanFields[index]
Filter for spans
Name | Type | Description | Required |
---|---|---|---|
filterType | object | Filter - values and operation. | true |
key | string | true |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.spanFields[index].filterType
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters.subsystemName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingThreshold
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 |
Alert.spec.alertType.tracingThreshold.rules[index]
The rule to match the alert's conditions.
Name | Type | Description | Required |
---|---|---|---|
condition | object | The condition to match to. | true |
Alert.spec.alertType.tracingThreshold.rules[index].condition
The condition to match to.
Name | Type | Description | Required |
---|---|---|---|
spanAmount | int or string | Threshold amount. | true |
timeWindow | object | Time window to evaluate. | true |
Alert.spec.alertType.tracingThreshold.rules[index].condition.timeWindow
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 |
Alert.spec.alertType.tracingThreshold.tracingFilter
Filter the base collection.
Name | Type | Description | Required |
---|---|---|---|
simple | object | Simple tracing filter paired with a latency. | false |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple
Simple tracing filter paired with a latency.
Name | Type | Description | Required |
---|---|---|---|
latencyThresholdMs | integer | Format: int64 | false |
tracingLabelFilters | object | Filter for traces. | false |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters
Filter for traces.
Name | Type | Description | Required |
---|---|---|---|
applicationName | []object | false | |
operationName | []object | false | |
serviceName | []object | false | |
spanFields | []object | false | |
subsystemName | []object | false |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.applicationName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.operationName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.serviceName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.spanFields[index]
Filter for spans
Name | Type | Description | Required |
---|---|---|---|
filterType | object | Filter - values and operation. | true |
key | string | true |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.spanFields[index].filterType
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters.subsystemName[index]
Filter - values and operation.
Name | Type | Description | Required |
---|---|---|---|
operation | enum | Tracing filter operations. Enum: includes, endsWith, startsWith, isNot, is | true |
values | []string | true |
Alert.spec.incidentsSettings
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 |
Alert.spec.incidentsSettings.retriggeringPeriod
When to re-notify.
Name | Type | Description | Required |
---|---|---|---|
minutes | integer | Delay between re-triggered alerts. Format: int32 | false |
Alert.spec.notificationGroup
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 |
Alert.spec.notificationGroup.destinations[index]
Name | Type | Description | Required |
---|---|---|---|
connector | object | Connector is the connector for the destination. Should be one of backendRef or resourceRef. Validations: | true |
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
triggeredRoutingOverrides | object | The routing configuration to override from the connector/preset for triggered notifications. | true |
preset | object | Preset is the preset for the destination. Should be one of backendRef or resourceRef. Validations: | false |
resolvedRoutingOverrides | object | Optional routing configuration to override from the connector/preset for resolved notifications. | false |
Alert.spec.notificationGroup.destinations[index].connector
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 |
Alert.spec.notificationGroup.destinations[index].connector.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
Alert.spec.notificationGroup.destinations[index].connector.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroup.destinations[index].triggeredRoutingOverrides
The routing configuration to override from the connector/preset for triggered notifications.
Name | Type | Description | Required |
---|---|---|---|
configOverrides | object | false |
Alert.spec.notificationGroup.destinations[index].triggeredRoutingOverrides.configOverrides
Name | Type | Description | Required |
---|---|---|---|
payloadType | string | The ID of the output schema to use for routing notifications | true |
connectorConfigFields | []object | Connector configuration fields. | false |
messageConfigFields | []object | Notification message configuration fields. | false |
Alert.spec.notificationGroup.destinations[index].triggeredRoutingOverrides.configOverrides.connectorConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroup.destinations[index].triggeredRoutingOverrides.configOverrides.messageConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroup.destinations[index].preset
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 |
Alert.spec.notificationGroup.destinations[index].preset.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
Alert.spec.notificationGroup.destinations[index].preset.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroup.destinations[index].resolvedRoutingOverrides
Optional routing configuration to override from the connector/preset for resolved notifications.
Name | Type | Description | Required |
---|---|---|---|
configOverrides | object | false |
Alert.spec.notificationGroup.destinations[index].resolvedRoutingOverrides.configOverrides
Name | Type | Description | Required |
---|---|---|---|
payloadType | string | The ID of the output schema to use for routing notifications | true |
connectorConfigFields | []object | Connector configuration fields. | false |
messageConfigFields | []object | Notification message configuration fields. | false |
Alert.spec.notificationGroup.destinations[index].resolvedRoutingOverrides.configOverrides.connectorConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroup.destinations[index].resolvedRoutingOverrides.configOverrides.messageConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroup.router
The router for notifications (Notification Center feature).
Name | Type | Description | Required |
---|---|---|---|
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
Alert.spec.notificationGroup.webhooks[index]
Settings for a notification webhook.
Name | Type | Description | Required |
---|---|---|---|
integration | object | Type and spec of webhook. Validations: | true |
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
retriggeringPeriod | object | When to re-trigger. | true |
Alert.spec.notificationGroup.webhooks[index].integration
Type and spec of webhook.
Name | Type | Description | Required |
---|---|---|---|
integrationRef | object | Reference to the webhook. Validations: | false |
recipients | []string | Recipients for the notification. | false |
Alert.spec.notificationGroup.webhooks[index].integration.integrationRef
Reference to the webhook.
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Backend reference for the outbound webhook. Validations: | false |
resourceRef | object | Resource reference for use with the alert notification. | false |
Alert.spec.notificationGroup.webhooks[index].integration.integrationRef.backendRef
Backend reference for the outbound webhook.
Name | Type | Description | Required |
---|---|---|---|
id | integer | Webhook ID. Format: int32 | false |
name | string | Name of the webhook. | false |
Alert.spec.notificationGroup.webhooks[index].integration.integrationRef.resourceRef
Resource reference for use with the alert notification.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroup.webhooks[index].retriggeringPeriod
When to re-trigger.
Name | Type | Description | Required |
---|---|---|---|
minutes | integer | Delay between re-triggered alerts. Format: int32 | false |
Alert.spec.notificationGroupExcess[index]
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 |
Alert.spec.notificationGroupExcess[index].destinations[index]
Name | Type | Description | Required |
---|---|---|---|
connector | object | Connector is the connector for the destination. Should be one of backendRef or resourceRef. Validations: | true |
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
triggeredRoutingOverrides | object | The routing configuration to override from the connector/preset for triggered notifications. | true |
preset | object | Preset is the preset for the destination. Should be one of backendRef or resourceRef. Validations: | false |
resolvedRoutingOverrides | object | Optional routing configuration to override from the connector/preset for resolved notifications. | false |
Alert.spec.notificationGroupExcess[index].destinations[index].connector
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 |
Alert.spec.notificationGroupExcess[index].destinations[index].connector.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
Alert.spec.notificationGroupExcess[index].destinations[index].connector.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroupExcess[index].destinations[index].triggeredRoutingOverrides
The routing configuration to override from the connector/preset for triggered notifications.
Name | Type | Description | Required |
---|---|---|---|
configOverrides | object | false |
Alert.spec.notificationGroupExcess[index].destinations[index].triggeredRoutingOverrides.configOverrides
Name | Type | Description | Required |
---|---|---|---|
payloadType | string | The ID of the output schema to use for routing notifications | true |
connectorConfigFields | []object | Connector configuration fields. | false |
messageConfigFields | []object | Notification message configuration fields. | false |
Alert.spec.notificationGroupExcess[index].destinations[index].triggeredRoutingOverrides.configOverrides.connectorConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroupExcess[index].destinations[index].triggeredRoutingOverrides.configOverrides.messageConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroupExcess[index].destinations[index].preset
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 |
Alert.spec.notificationGroupExcess[index].destinations[index].preset.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
Alert.spec.notificationGroupExcess[index].destinations[index].preset.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroupExcess[index].destinations[index].resolvedRoutingOverrides
Optional routing configuration to override from the connector/preset for resolved notifications.
Name | Type | Description | Required |
---|---|---|---|
configOverrides | object | false |
Alert.spec.notificationGroupExcess[index].destinations[index].resolvedRoutingOverrides.configOverrides
Name | Type | Description | Required |
---|---|---|---|
payloadType | string | The ID of the output schema to use for routing notifications | true |
connectorConfigFields | []object | Connector configuration fields. | false |
messageConfigFields | []object | Notification message configuration fields. | false |
Alert.spec.notificationGroupExcess[index].destinations[index].resolvedRoutingOverrides.configOverrides.connectorConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroupExcess[index].destinations[index].resolvedRoutingOverrides.configOverrides.messageConfigFields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | The name of the configuration field. | true |
template | string | The template for the configuration field. | true |
Alert.spec.notificationGroupExcess[index].router
The router for notifications (Notification Center feature).
Name | Type | Description | Required |
---|---|---|---|
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
Alert.spec.notificationGroupExcess[index].webhooks[index]
Settings for a notification webhook.
Name | Type | Description | Required |
---|---|---|---|
integration | object | Type and spec of webhook. Validations: | true |
notifyOn | enum | When to notify. Enum: triggeredOnly, triggeredAndResolved Default: triggeredOnly | true |
retriggeringPeriod | object | When to re-trigger. | true |
Alert.spec.notificationGroupExcess[index].webhooks[index].integration
Type and spec of webhook.
Name | Type | Description | Required |
---|---|---|---|
integrationRef | object | Reference to the webhook. Validations: | false |
recipients | []string | Recipients for the notification. | false |
Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef
Reference to the webhook.
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Backend reference for the outbound webhook. Validations: | false |
resourceRef | object | Resource reference for use with the alert notification. | false |
Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef.backendRef
Backend reference for the outbound webhook.
Name | Type | Description | Required |
---|---|---|---|
id | integer | Webhook ID. Format: int32 | false |
name | string | Name of the webhook. | false |
Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef.resourceRef
Resource reference for use with the alert notification.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource. | true |
namespace | string | Kubernetes namespace. | false |
Alert.spec.notificationGroupExcess[index].webhooks[index].retriggeringPeriod
When to re-trigger.
Name | Type | Description | Required |
---|---|---|---|
minutes | integer | Delay between re-triggered alerts. Format: int32 | false |
Alert.spec.schedule
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 |
Alert.spec.schedule.activeOn
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 |
Alert.status
AlertStatus defines the observed state of Alert
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Alert.status.conditions[index]
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 |
coralogix.com/v1alpha1
AlertScheduler
Samples:
AlertScheduler is the Schema for the AlertSchedulers API. It is used to suppress or activate alerts based on a schedule. See also https://coralogix.com/docs/user-guides/alerting/alert-suppression-rules/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | AlertScheduler | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | AlertSchedulerSpec defines the desired state Coralogix AlertScheduler. | false |
status | object | AlertSchedulerStatus defines the observed state of AlertScheduler. | false |
AlertScheduler.spec
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: | true |
name | string | Alert Scheduler name. | true |
schedule | object | Alert Scheduler schedule. Exactly one of `oneTime` or `recurring` must be set. Validations: | 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 |
AlertScheduler.spec.filter
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 |
AlertScheduler.spec.filter.alerts[index]
Name | Type | Description | Required |
---|---|---|---|
resourceRef | object | Alert custom resource name and namespace. If namespace is not set, the AlertScheduler namespace will be used. | true |
AlertScheduler.spec.filter.alerts[index].resourceRef
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 |
AlertScheduler.spec.filter.metaLabels[index]
Name | Type | Description | Required |
---|---|---|---|
key | string | true | |
value | string | false |
AlertScheduler.spec.schedule
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: | false |
recurring | object | Recurring schedule. Conflicts with `oneTime`. Validations: | false |
AlertScheduler.spec.schedule.oneTime
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 |
AlertScheduler.spec.schedule.oneTime.duration
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 |
AlertScheduler.spec.schedule.recurring
Recurring schedule. Conflicts with oneTime
.
Name | Type | Description | Required |
---|---|---|---|
always | object | Recurring always. | false |
dynamic | object | Dynamic schedule. | false |
AlertScheduler.spec.schedule.recurring.dynamic
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: | true |
terminationDate | string | The termination date of the rule. | false |
AlertScheduler.spec.schedule.recurring.dynamic.frequency
AlertScheduler.spec.schedule.recurring.dynamic.frequency.monthly
Name | Type | Description | Required |
---|---|---|---|
days | []integer | The days of the month to activate the rule. | true |
AlertScheduler.spec.schedule.recurring.dynamic.frequency.weekly
Name | Type | Description | Required |
---|---|---|---|
days | []enum | The days of the week to activate the rule. Enum: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday | true |
AlertScheduler.spec.schedule.recurring.dynamic.timeFrame
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 |
AlertScheduler.spec.schedule.recurring.dynamic.timeFrame.duration
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 |
AlertScheduler.spec.metaLabels[index]
Name | Type | Description | Required |
---|---|---|---|
key | string | true | |
value | string | false |
AlertScheduler.status
AlertSchedulerStatus defines the observed state of AlertScheduler.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
AlertScheduler.status.conditions[index]
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 |
ApiKey
Samples:
ApiKey is the Schema for the ApiKeys API. See also https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | ApiKey | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ApiKeySpec defines the desired state of a Coralogix ApiKey. Validations: | false |
status | object | ApiKeyStatus defines the observed state of ApiKey. | false |
ApiKey.spec
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: | 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 |
ApiKey.spec.owner
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 |
ApiKey.status
ApiKeyStatus defines the observed state of ApiKey.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
ApiKey.status.conditions[index]
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 |
ArchiveLogsTarget
Samples:
ArchiveLogsTarget is the Schema for the Archive Logs API. See also https://coralogix.com/docs/user-guides/account-management/user-management/create-roles-and-permissions/
Added in v0.5.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | ArchiveLogsTarget | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ArchiveLogsTargetSpec defines the desired state of a Coralogix archive logs target. Validations: | false |
status | object | false |
ArchiveLogsTarget.spec
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 |
ArchiveLogsTarget.spec.ibmCosTarget
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 |
ArchiveLogsTarget.spec.s3Target
The S3 target configuration.
Name | Type | Description | Required |
---|---|---|---|
bucketName | string | false | |
region | string | The region of the S3 bucket. | false |
ArchiveLogsTarget.status
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | ID is the identifier of the archive logs target. | false |
ArchiveLogsTarget.status.conditions[index]
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 |
ArchiveMetricsTarget
Samples:
ArchiveLogsTarget is the Schema for the archive logs targets API. See also https://coralogix.com/docs/archive-s3-bucket-forever
Added in v0.5.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | ArchiveMetricsTarget | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ArchiveMetricsTargetSpec defines the desired state of a Coralogix archive logs target. Validations: | false |
status | object | false |
ArchiveMetricsTarget.spec
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 |
ArchiveMetricsTarget.spec.ibmCosTarget
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 |
ArchiveMetricsTarget.spec.resolutionPolicy
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 |
ArchiveMetricsTarget.spec.s3Target
The S3 target configuration.
Name | Type | Description | Required |
---|---|---|---|
bucketName | string | false | |
region | string | The region of the S3 bucket. | false |
ArchiveMetricsTarget.status
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | ID is the identifier of the archive metrics target. | false |
ArchiveMetricsTarget.status.conditions[index]
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 |
Connector
Samples:
Connector is the Schema for the connectors API.
Added in v0.4.0 NOTE: This CRD exposes a new feature and may have breaking changes in future releases.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Connector | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ConnectorSpec defines the desired state of Connector. See also https://coralogix.com/docs/user-guides/notification-center/introduction/connectors-explained/ | false |
status | object | ConnectorStatus defines the observed state of Connector. | false |
Connector.spec
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 |
Connector.spec.connectorConfig
ConnectorConfig is the configuration of the connector.
Name | Type | Description | Required |
---|---|---|---|
fields | []object | Fields are the fields of the connector config. | true |
Connector.spec.connectorConfig.fields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | FieldName is the name of the field. e.g. "channel" for slack. | true |
value | string | Value is the value of the field. | true |
Connector.spec.configOverrides[index]
Name | Type | Description | Required |
---|---|---|---|
entityType | enum | EntityType is the entity type for the config override. Should equal "alerts". Enum: alerts | true |
fields | []object | Fields are the templated fields for the config override. | false |
Connector.spec.configOverrides[index].fields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | FieldName is the name of the field. e.g. "channel" for slack. | true |
template | string | Template is the template for the field. | true |
Connector.status
ConnectorStatus defines the observed state of Connector.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Connector.status.conditions[index]
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 |
CustomRole
Samples:
CustomRole is the Schema for the CustomRoles API. See also https://coralogix.com/docs/user-guides/account-management/user-management/create-roles-and-permissions/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | CustomRole | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | CustomRoleSpec defines the desired state of a Coralogix Custom Role. | false |
status | object | CustomRoleStatus defines the observed state of CustomRole. | false |
CustomRole.spec
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 |
CustomRole.status
CustomRoleStatus defines the observed state of CustomRole.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
CustomRole.status.conditions[index]
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 |
Dashboard
Samples:
Dashboard is the Schema for the dashboards API.
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Dashboard | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | DashboardSpec defines the desired state of Dashboard. See also https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ Validations: | false |
status | object | DashboardStatus defines the observed state of Dashboard. | false |
Dashboard.spec
DashboardSpec defines the desired state of Dashboard. See also https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/
Name | Type | Description | Required |
---|---|---|---|
configMapRef | object | model from configmap | false |
folderRef | object | Validations: | false |
gzipJson | string | GzipJson the model's JSON compressed with Gzip. Base64-encoded when in YAML. Format: byte | false |
json | string | false |
Dashboard.spec.configMapRef
model from configmap
Name | Type | Description | Required |
---|---|---|---|
key | string | The key to select. | true |
name | string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names Default: | false |
optional | boolean | Specify whether the ConfigMap or its key must be defined | false |
Dashboard.spec.folderRef
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Validations: | false |
resourceRef | object | Reference to a Coralogix resource within the cluster. | false |
Dashboard.spec.folderRef.backendRef
Name | Type | Description | Required |
---|---|---|---|
id | string | Reference to a folder by its backend's ID. | false |
path | string | Reference to a folder by its path (<parent-folder-name-1>/<parent-folder-name-2>/<folder-name>). | false |
Dashboard.spec.folderRef.resourceRef
Reference to a Coralogix resource within the cluster.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
Dashboard.status
DashboardStatus defines the observed state of Dashboard.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Dashboard.status.conditions[index]
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 |
DashboardsFolder
Samples:
DashboardsFolder is the Schema for the DashboardsFolders API.
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | DashboardsFolder | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | DashboardsFolderSpec defines the desired state of Dashboard Folder. See also https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/ Validations: | false |
status | object | DashboardsFolderStatus defines the observed state of DashboardsFolder. | false |
DashboardsFolder.spec
DashboardsFolderSpec defines the desired state of Dashboard Folder. See also https://coralogix.com/docs/user-guides/custom-dashboards/getting-started/
Name | Type | Description | Required |
---|---|---|---|
name | string | true | |
customId | string | A custom ID for the folder. If not provided, a random UUID will be generated. The custom ID is immutable. Validations: | false |
parentFolderId | string | A reference to an existing folder by its backend's ID. | false |
parentFolderRef | object | A reference to an existing DashboardsFolder CR. | false |
DashboardsFolder.spec.parentFolderRef
A reference to an existing DashboardsFolder CR.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
DashboardsFolder.status
DashboardsFolderStatus defines the observed state of DashboardsFolder.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
DashboardsFolder.status.conditions[index]
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 |
Events2Metric
Samples:
See also https://coralogix.com/docs/user-guides/monitoring-and-insights/events2metrics/
Added in v0.5.0 Events2Metric is the Schema for the events2metrics API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Events2Metric | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | Events2MetricSpec defines the desired state of Events2Metric. | false |
status | object | Events2MetricStatus defines the observed state of Events2Metric. | false |
Events2Metric.spec
Events2MetricSpec defines the desired state of Events2Metric.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the E2M | true |
query | object | Spans or logs type query Validations: | true |
description | string | Description of the E2M | false |
metricFields | []object | E2M metric fields | false |
metricLabels | []object | E2M metric labels | false |
permutationsLimit | integer | Represents the limit of the permutations Format: int32 | false |
Events2Metric.spec.query
Events2Metric.spec.query.logs
Logs query for logs2metrics E2M
Name | Type | Description | Required |
---|---|---|---|
alias | string | alias | false |
applicationNameFilters | []string | application name filters | false |
lucene | string | lucene query | false |
severityFilters | []enum | severity type filters Enum: debug, verbose, info, warn, error, critical | false |
subsystemNameFilters | []string | subsystem names filters | false |
Events2Metric.spec.query.spans
Spans query for spans2metrics E2M
Name | Type | Description | Required |
---|---|---|---|
actionFilters | []string | action filters | false |
applicationNameFilters | []string | application name filters | false |
lucene | string | lucene query | false |
serviceFilters | []string | service filters | false |
subsystemNameFilters | []string | subsystem name filters | false |
Events2Metric.spec.metricFields[index]
Name | Type | Description | Required |
---|---|---|---|
sourceField | string | Source field | true |
targetBaseMetricName | string | Target metric field alias name | true |
aggregations | []object | Represents Aggregation type list | false |
Events2Metric.spec.metricFields[index].aggregations[index]
Name | Type | Description | Required |
---|---|---|---|
aggMetadata | object | Aggregate metadata, samples or histogram type Types that are valid to be assigned to AggMetadata: AggregationTypeSamples, AggregationTypeHistogram Validations: | true |
aggType | enum | Aggregation type Enum: min, max, count, avg, sum, histogram, samples | true |
enabled | boolean | Is enabled. True by default Default: true | true |
targetMetricName | string | Target metric field alias name | true |
Events2Metric.spec.metricFields[index].aggregations[index].aggMetadata
Events2Metric.spec.metricFields[index].aggregations[index].aggMetadata.histogram
E2M aggregate histogram type metadata
Name | Type | Description | Required |
---|---|---|---|
buckets | []int or string | Buckets of the E2M | true |
Events2Metric.spec.metricFields[index].aggregations[index].aggMetadata.samples
E2M sample type metadata
Name | Type | Description | Required |
---|---|---|---|
sampleType | enum | E2MAggSamplesSampleType defines the type of sample aggregation to be performed. Enum: min, max | true |
Events2Metric.spec.metricLabels[index]
Name | Type | Description | Required |
---|---|---|---|
sourceField | string | Metric label source field | true |
targetLabel | string | Metric label target alias name | true |
Events2Metric.status
Events2MetricStatus defines the observed state of Events2Metric.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Events2Metric.status.conditions[index]
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 |
GlobalRouter
Samples:
GlobalRouter is the Schema for the GlobalRouters API. NOTE: This CRD exposes a new feature and may have breaking changes in future releases.
See also https://coralogix.com/docs/user-guides/notification-center/routing/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | GlobalRouter | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GlobalRouterSpec defines the desired state of the Global Router. | false |
status | object | GlobalRouterStatus defines the observed state of GlobalRouter. | false |
GlobalRouter.spec
GlobalRouterSpec defines the desired state of the Global Router.
Name | Type | Description | Required |
---|---|---|---|
description | string | Description is the description of the global router. | true |
entityType | enum | EntityType is the entity type for the global router. Should equal "alerts". Enum: alerts | true |
name | string | Name is the name of the global router. | true |
entityLabels | map[string]string | EntityLabels are optional labels to attach to the global router. | false |
fallback | []object | Fallback is the fallback routing target for the global router. | false |
rules | []object | Rules are the routing rules for the global router. | false |
GlobalRouter.spec.fallback[index]
Name | Type | Description | Required |
---|---|---|---|
connector | object | Connector is the connector for the routing target. Should be one of backendRef or resourceRef. Validations: | true |
customDetails | map[string]string | CustomDetails are optional custom details to attach to the routing target. | false |
preset | object | Preset is the preset for the routing target. Should be one of backendRef or resourceRef. Validations: | false |
GlobalRouter.spec.fallback[index].connector
Connector is the connector for the routing target. 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 |
GlobalRouter.spec.fallback[index].connector.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
GlobalRouter.spec.fallback[index].connector.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
GlobalRouter.spec.fallback[index].preset
Preset is the preset for the routing target. 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 |
GlobalRouter.spec.fallback[index].preset.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
GlobalRouter.spec.fallback[index].preset.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
GlobalRouter.spec.rules[index]
Name | Type | Description | Required |
---|---|---|---|
condition | string | Condition is the condition for the routing rule. | true |
name | string | Name is the name of the routing rule. | true |
targets | []object | Targets are the routing targets for the routing rule. | true |
customDetails | map[string]string | CustomDetails are optional custom details to attach to the routing rule. | false |
GlobalRouter.spec.rules[index].targets[index]
Name | Type | Description | Required |
---|---|---|---|
connector | object | Connector is the connector for the routing target. Should be one of backendRef or resourceRef. Validations: | true |
customDetails | map[string]string | CustomDetails are optional custom details to attach to the routing target. | false |
preset | object | Preset is the preset for the routing target. Should be one of backendRef or resourceRef. Validations: | false |
GlobalRouter.spec.rules[index].targets[index].connector
Connector is the connector for the routing target. 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 |
GlobalRouter.spec.rules[index].targets[index].connector.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
GlobalRouter.spec.rules[index].targets[index].connector.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
GlobalRouter.spec.rules[index].targets[index].preset
Preset is the preset for the routing target. 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 |
GlobalRouter.spec.rules[index].targets[index].preset.backendRef
BackendRef is a reference to a backend resource.
Name | Type | Description | Required |
---|---|---|---|
id | string | true |
GlobalRouter.spec.rules[index].targets[index].preset.resourceRef
ResourceRef is a reference to a Kubernetes resource.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
GlobalRouter.status
GlobalRouterStatus defines the observed state of GlobalRouter.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
GlobalRouter.status.conditions[index]
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 |
Group
Samples:
Group is the Schema for the Groups API. See also https://coralogix.com/docs/user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Group | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | GroupSpec defines the desired state of Coralogix Group. | false |
status | object | GroupStatus defines the observed state of Group. | false |
Group.spec
GroupSpec defines the desired state of Coralogix Group.
Name | Type | Description | Required |
---|---|---|---|
customRoles | []object | Custom roles applied to the group. | true |
name | string | Name of the group. | true |
description | string | Description of the group. | false |
members | []object | Members of the group. | false |
scope | object | Scope attached to the group. | false |
Group.spec.customRoles[index]
Custom role reference.
Name | Type | Description | Required |
---|---|---|---|
resourceRef | object | Reference to the custom role within the cluster. | true |
Group.spec.customRoles[index].resourceRef
Reference to the custom role within the cluster.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
Group.spec.members[index]
User on Coralogix.
Name | Type | Description | Required |
---|---|---|---|
userName | string | User's name. | true |
Group.spec.scope
Scope attached to the group.
Name | Type | Description | Required |
---|---|---|---|
resourceRef | object | Scope reference. | true |
Group.spec.scope.resourceRef
Scope reference.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
Group.status
GroupStatus defines the observed state of Group.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Group.status.conditions[index]
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 |
Integration
Samples:
- aws-metrics-collector.yaml
- azure-metrics-collector.yaml
- crowd-strike-collector.yaml
- gcp-logs-collector.yaml
- gcp-metrics-collector.yaml
- gcp-resources.yaml
- gcp-traces-collector.yaml
- github-enterprise-collector.yaml
- google-alert-center-collector.yaml
- google-workspace-audit-logs-collector.yaml
- google-workspace-users.yaml
- microsoft-365-collector.yaml
- okta-users.yaml
- salesforce-events-collector.yaml
- sentinel-one-collector.yaml
- wiz-collector.yaml
Integration is the Schema for the Integrations API. See also https://coralogix.com/docs/user-guides/getting-started/packages-and-extensions/integration-packages/
For available integrations see https://coralogix.com/docs/developer-portal/infrastructure-as-code/terraform-provider/integrations/aws-metrics-collector/ or at https://github.com/coralogix/coralogix-operator/tree/main/config/samples/v1alpha1/integrations.
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Integration | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | IntegrationSpec defines the desired state of a Coralogix (managed) integration. | false |
status | object | IntegrationStatus defines the observed state of Integration. | false |
Integration.spec
IntegrationSpec defines the desired state of a Coralogix (managed) integration.
Name | Type | Description | Required |
---|---|---|---|
integrationKey | string | Unique name of the integration. | true |
parameters | object | Parameters required by the integration. | true |
version | string | Desired version of the integration | true |
Integration.status
IntegrationStatus defines the observed state of Integration.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Integration.status.conditions[index]
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 |
OutboundWebhook
Samples:
- aws-event-bridge.yaml
- demisto.yaml
- email-group.yaml
- generic-webhook.yaml
- jira.yaml
- microsoft-teams.yaml
- opsgenie.yaml
- pagerduty.yaml
- sendlog.yaml
- slack.yaml
OutboundWebhook is the Schema for the API See also https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/aws-eventbridge-outbound-webhook/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | OutboundWebhook | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | OutboundWebhookSpec defines the desired state of an outbound webhook. | false |
status | object | OutboundWebhookStatus defines the observed state of OutboundWebhook | false |
OutboundWebhook.spec
OutboundWebhookSpec defines the desired state of an outbound webhook.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the webhook. | true |
outboundWebhookType | object | Type of webhook. Validations: | true |
OutboundWebhook.spec.outboundWebhookType
Type of webhook.
Name | Type | Description | Required |
---|---|---|---|
awsEventBridge | object | AWS eventbridge message. | false |
demisto | object | Demisto notification. | false |
emailGroup | object | Email notification. | false |
genericWebhook | object | Generic HTTP(s) webhook. | false |
jira | object | Jira issue. | false |
microsoftTeams | object | Teams message. | false |
opsgenie | object | Opsgenie notification. | false |
pagerDuty | object | PagerDuty notification. | false |
sendLog | object | SendLog notification. | false |
slack | object | Slack message. | false |
OutboundWebhook.spec.outboundWebhookType.awsEventBridge
AWS eventbridge message.
Name | Type | Description | Required |
---|---|---|---|
detail | string | true | |
detailType | string | true | |
eventBusArn | string | true | |
roleName | string | true | |
source | string | true |
OutboundWebhook.spec.outboundWebhookType.demisto
Demisto notification.
Name | Type | Description | Required |
---|---|---|---|
payload | string | true | |
url | string | true | |
uuid | string | true |
OutboundWebhook.spec.outboundWebhookType.emailGroup
Email notification.
Name | Type | Description | Required |
---|---|---|---|
emailAddresses | []string | Recipients | true |
OutboundWebhook.spec.outboundWebhookType.genericWebhook
Generic HTTP(s) webhook.
Name | Type | Description | Required |
---|---|---|---|
method | enum | HTTP Method to use. Enum: Unknown, Get, Post, Put | true |
url | string | URL to call | true |
headers | map[string]string | Attached HTTP headers. | false |
payload | string | Payload of the webhook call. | false |
OutboundWebhook.spec.outboundWebhookType.jira
Jira issue.
Name | Type | Description | Required |
---|---|---|---|
apiToken | string | API token | true |
string | Email address associated with the token | true | |
projectKey | string | Project to add it to. | true |
url | string | Jira URL | true |
OutboundWebhook.spec.outboundWebhookType.microsoftTeams
Teams message.
Name | Type | Description | Required |
---|---|---|---|
url | string | Teams URL | true |
OutboundWebhook.spec.outboundWebhookType.opsgenie
Opsgenie notification.
Name | Type | Description | Required |
---|---|---|---|
url | string | true |
OutboundWebhook.spec.outboundWebhookType.pagerDuty
PagerDuty notification.
Name | Type | Description | Required |
---|---|---|---|
serviceKey | string | PagerDuty service key. | true |
OutboundWebhook.spec.outboundWebhookType.sendLog
SendLog notification.
Name | Type | Description | Required |
---|---|---|---|
payload | string | Payload of the notification | true |
url | string | Sendlog URL. | true |
OutboundWebhook.spec.outboundWebhookType.slack
Slack message.
Name | Type | Description | Required |
---|---|---|---|
url | string | true | |
attachments | []object | Attachments of the message. | false |
digests | []object | Digest configuration. | false |
OutboundWebhook.spec.outboundWebhookType.slack.attachments[index]
Slack attachment
Name | Type | Description | Required |
---|---|---|---|
isActive | boolean | Active status. | true |
type | string | Attachment to the message. | true |
OutboundWebhook.spec.outboundWebhookType.slack.digests[index]
Digest config.
Name | Type | Description | Required |
---|---|---|---|
isActive | boolean | Active status. | true |
type | string | Type of digest to send | true |
OutboundWebhook.status
OutboundWebhookStatus defines the observed state of OutboundWebhook
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
externalId | string | false | |
id | string | false |
OutboundWebhook.status.conditions[index]
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 |
Preset
Samples:
Preset is the Schema for the presets API. NOTE: This CRD exposes a new feature and may have breaking changes in future releases. See also https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Preset | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | PresetSpec defines the desired state of Preset. | false |
status | object | PresetStatus defines the observed state of Preset. | false |
Preset.spec
PresetSpec defines the desired state of Preset.
Name | Type | Description | Required |
---|---|---|---|
connectorType | enum | ConnectorType is the type of the connector. Can be one of slack, genericHttps, or pagerDuty. Enum: slack, genericHttps, pagerDuty | true |
description | string | Description is the description of the preset. | true |
entityType | enum | EntityType is the entity type for the preset. Should equal "alerts". Enum: alerts | true |
name | string | Name is the name of the preset. | true |
configOverrides | []object | ConfigOverrides are the entity type configs, allowing entity type templating. | false |
parentId | string | ParentId is the ID of the parent preset. For example, "preset_system_slack_alerts_basic". | false |
Preset.spec.configOverrides[index]
Name | Type | Description | Required |
---|---|---|---|
conditionType | object | ConditionType is the condition type for the config override. Validations: | true |
messageConfig | object | MessageConfig is the message config for the config override. | true |
payloadType | string | PayloadType is the payload type for the config override. | false |
Preset.spec.configOverrides[index].conditionType
ConditionType is the condition type for the config override.
Name | Type | Description | Required |
---|---|---|---|
matchEntityType | object | MatchEntityType is used for matching entity types. | false |
matchEntityTypeAndSubType | object | MatchEntityTypeAndSubType is used for matching entity subtypes. | false |
Preset.spec.configOverrides[index].conditionType.matchEntityTypeAndSubType
MatchEntityTypeAndSubType is used for matching entity subtypes.
Name | Type | Description | Required |
---|---|---|---|
entitySubType | string | EntitySubType is the entity subtype for the config override. For example, "logsImmediateTriggered". | true |
Preset.spec.configOverrides[index].messageConfig
MessageConfig is the message config for the config override.
Name | Type | Description | Required |
---|---|---|---|
fields | []object | Fields are the fields of the message config. | true |
Preset.spec.configOverrides[index].messageConfig.fields[index]
Name | Type | Description | Required |
---|---|---|---|
fieldName | string | FieldName is the name of the field. e.g. "title" for slack. | true |
template | string | Template is the template for the field. | true |
Preset.status
PresetStatus defines the observed state of Preset.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Preset.status.conditions[index]
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 |
RecordingRuleGroupSet
Samples:
RecordingRuleGroupSet is the Schema for the RecordingRuleGroupSets API See also https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | RecordingRuleGroupSet | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | RecordingRuleGroupSetSpec defines the desired state of a set of Coralogix recording rule groups. | false |
status | object | RecordingRuleGroupSetStatus defines the observed state of RecordingRuleGroupSet | false |
RecordingRuleGroupSet.spec
RecordingRuleGroupSetSpec defines the desired state of a set of Coralogix recording rule groups.
Name | Type | Description | Required |
---|---|---|---|
groups | []object | Recording rule groups. | true |
RecordingRuleGroupSet.spec.groups[index]
A Coralogix recording rule group.
Name | Type | Description | Required |
---|---|---|---|
intervalSeconds | integer | How often rules in the group are evaluated (in seconds). Format: int32 Default: 60 | false |
limit | integer | Limits the number of alerts an alerting rule and series a recording-rule can produce. 0 is no limit. Format: int64 | false |
name | string | The (unique) rule group name. | false |
rules | []object | Rules of this group. | false |
RecordingRuleGroupSet.spec.groups[index].rules[index]
A recording rule.
Name | Type | Description | Required |
---|---|---|---|
expr | string | The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and the result recorded as a new set of time series with the metric name as given by 'record'. | false |
labels | map[string]string | Labels to add or overwrite before storing the result. | false |
record | string | The name of the time series to output to. Must be a valid metric name. | false |
RecordingRuleGroupSet.status
RecordingRuleGroupSetStatus defines the observed state of RecordingRuleGroupSet
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
RecordingRuleGroupSet.status.conditions[index]
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 |
RuleGroup
Samples:
- block.yaml
- extract.yaml
- extract_timestamp.yaml
- json_extract.yaml
- mixed_rulegroup.yaml
- parse.yaml
- parse_json_field.yaml
- remove_fields.yaml
- replace.yaml
- stringify_json_field.yaml
RuleGroup is the Schema for the RuleGroups API See also https://coralogix.com/docs/user-guides/data-transformation/metric-rules/recording-rules/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | RuleGroup | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | RuleGroupSpec defines the Desired state of RuleGroup | false |
status | object | RuleGroupStatus defines the observed state of RuleGroup | false |
RuleGroup.spec
RuleGroupSpec defines the Desired state of RuleGroup
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the rule-group. | true |
active | boolean | Whether the rule-group is active. Default: true | false |
applications | []string | Rules will execute on logs that match the these applications. | false |
creator | string | Rule-group creator | false |
description | string | Description of the rule-group. | false |
hidden | boolean | Hides the rule-group. Default: false | false |
order | integer | The index of the rule-group between the other rule-groups. Format: int32 Minimum: 1 | false |
severities | []enum | Rules will execute on logs that match the these severities. Enum: Debug, Verbose, Info, Warning, Error, Critical | false |
subgroups | []object | Rules within the same subgroup have an OR relationship, while rules in different subgroups have an AND relationship. Refer to https://github.com/coralogix/coralogix-operator/blob/main/config/samples/v1alpha1/rulegroups/mixed_rulegroup.yaml for an example. | false |
subsystems | []string | Rules will execute on logs that match the these subsystems. | false |
RuleGroup.spec.subgroups[index]
Sub group of rules.
Name | Type | Description | Required |
---|---|---|---|
active | boolean | Determines whether to rule will be active or not. Default: true | false |
id | string | The rule id. | false |
order | integer | Determines the index of the rule inside the rule-subgroup. Format: int32 | false |
rules | []object | List of rules associated with the sub group. | false |
RuleGroup.spec.subgroups[index].rules[index]
A rule to change data extraction.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the rule. | true |
active | boolean | Whether the rule will be activated. Default: true | false |
block | object | Block rules allow for refined filtering of incoming logs with a Regular Expression. | false |
description | string | Description of the rule. | false |
extract | object | Use a named Regular Expression group to extract specific values you need as JSON getKeysStrings without having to parse the entire log. | false |
extractTimestamp | object | Replace rules are used to replace logs timestamp with JSON field. | false |
jsonExtract | object | Name a JSON field to extract its value directly into a Coralogix metadata field | false |
jsonStringify | object | Convert JSON object to JSON string. | false |
parse | object | Parse unstructured logs into JSON format using named Regular Expression groups. | false |
parseJsonField | object | Convert JSON string to JSON object. | false |
removeFields | object | Remove Fields allows to select fields that will not be indexed. | false |
replace | object | Replace rules are used to strings in order to fix log structure, change log severity, or obscure information. | false |
RuleGroup.spec.subgroups[index].rules[index].block
Block rules allow for refined filtering of incoming logs with a Regular Expression.
Name | Type | Description | Required |
---|---|---|---|
regex | string | Regular Expression. More info: https://coralogix.com/blog/regex-101/ | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
blockingAllMatchingBlocks | boolean | Block Logic. If true or nor set - blocking all matching blocks, if false - blocking all non-matching blocks. Default: true | false |
keepBlockedLogs | boolean | Determines if to view blocked logs in LiveTail and archive to S3. Default: false | false |
RuleGroup.spec.subgroups[index].rules[index].extract
Use a named Regular Expression group to extract specific values you need as JSON getKeysStrings without having to parse the entire log.
Name | Type | Description | Required |
---|---|---|---|
regex | string | Regular Expression. More info: https://coralogix.com/blog/regex-101/ | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
RuleGroup.spec.subgroups[index].rules[index].extractTimestamp
Replace rules are used to replace logs timestamp with JSON field.
Name | Type | Description | Required |
---|---|---|---|
fieldFormatStandard | enum | The format standard to parse the timestamp. Enum: Strftime, JavaSDF, Golang, SecondTS, MilliTS, MicroTS, NanoTS | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
timeFormat | string | A time formatting string that matches the field format standard. | true |
RuleGroup.spec.subgroups[index].rules[index].jsonExtract
Name a JSON field to extract its value directly into a Coralogix metadata field
Name | Type | Description | Required |
---|---|---|---|
destinationField | enum | The field that will be populated by the results of the Regular Expression operation. Enum: Category, CLASSNAME, METHODNAME, THREADID, SEVERITY | true |
jsonKey | string | JSON key to extract its value directly into a Coralogix metadata field. | true |
RuleGroup.spec.subgroups[index].rules[index].jsonStringify
Convert JSON object to JSON string.
Name | Type | Description | Required |
---|---|---|---|
destinationField | string | The field that will be populated by the results of the Regular Expression | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
keepSourceField | boolean | Default: false | false |
RuleGroup.spec.subgroups[index].rules[index].parse
Parse unstructured logs into JSON format using named Regular Expression groups.
Name | Type | Description | Required |
---|---|---|---|
destinationField | string | The field that will be populated by the results of the Regular Expression operation. | true |
regex | string | Regular Expression. More info: https://coralogix.com/blog/regex-101/ | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
RuleGroup.spec.subgroups[index].rules[index].parseJsonField
Convert JSON string to JSON object.
Name | Type | Description | Required |
---|---|---|---|
destinationField | string | The field that will be populated by the results of the Regular Expression | true |
keepDestinationField | boolean | Determines whether to keep or to delete the destination field. | true |
keepSourceField | boolean | Determines whether to keep or to delete the source field. | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
RuleGroup.spec.subgroups[index].rules[index].removeFields
Remove Fields allows to select fields that will not be indexed.
Name | Type | Description | Required |
---|---|---|---|
excludedFields | []string | Excluded fields won't be indexed. | true |
RuleGroup.spec.subgroups[index].rules[index].replace
Replace rules are used to strings in order to fix log structure, change log severity, or obscure information.
Name | Type | Description | Required |
---|---|---|---|
destinationField | string | The field that will be populated by the results of the Regular Expression operation. | true |
regex | string | Regular Expression. More info: https://coralogix.com/blog/regex-101/ | true |
replacementString | string | The string that will replace the matched Regular Expression | true |
sourceField | string | The field on which the Regular Expression will operate on. | true |
RuleGroup.status
RuleGroupStatus defines the observed state of RuleGroup
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
RuleGroup.status.conditions[index]
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 |
Scope
Samples:
Scope is the Schema for the scopes API. See also https://coralogix.com/docs/user-guides/account-management/user-management/scopes/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | Scope | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ScopeSpec defines the desired state of a Coralogix Scope. | false |
status | object | ScopeStatus defines the observed state of Coralogix Scope. | false |
Scope.spec
ScopeSpec defines the desired state of a Coralogix Scope.
Name | Type | Description | Required |
---|---|---|---|
defaultExpression | enum | Default expression to use when no filter matches the query. Until further notice, this is limited to `true` (everything is included) or `false` (nothing is included). Use a version tag (e.g `<v1>true` or `<v1>false`) Enum: <v1>true, <v1>false | true |
filters | []object | Filters applied to include data in the scope. | true |
name | string | Scope display name. | true |
description | string | Description of the scope. Optional. | false |
Scope.spec.filters[index]
ScopeFilter defines a filter to include data in a scope.
Name | Type | Description | Required |
---|---|---|---|
entityType | enum | Entity type to apply the expression on. Enum: logs, spans, unspecified | true |
expression | string | Expression to run. | true |
Scope.status
ScopeStatus defines the observed state of Coralogix Scope.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
Scope.status.conditions[index]
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 |
TCOLogsPolicies
Samples:
TCOLogsPolicies is the Schema for the TCOLogsPolicies API. NOTE: This resource performs an atomic overwrite of all existing TCO logs policies in the backend. Any existing policies not defined in this resource will be removed. Use with caution as this operation is destructive.
See also https://coralogix.com/docs/tco-optimizer-api
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | TCOLogsPolicies | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | TCOLogsPoliciesSpec defines the desired state of Coralogix TCO logs policies. | false |
status | object | TCOLogsPoliciesStatus defines the observed state of TCOLogsPolicies. | false |
TCOLogsPolicies.spec
TCOLogsPoliciesSpec defines the desired state of Coralogix TCO logs policies.
Name | Type | Description | Required |
---|---|---|---|
policies | []object | Coralogix TCO-Policies-List. | true |
TCOLogsPolicies.spec.policies[index]
A TCO policy for logs.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the policy. | true |
priority | enum | The policy priority. Enum: block, high, medium, low | true |
severities | []enum | The severities to apply the policy on. Enum: info, warning, critical, error, debug, verbose | true |
applications | object | The applications to apply the policy on. Applies the policy on all the applications by default. | false |
archiveRetention | object | Matches the specified retention. | false |
description | string | Description of the policy. | false |
subsystems | object | The subsystems to apply the policy on. Applies the policy on all the subsystems by default. | false |
TCOLogsPolicies.spec.policies[index].applications
The applications to apply the policy on. Applies the policy on all the applications by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOLogsPolicies.spec.policies[index].archiveRetention
Matches the specified retention.
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Reference to the retention policy | true |
TCOLogsPolicies.spec.policies[index].archiveRetention.backendRef
Reference to the retention policy
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the policy. | true |
TCOLogsPolicies.spec.policies[index].subsystems
The subsystems to apply the policy on. Applies the policy on all the subsystems by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOLogsPolicies.status
TCOLogsPoliciesStatus defines the observed state of TCOLogsPolicies.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false |
TCOLogsPolicies.status.conditions[index]
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 |
TCOTracesPolicies
Samples:
TCOTracesPolicies is the Schema for the tcotracespolicies API. NOTE: This resource performs an atomic overwrite of all existing TCO traces policies in the backend. Any existing policies not defined in this resource will be removed. Use with caution as this operation is destructive.
See also https://coralogix.com/docs/tco-optimizer-api
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | TCOTracesPolicies | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | TCOTracesPoliciesSpec defines the desired state of Coralogix TCO policies for traces. | false |
status | object | TCOTracesPoliciesStatus defines the observed state of TCOTracesPolicies. | false |
TCOTracesPolicies.spec
TCOTracesPoliciesSpec defines the desired state of Coralogix TCO policies for traces.
Name | Type | Description | Required |
---|---|---|---|
policies | []object | Coralogix TCO-Policies-List. | true |
TCOTracesPolicies.spec.policies[index]
Coralogix TCO policy for traces.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the policy. | true |
priority | enum | The policy priority. Enum: block, high, medium, low | true |
actions | object | The actions to apply the policy on. Applies the policy on all the actions by default. | false |
applications | object | The applications to apply the policy on. Applies the policy on all the applications by default. | false |
archiveRetention | object | Matches the specified retention. | false |
description | string | Description of the policy. | false |
services | object | The services to apply the policy on. Applies the policy on all the services by default. | false |
subsystems | object | The subsystems to apply the policy on. Applies the policy on all the subsystems by default. | false |
tags | []object | The tags to apply the policy on. Applies the policy on all the tags by default. | false |
TCOTracesPolicies.spec.policies[index].actions
The actions to apply the policy on. Applies the policy on all the actions by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOTracesPolicies.spec.policies[index].applications
The applications to apply the policy on. Applies the policy on all the applications by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOTracesPolicies.spec.policies[index].archiveRetention
Matches the specified retention.
Name | Type | Description | Required |
---|---|---|---|
backendRef | object | Reference to the retention policy | true |
TCOTracesPolicies.spec.policies[index].archiveRetention.backendRef
Reference to the retention policy
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the policy. | true |
TCOTracesPolicies.spec.policies[index].services
The services to apply the policy on. Applies the policy on all the services by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOTracesPolicies.spec.policies[index].subsystems
The subsystems to apply the policy on. Applies the policy on all the subsystems by default.
Name | Type | Description | Required |
---|---|---|---|
names | []string | Names to match. | true |
ruleType | enum | Type of matching for the name. Enum: is, is_not, start_with, includes | true |
TCOTracesPolicies.spec.policies[index].tags[index]
TCO Policy tag matching rule.
Name | Type | Description | Required |
---|---|---|---|
name | string | Tag names to match. | true |
ruleType | enum | Operator to match with. Enum: is, is_not, start_with, includes | true |
values | []string | Values to match for | true |
TCOTracesPolicies.status
TCOTracesPoliciesStatus defines the observed state of TCOTracesPolicies.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false |
TCOTracesPolicies.status.conditions[index]
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 |
ViewFolder
ViewFolder is the Schema for the viewfolders API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | ViewFolder | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ViewFolderSpec defines the desired state of folder for views. | false |
status | object | ViewFolderStatus defines the observed state of ViewFolder. | false |
ViewFolder.spec
ViewFolderSpec defines the desired state of folder for views.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the view folder | true |
ViewFolder.status
ViewFolderStatus defines the observed state of ViewFolder.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
ViewFolder.status.conditions[index]
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 |
View
Samples:
View is the Schema for the Views API. See also https://coralogix.com/docs/user-guides/monitoring-and-insights/explore-screen/custom-views/
Added in v0.4.0
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | coralogix.com/v1alpha1 | true |
kind | string | View | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the `metadata` field. | true |
spec | object | ViewSpec defines the desired state of View. | false |
status | object | ViewStatus defines the observed state of View. | false |
View.spec
ViewSpec defines the desired state of View.
Name | Type | Description | Required |
---|---|---|---|
filters | object | Filters is the filters for the view. | true |
name | string | Name of the view. | true |
timeSelection | object | TimeSelection is the time selection for the view. Exactly one of quickSelection or customSelection must be set. Validations: | true |
folder | object | Folder is the folder to which the view belongs. | false |
searchQuery | object | SearchQuery is the search query for the view. | false |
View.spec.filters
Filters is the filters for the view.
Name | Type | Description | Required |
---|---|---|---|
filters | []object | Filters is the list of filters for the view. | true |
View.spec.filters.filters[index]
Name | Type | Description | Required |
---|---|---|---|
name | string | Name is the name of the filter. | true |
selectedValues | map[string]boolean | SelectedValues is the selected values for the filter. | true |
View.spec.timeSelection
TimeSelection is the time selection for the view. Exactly one of quickSelection or customSelection must be set.
Name | Type | Description | Required |
---|---|---|---|
customSelection | object | CustomSelection is the custom selection for the view. | false |
quickSelection | object | QuickSelection is the quick selection for the view. | false |
View.spec.timeSelection.customSelection
CustomSelection is the custom selection for the view.
Name | Type | Description | Required |
---|---|---|---|
fromTime | string | FromTime is the start time for the custom selection. Format: date-time | true |
toTime | string | ToTime is the end time for the custom selection. Format: date-time | true |
View.spec.timeSelection.quickSelection
QuickSelection is the quick selection for the view.
Name | Type | Description | Required |
---|---|---|---|
seconds | integer | Seconds is the number of seconds for the quick selection. Format: int32 | true |
View.spec.folder
Folder is the folder to which the view belongs.
Name | Type | Description | Required |
---|---|---|---|
resourceRef | object | ViewFolder custom resource name and namespace. If namespace is not set, the View namespace will be used. | true |
View.spec.folder.resourceRef
ViewFolder custom resource name and namespace. If namespace is not set, the View namespace will be used.
Name | Type | Description | Required |
---|---|---|---|
name | string | Name of the resource (not id). | true |
namespace | string | Kubernetes namespace. | false |
View.spec.searchQuery
SearchQuery is the search query for the view.
Name | Type | Description | Required |
---|---|---|---|
query | string | Query is the search query. | true |
View.status
ViewStatus defines the observed state of View.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | false | |
id | string | false |
View.status.conditions[index]
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 |