API Reference

Packages:

coralogix.com/v1alpha1
coralogix.com/v1beta1

coralogix.com/v1alpha1

AICustomEvaluation {.hidden-heading}

AICustomEvaluation

**Samples:**

competitor-policy.yaml{target='_blank'}

AICustomEvaluation is the Schema for the AI custom evaluations API. See also ../../../user-guides/ai/index.mdx

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	AICustomEvaluation	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	AICustomEvaluationSpec defines the desired state of AICustomEvaluation.	false
status	object	AICustomEvaluationStatus defines the observed state of AICustomEvaluation.	false

AICustomEvaluation.spec {.hidden-heading}

AICustomEvaluation.spec

AICustomEvaluationSpec defines the desired state of AICustomEvaluation.

Name	Type	Description	Required
instructions	string	Instructions sent to the LLM evaluator. Must contain at least one of {prompt}, {response}, or {chat_history}.	true
name	string	Display name of the custom evaluation.	true
policyType	enum	Policy type identifier. Enum: quality, security	true
applications	[]object	AI applications to link this custom evaluation to, selected by application and subsystem. Defaults to no linked applications.	false
criteria	object	Acceptable and prohibited criteria for this custom evaluation. Defaults to empty criteria. Validations: • (!has(self.acceptable) \|\| !has(self.acceptable.examples) \|\| !has(self.prohibited) \|\| !has(self.prohibited.examples)) \|\| size(self.acceptable.examples) + size(self.prohibited.examples) <= 100: criteria can include at most 100 total examples across acceptable and prohibited criteria	false
description	string	Human-readable description.	false
shouldIncludeSystemPrompt	boolean	Whether to include the system prompt in the LLM input. Defaults to false. Default: false	false

#### AICustomEvaluation.spec.applications[index] {.hidden-heading}

AICustomEvaluation.spec.applications[index]

Name	Type	Description	Required
application	string	AI application name.	true
subsystem	string	AI application subsystem.	true

#### AICustomEvaluation.spec.criteria {.hidden-heading}

AICustomEvaluation.spec.criteria

Acceptable and prohibited criteria for this custom evaluation. Defaults to empty criteria.

Name	Type	Description	Required
acceptable	object	Criteria and examples for acceptable responses.	false
prohibited	object	Criteria and examples for prohibited responses.	false

#### AICustomEvaluation.spec.criteria.acceptable {.hidden-heading}

AICustomEvaluation.spec.criteria.acceptable

Criteria and examples for acceptable responses.

Name	Type	Description	Required
examples	[]string	Example conversations for this criterion.	false
flags	string	Criterion flags.	false

#### AICustomEvaluation.spec.criteria.prohibited {.hidden-heading}

AICustomEvaluation.spec.criteria.prohibited

Criteria and examples for prohibited responses.

Name	Type	Description	Required
examples	[]string	Example conversations for this criterion.	false
flags	string	Criterion flags.	false

#### AICustomEvaluation.status {.hidden-heading}

AICustomEvaluation.status

AICustomEvaluationStatus defines the observed state of AICustomEvaluation.

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

#### AICustomEvaluation.status.conditions[index] {.hidden-heading}

AICustomEvaluation.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

### AIEvaluation {.hidden-heading}

AIEvaluation

**Samples:**

pii-response.yaml{target='_blank'}

AIEvaluation is the Schema for the AI evaluations API. See also ../../../user-guides/ai/index.mdx

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	AIEvaluation	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	AIEvaluationSpec defines the desired state of AIEvaluation.	false
status	object	AIEvaluationStatus defines the observed state of AIEvaluation.	false

AIEvaluation.spec {.hidden-heading}

AIEvaluation.spec

AIEvaluationSpec defines the desired state of AIEvaluation.

Name	Type	Description	Required
application	string	Name of the AI application this evaluation belongs to. Validations: • self == oldSelf: spec.application is immutable	true
config	object	AI evaluation configuration. Validations: • (has(self.allowedTopics) ? 1 : 0) + (has(self.competition) ? 1 : 0) + (has(self.hallucinationCompleteness) ? 1 : 0) + (has(self.hallucinationContextAdherence) ? 1 : 0) + (has(self.hallucinationContextRelevance) ? 1 : 0) + (has(self.hallucinationCorrectness) ? 1 : 0) + (has(self.hallucinationTaskAdherence) ? 1 : 0) + (has(self.languageMismatch) ? 1 : 0) + (has(self.pii) ? 1 : 0) + (has(self.promptInjection) ? 1 : 0) + (has(self.restrictedTopics) ? 1 : 0) + (has(self.sexism) ? 1 : 0) + (has(self.sqlAllowedTables) ? 1 : 0) + (has(self.sqlHallucination) ? 1 : 0) + (has(self.sqlReadOnly) ? 1 : 0) + (has(self.sqlRestrictedTables) ? 1 : 0) + (has(self.toxicity) ? 1 : 0) == 1: Exactly one of the following AI evaluation configs must be set: allowedTopics, competition, hallucinationCompleteness, hallucinationContextAdherence, hallucinationContextRelevance, hallucinationCorrectness, hallucinationTaskAdherence, languageMismatch, pii, promptInjection, restrictedTopics, sexism, sqlAllowedTables, sqlHallucination, sqlReadOnly, sqlRestrictedTables, toxicity	true
subsystem	string	Subsystem within the application. Validations: • self == oldSelf: spec.subsystem is immutable	true
target	enum	Target span content the evaluation runs against. Validations: • self == oldSelf: spec.target is immutable Enum: prompt, response	true
threshold	int or string	Score threshold. Must be between 0.0 and 1.0 inclusive. Fractional values must be supplied as quoted quantities, for example "0.8".	true
isEnabled	boolean	Whether the evaluation is active. Default: true	false

#### AIEvaluation.spec.config {.hidden-heading}

AIEvaluation.spec.config

AI evaluation configuration.

Name	Type	Description	Required
allowedTopics	object	Configuration for Allowed Topics evaluation.	false
competition	object	Configuration for Competition evaluation.	false
hallucinationCompleteness	map[string]string	Configuration for Hallucination Completeness evaluation. Hallucination Completeness has no nested fields and must be set to an empty object.	false
hallucinationContextAdherence	map[string]string	Configuration for Hallucination Context Adherence evaluation. Hallucination Context Adherence has no nested fields and must be set to an empty object.	false
hallucinationContextRelevance	map[string]string	Configuration for Hallucination Context Relevance evaluation. Hallucination Context Relevance has no nested fields and must be set to an empty object.	false
hallucinationCorrectness	map[string]string	Configuration for Hallucination Correctness evaluation. Hallucination Correctness has no nested fields and must be set to an empty object.	false
hallucinationTaskAdherence	map[string]string	Configuration for Hallucination Task Adherence evaluation. Hallucination Task Adherence has no nested fields and must be set to an empty object.	false
languageMismatch	map[string]string	Configuration for Language Mismatch evaluation. Language Mismatch has no nested fields and must be set to an empty object.	false
pii	object	Configuration for PII evaluation.	false
promptInjection	object	Configuration for Prompt Injection evaluation.	false
restrictedTopics	object	Configuration for Restricted Topics evaluation.	false
sexism	map[string]string	Configuration for Sexism evaluation. Sexism has no nested fields and must be set to an empty object.	false
sqlAllowedTables	object	Configuration for SQL Allowed Tables evaluation.	false
sqlHallucination	map[string]string	Configuration for SQL Hallucination evaluation. SQL Hallucination has no nested fields and must be set to an empty object.	false
sqlReadOnly	map[string]string	Configuration for SQL Read Only evaluation. SQL Read Only has no nested fields and must be set to an empty object.	false
sqlRestrictedTables	object	Configuration for SQL Restricted Tables evaluation.	false
toxicity	map[string]string	Configuration for Toxicity evaluation. Toxicity has no nested fields and must be set to an empty object.	false

#### AIEvaluation.spec.config.allowedTopics {.hidden-heading}

AIEvaluation.spec.config.allowedTopics

Configuration for Allowed Topics evaluation.

Name	Type	Description	Required
topics	[]string	Topics considered allowed.	true

#### AIEvaluation.spec.config.competition {.hidden-heading}

AIEvaluation.spec.config.competition

Configuration for Competition evaluation.

Name	Type	Description	Required
competitors	[]string	Competitor names to watch for.	true

#### AIEvaluation.spec.config.pii {.hidden-heading}

AIEvaluation.spec.config.pii

Configuration for PII evaluation.

Name	Type	Description	Required
categories	[]enum	PII categories to detect. Enum: PHONE_NUMBER, EMAIL_ADDRESS, CREDIT_CARD, IBAN_CODE, US_SSN	true

#### AIEvaluation.spec.config.promptInjection {.hidden-heading}

AIEvaluation.spec.config.promptInjection

Configuration for Prompt Injection evaluation.

Name	Type	Description	Required
additionalContext	string	Additional context passed to the LLM evaluator. Default:	false

#### AIEvaluation.spec.config.restrictedTopics {.hidden-heading}

AIEvaluation.spec.config.restrictedTopics

Configuration for Restricted Topics evaluation.

Name	Type	Description	Required
topics	[]string	Topics that should not appear.	true

#### AIEvaluation.spec.config.sqlAllowedTables {.hidden-heading}

AIEvaluation.spec.config.sqlAllowedTables

Configuration for SQL Allowed Tables evaluation.

Name	Type	Description	Required
tables	[]string	SQL table names that are allowed.	true

#### AIEvaluation.spec.config.sqlRestrictedTables {.hidden-heading}

AIEvaluation.spec.config.sqlRestrictedTables

Configuration for SQL Restricted Tables evaluation.

Name	Type	Description	Required
tables	[]string	SQL table names that are not allowed.	true

#### AIEvaluation.status {.hidden-heading}

AIEvaluation.status

AIEvaluationStatus defines the observed state of AIEvaluation.

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

#### AIEvaluation.status.conditions[index] {.hidden-heading}

AIEvaluation.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

### AlertScheduler {.hidden-heading}

AlertScheduler

**Samples:**

one-time-alert-scheduler.yaml{target='_blank'}
recurring-alert-scheduler.yaml{target='_blank'}

AlertScheduler is the Schema for the AlertSchedulers API. It is used to suppress or activate alerts based on a schedule. See also ../../../user-guides/alerting/alert-suppression-rules/index.mdx

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 {.hidden-heading}

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: • has(self.metaLabels) != has(self.alerts): Exactly one of metaLabels or alerts must be set	true
name	string	Alert Scheduler name.	true
schedule	object	Alert Scheduler schedule. Exactly one of `oneTime` or `recurring` must be set. Validations: • has(self.oneTime) != has(self.recurring): Exactly one of oneTime or recurring must be set	true
description	string	Alert Scheduler description.	false
enabled	boolean	Alert Scheduler enabled. If set to `false`, the alert scheduler will be disabled. True by default. Default: true	false
metaLabels	[]object	Alert Scheduler meta labels.	false

#### AlertScheduler.spec.filter {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

AlertScheduler.spec.filter.metaLabels[index]

Name	Type	Description	Required
key	string		true
value	string		false

#### AlertScheduler.spec.schedule {.hidden-heading}

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: • has(self.endTime) != has(self.duration): Exactly one of endTime or duration must be set	false
recurring	object	Recurring schedule. Conflicts with `oneTime`. Validations: • has(self.always) != has(self.dynamic): Exactly one of always or dynamic must be set	false

#### AlertScheduler.spec.schedule.oneTime {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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: • has(self.endTime) != has(self.duration): Exactly one of endTime or duration must be set	true
terminationDate	string	The termination date of the rule.	false

#### AlertScheduler.spec.schedule.recurring.dynamic.frequency {.hidden-heading}

AlertScheduler.spec.schedule.recurring.dynamic.frequency

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

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

#### AlertScheduler.spec.schedule.recurring.dynamic.frequency.monthly {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

AlertScheduler.spec.metaLabels[index]

Name	Type	Description	Required
key	string		true
value	string		false

#### AlertScheduler.status {.hidden-heading}

AlertScheduler.status

AlertSchedulerStatus defines the observed state of AlertScheduler.

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

#### AlertScheduler.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

ApiKey

**Samples:**

send_your_data_key.yaml{target='_blank'}
team_key.yaml{target='_blank'}
user_key.yaml{target='_blank'}

ApiKey is the Schema for the ApiKeys API. See also ../../../user-guides/account-management/api-keys/api-keys/index.mdx

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: • has(self.presets) \|\| has(self.permissions): At least one of presets or permissions must be set	false
status	object	ApiKeyStatus defines the observed state of ApiKey.	false

ApiKey.spec {.hidden-heading}

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: • has(self.userId) != has(self.teamId): Exactly one of userId or teamId must be set	true
accessPolicy	string	JSON string representing the access policy for this API key. Defines granular permissions for users and groups.	false
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 {.hidden-heading}

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 {.hidden-heading}

ApiKey.status

ApiKeyStatus defines the observed state of ApiKey.

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

#### ApiKey.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

ArchiveLogsTarget

**Samples:**

s3-archive-logs-target.yaml{target='_blank'}

ArchiveLogsTarget is the Schema for the Archive Logs API. See also ../../../user-guides/aaa/access-control/permissions/index.mdx

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: • has(self.s3Target) != has(self.ibmCosTarget): Exactly one of s3Target or ibmCosTarget must be specified	false
status	object		false

ArchiveLogsTarget.spec {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

ArchiveLogsTarget.status

Name	Type	Description	Required
conditions	[]object		false
id	string	ID is the identifier of the archive logs target.	false
printableStatus	string		false

#### ArchiveLogsTarget.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

ArchiveMetricsTarget

**Samples:**

archive-metrics-target.yaml{target='_blank'}

ArchiveLogsTarget is the Schema for the archive logs targets API. See also ../../../user-guides/data-flow/s3-archive/connect-s3-archive/index.mdx

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.	false
status	object		false

ArchiveMetricsTarget.spec {.hidden-heading}

ArchiveMetricsTarget.spec

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

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

#### ArchiveMetricsTarget.spec.resolutionPolicy {.hidden-heading}

ArchiveMetricsTarget.spec.resolutionPolicy

The resolution policy for the metrics.

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

#### ArchiveMetricsTarget.spec.s3Target {.hidden-heading}

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 {.hidden-heading}

ArchiveMetricsTarget.status

Name	Type	Description	Required
conditions	[]object		false
id	string	ID is the identifier of the archive metrics target.	false
printableStatus	string		false

#### ArchiveMetricsTarget.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Connector

**Samples:**

email.yaml{target='_blank'}
generic-https.yaml{target='_blank'}
pager-duty-incidents.yaml{target='_blank'}
pager-duty-with-secret.yaml{target='_blank'}
pager-duty.yaml{target='_blank'}
service-now.yaml{target='_blank'}
slack.yaml{target='_blank'}

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 {.hidden-heading}

Connector.spec

ConnectorSpec defines the desired state of Connector. See also ../../../user-guides/notification-center/connectors/index.mdx

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, pagerDuty, pagerDutyIncidents, email, or serviceNow. Enum: slack, genericHttps, pagerDuty, pagerDutyIncidents, email, serviceNow	true
configOverrides	[]object	ConfigOverrides are the entity type config overrides for the connector.	false

#### Connector.spec.connectorConfig {.hidden-heading}

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] {.hidden-heading}

Connector.spec.connectorConfig.fields[index]

ConnectorConfigField defines a field in the connector configuration.

Name	Type	Description	Required
fieldName	string	FieldName is the name of the field. e.g. "channel" for slack.	true
secretKeyRef	object	SecretKeyRef is a reference to a secret key containing the field value. Use this for sensitive data like API keys, integration keys, or tokens. Conflicts with Value.	false
value	string	Value is the literal value of the field. Conflicts with SecretKeyRef.	false

#### Connector.spec.connectorConfig.fields[index].secretKeyRef {.hidden-heading}

Connector.spec.connectorConfig.fields[index].secretKeyRef

SecretKeyRef is a reference to a secret key containing the field value. Use this for sensitive data like API keys, integration keys, or tokens. Conflicts with Value.

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	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 Secret or its key must be defined	false

#### Connector.spec.configOverrides[index] {.hidden-heading}

Connector.spec.configOverrides[index]

Name	Type	Description	Required
entityType	enum	EntityType is the entity type for the config override. Can be one of alerts or cases. Enum: alerts, cases	true
fields	[]object	Fields are the templated fields for the config override.	false

#### Connector.spec.configOverrides[index].fields[index] {.hidden-heading}

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 {.hidden-heading}

Connector.status

ConnectorStatus defines the observed state of Connector.

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

#### Connector.status.conditions[index] {.hidden-heading}

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

### CustomEnrichment {.hidden-heading}

CustomEnrichment

**Samples:**

custom-enrichment-configmap.yaml{target='_blank'}
custom-enrichment-csv.yaml{target='_blank'}

CustomEnrichment is the Schema for the customenrichments API. See also ../../../user-guides/enrichment_rules/custom_enrichment/index.mdx#configuration.

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	CustomEnrichment	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CustomEnrichmentSpec defines the desired state of CustomEnrichment. Validations: • has(self.csv) != has(self.configMapRef): Exactly one of csv or configMapRef must be set	false
status	object	CustomEnrichmentStatus defines the observed state of CustomEnrichment.	false

CustomEnrichment.spec {.hidden-heading}

CustomEnrichment.spec

CustomEnrichmentSpec defines the desired state of CustomEnrichment.

Name	Type	Description	Required
description	string	The description of the custom enrichment.	true
name	string	The name of the custom enrichment.	true
configMapRef	object	Reference to a ConfigMap that contains the CSV data. Conflicts with CSV.	false
csv	string	Inline CSV data. Conflicts with ConfigMapRef.	false

#### CustomEnrichment.spec.configMapRef {.hidden-heading}

CustomEnrichment.spec.configMapRef

Reference to a ConfigMap that contains the CSV data. Conflicts with CSV.

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

#### CustomEnrichment.status {.hidden-heading}

CustomEnrichment.status

CustomEnrichmentStatus defines the observed state of CustomEnrichment.

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

#### CustomEnrichment.status.conditions[index] {.hidden-heading}

CustomEnrichment.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 {.hidden-heading}

CustomRole

**Samples:**

example-custom-role.yaml{target='_blank'}

CustomRole is the Schema for the CustomRoles API. See also ../../../user-guides/aaa/access-control/permissions/index.mdx

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 {.hidden-heading}

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 {.hidden-heading}

CustomRole.status

CustomRoleStatus defines the observed state of CustomRole.

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

#### CustomRole.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Dashboard

**Samples:**

dashboard-configmap.yaml{target='_blank'}
dashboard-gzip.yaml{target='_blank'}
dashboard-import.yaml{target='_blank'}
dashboard-json.yaml{target='_blank'}

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: • !(has(self.json) && has(self.configMapRef)): Only one of json or configMapRef can be declared at the same time	false
status	object	DashboardStatus defines the observed state of Dashboard.	false

Dashboard.spec {.hidden-heading}

Dashboard.spec

DashboardSpec defines the desired state of Dashboard. See also ../../../user-guides/custom-dashboards/introduction/index.mdx

Name	Type	Description	Required
configMapRef	object	model from configmap	false
folderRef	object	Validations: • has(self.backendRef) \|\| has(self.resourceRef): One of backendRef or resourceRef is required • !(has(self.backendRef) && has(self.resourceRef)): Only one of backendRef or resourceRef can be declared at the same time	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 {.hidden-heading}

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 {.hidden-heading}

Dashboard.spec.folderRef

Name	Type	Description	Required
backendRef	object	Validations: • has(self.id) \|\| has(self.path): One of id or path is required • !(has(self.id) && has(self.path)): Only one of id or path can be declared at the same time	false
resourceRef	object	Reference to a Coralogix resource within the cluster.	false

#### Dashboard.spec.folderRef.backendRef {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

Dashboard.status

DashboardStatus defines the observed state of Dashboard.

Name	Type	Description	Required
conditions	[]object		false
id	string		false
imported	boolean	Imported records that this Dashboard was already adopted via the import annotation once. It is set the first time adoption succeeds and, unlike status.id, is not cleared if the remote dashboard is later deleted outside the operator - so a subsequent reconcile recreates it from spec instead of retrying the import Get for an id that no longer exists.	false
printableStatus	string		false

#### Dashboard.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

DashboardsFolder

**Samples:**

dashboards-folder.yaml{target='_blank'}

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: • !(has(self.parentFolderId) && has(self.parentFolderRef)): Only one of parentFolderID or parentFolderRef can be declared at the same time	false
status	object	DashboardsFolderStatus defines the observed state of DashboardsFolder.	false

DashboardsFolder.spec {.hidden-heading}

DashboardsFolder.spec

DashboardsFolderSpec defines the desired state of Dashboard Folder. See also ../../../user-guides/custom-dashboards/introduction/index.mdx

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: • self == oldSelf: spec.customId is immutable	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 {.hidden-heading}

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 {.hidden-heading}

DashboardsFolder.status

DashboardsFolderStatus defines the observed state of DashboardsFolder.

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

#### DashboardsFolder.status.conditions[index] {.hidden-heading}

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

### Enrichment {.hidden-heading}

Enrichment

**Samples:**

enrichment.yaml{target='_blank'}

Enrichment is the Schema for the enrichments API. Will overwrite the existing enrichments on the Coralogix side, so it should contain all enrichments that should be applied, not just the new ones. See also ../../../user-guides/enrichment_rules/custom_enrichment/index.mdx#configuration.

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	Enrichment	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	EnrichmentSpec defines the desired state of Enrichment.	false
status	object	EnrichmentStatus defines the observed state of Enrichment.	false

Enrichment.spec {.hidden-heading}

Enrichment.spec

EnrichmentSpec defines the desired state of Enrichment.

Name	Type	Description	Required
enrichments	[]object	List of enrichments to apply. Each enrichment must have exactly one of GeoIp, SuspiciousIp, Aws, or Custom set. Will overwrite the existing enrichments on the Coralogix side, so it should contain all enrichments that should be applied, not just the new ones.	true

#### Enrichment.spec.enrichments[index] {.hidden-heading}

Enrichment.spec.enrichments[index]

EnrichmentType must have exactly one of GeoIp, SuspiciousIp, Aws, or Custom set.

Name	Type	Description	Required
aws	object	Coralogix allows you to enrich your logs with the data from a chosen AWS resource. The feature enriches every log that contains a particular resourceId, associated with the metadata of a chosen AWS resource.	false
custom	object	Custom Log Enrichment with Coralogix enables you to easily enrich your log data.	false
geoIp	object	Set of fields to enrich with geo_ip information.	false
suspiciousIp	object	Coralogix allows you to automatically discover threats on your web servers by enriching your logs with the most updated IP blacklists.	false

#### Enrichment.spec.enrichments[index].aws {.hidden-heading}

Enrichment.spec.enrichments[index].aws

Coralogix allows you to enrich your logs with the data from a chosen AWS resource. The feature enriches every log that contains a particular resourceId, associated with the metadata of a chosen AWS resource.

Name	Type	Required
fieldName	string	true
resourceType	string	true
enrichedFieldName	string	false
selectedColumns	[]string	false

#### Enrichment.spec.enrichments[index].custom {.hidden-heading}

Enrichment.spec.enrichments[index].custom

Custom Log Enrichment with Coralogix enables you to easily enrich your log data.

Name	Type	Description	Required
customEnrichmentRef	object	Validations: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	true
fieldName	string		true
enrichedFieldName	string		false
selectedColumns	[]string		false

#### Enrichment.spec.enrichments[index].custom.customEnrichmentRef {.hidden-heading}

Enrichment.spec.enrichments[index].custom.customEnrichmentRef

Name	Type	Description	Required
backendRef	object	BackendRef is a reference to a CustomEnrichment in the backend.	false
resourceRef	object	ResourceRef is a reference to a CustomEnrichment resource in the cluster.	false

#### Enrichment.spec.enrichments[index].custom.customEnrichmentRef.backendRef {.hidden-heading}

Enrichment.spec.enrichments[index].custom.customEnrichmentRef.backendRef

BackendRef is a reference to a CustomEnrichment in the backend.

Name	Type	Description	Required
id	integer	ID of the CustomEnrichment in the backend. Format: int32	true

#### Enrichment.spec.enrichments[index].custom.customEnrichmentRef.resourceRef {.hidden-heading}

Enrichment.spec.enrichments[index].custom.customEnrichmentRef.resourceRef

ResourceRef is a reference to a CustomEnrichment resource in the cluster.

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

#### Enrichment.spec.enrichments[index].geoIp {.hidden-heading}

Enrichment.spec.enrichments[index].geoIp

Set of fields to enrich with geo_ip information.

Name	Type	Required
fieldName	string	true
enrichedFieldName	string	false
selectedColumns	[]string	false
withAsn	boolean	false

#### Enrichment.spec.enrichments[index].suspiciousIp {.hidden-heading}

Enrichment.spec.enrichments[index].suspiciousIp

Coralogix allows you to automatically discover threats on your web servers by enriching your logs with the most updated IP blacklists.

Name	Type	Required
fieldName	string	true
enrichedFieldName	string	false
selectedColumns	[]string	false

#### Enrichment.status {.hidden-heading}

Enrichment.status

EnrichmentStatus defines the observed state of Enrichment.

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

#### Enrichment.status.conditions[index] {.hidden-heading}

Enrichment.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 {.hidden-heading}

Events2Metric

**Samples:**

logs2metric.yaml{target='_blank'}
spans2metric.yaml{target='_blank'}

See also ../../../user-guides/monitoring-and-insights/events2metrics/index.mdx

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 {.hidden-heading}

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: • has(self.spans) != has(self.logs): Exactly one of spans or logs must be set	true
dataSource	string	Data source in <namespace>/<dataset_name> format. If not set, defaults to the standard logs/spans stream.	false
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 {.hidden-heading}

Events2Metric.spec.query

Spans or logs type query

Name	Type	Description	Required
logs	object	Logs query for logs2metrics E2M	false
spans	object	Spans query for spans2metrics E2M	false

#### Events2Metric.spec.query.logs {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

Events2Metric.spec.metricFields[index].aggregations[index]

Name	Type	Description	Required
aggMetadata	object	Aggregate metadata, samples or histogram type. Only relevant for the samples and histogram aggregation types; leave both samples and histogram unset for min/max/count/avg/sum. Validations: • !(has(self.samples) && has(self.histogram)): At most one of samples or histogram may be set	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 {.hidden-heading}

Events2Metric.spec.metricFields[index].aggregations[index].aggMetadata

Aggregate metadata, samples or histogram type. Only relevant for the samples and histogram aggregation types; leave both samples and histogram unset for min/max/count/avg/sum.

Name	Type	Description	Required
histogram	object	E2M aggregate histogram type metadata	false
samples	object	E2M sample type metadata	false

#### Events2Metric.spec.metricFields[index].aggregations[index].aggMetadata.histogram {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

Events2Metric.status

Events2MetricStatus defines the observed state of Events2Metric.

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

#### Events2Metric.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

GlobalRouter

**Samples:**

alert-with-routing.yaml{target='_blank'}
example-router.yaml{target='_blank'}

GlobalRouter is the Schema for the GlobalRouters API. NOTE: This CRD exposes a new feature and may have breaking changes in future releases.

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 {.hidden-heading}

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
name	string	Name is the name of the global router.	true
disabled	boolean	Disabled disables the global router without deleting it. Defaults to false.	false
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. Deprecated: use FallbackTargets, which supports per-entity-type fallback.	false
fallbackTargets	[]object	FallbackTargets are the per-entity-type fallback targets used when no routing rule matches. Replaces the deprecated Fallback field.	false
id	string	ID of the global router.	false
routingLabels	object	RoutingLabels Allows to configure routing labels which are used for routers resolution. Should be used only if ID is not set to `router_default`.	false
rules	[]object	Rules are the routing rules for the global router.	false

#### GlobalRouter.spec.fallback[index] {.hidden-heading}

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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	false

#### GlobalRouter.spec.fallback[index].connector {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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.fallbackTargets[index] {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index]

FallbackTarget defines a fallback routing target scoped to an entity type.

Name	Type	Description	Required
entityType	enum	EntityType is the entity type this fallback applies to. Can be one of alerts or cases. Enum: alerts, cases	true
target	object	Target is the fallback routing target.	true

#### GlobalRouter.spec.fallbackTargets[index].target {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target

Target is the fallback routing target.

Name	Type	Description	Required
connector	object	Connector is the connector for the routing target. Should be one of backendRef or resourceRef. Validations: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	false

#### GlobalRouter.spec.fallbackTargets[index].target.connector {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.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.fallbackTargets[index].target.connector.backendRef {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.connector.backendRef

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

#### GlobalRouter.spec.fallbackTargets[index].target.connector.resourceRef {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.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.fallbackTargets[index].target.preset {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.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.fallbackTargets[index].target.preset.backendRef {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.preset.backendRef

BackendRef is a reference to a backend resource.

Name	Type	Description	Required
id	string		true

#### GlobalRouter.spec.fallbackTargets[index].target.preset.resourceRef {.hidden-heading}

GlobalRouter.spec.fallbackTargets[index].target.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.routingLabels {.hidden-heading}

GlobalRouter.spec.routingLabels

RoutingLabels Allows to configure routing labels which are used for routers resolution. Should be used only if ID is not set to router_default.

Name	Type	Description	Required
environment	string	Environment is the environment routing label.	false
service	string	Service is the service routing label.	false
team	string	Team is the team routing label.	false

#### GlobalRouter.spec.rules[index] {.hidden-heading}

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
entityType	enum	EntityType is the entity type for the global router. Can be one of alerts or cases. Enum: alerts, cases	false

#### GlobalRouter.spec.rules[index].targets[index] {.hidden-heading}

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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	false

#### GlobalRouter.spec.rules[index].targets[index].connector {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

GlobalRouter.status

GlobalRouterStatus defines the observed state of GlobalRouter.

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

#### GlobalRouter.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Group

**Samples:**

example-group.yaml{target='_blank'}

Group is the Schema for the Groups API. See also ../../../user-guides/account-management/user-management/assign-user-roles-and-scopes-via-groups/index.mdx

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 {.hidden-heading}

Group.spec

GroupSpec defines the desired state of Coralogix Group.

Name	Type	Description	Required
name	string	Name of the group.	true
customRole	object	Custom roles applied to the group.	false
description	string	Description of the group.	false
groupType	enum	Type of the group. Enum: unspecified, open, closed, restricted	false
members	[]object	Members of the group.	false
scope	object	Scope attached to the group.	false

#### Group.spec.customRole {.hidden-heading}

Group.spec.customRole

Custom roles applied to the group.

Name	Type	Description	Required
resourceRef	object	Reference to the custom role within the cluster.	true

#### Group.spec.customRole.resourceRef {.hidden-heading}

Group.spec.customRole.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] {.hidden-heading}

Group.spec.members[index]

User on Coralogix.

Name	Type	Description	Required
userName	string	User's name.	true

#### Group.spec.scope {.hidden-heading}

Group.spec.scope

Scope attached to the group.

Name	Type	Description	Required
resourceRef	object	Scope reference.	true

#### Group.spec.scope.resourceRef {.hidden-heading}

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 {.hidden-heading}

Group.status

GroupStatus defines the observed state of Group.

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

#### Group.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Integration

**Samples:**

aws-metrics-collector.yaml{target='_blank'}
azure-metrics-collector.yaml{target='_blank'}
crowd-strike-collector.yaml{target='_blank'}
gcp-logs-collector.yaml{target='_blank'}
gcp-metrics-collector-with-secret.yaml{target='_blank'}
gcp-metrics-collector.yaml{target='_blank'}
gcp-resources.yaml{target='_blank'}
gcp-traces-collector.yaml{target='_blank'}
github-enterprise-collector.yaml{target='_blank'}
google-alert-center-collector.yaml{target='_blank'}
google-workspace-audit-logs-collector.yaml{target='_blank'}
google-workspace-users.yaml{target='_blank'}
microsoft-365-collector.yaml{target='_blank'}
okta-users.yaml{target='_blank'}
salesforce-events-collector.yaml{target='_blank'}
sentinel-one-collector.yaml{target='_blank'}
wiz-collector.yaml{target='_blank'}

Integration is the Schema for the Integrations API. See also ../../../user-guides/getting-started/packages-and-extensions/integration-packages/index.mdx

For available integrations see ../../../developer-portal/infrastructure-as-code/terraform-provider/integrations/aws-metrics-collector/index.mdx 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 {.hidden-heading}

Integration.spec

IntegrationSpec defines the desired state of a Coralogix (managed) integration.

Name	Type	Description	Required
integrationKey	string	Unique name of the integration.	true
version	string	Desired version of the integration	true
parameters	object	Inline parameters for the integration. May be omitted entirely when all parameters come from ParametersFromSecret.	false
parametersFromSecret	map[string]object	ParametersFromSecret is a map of parameter names to references of Kubernetes Secret keys whose values should be used as the parameter value at reconcile time. Use this for sensitive parameters (API keys, service account keys, tokens, etc.) so that secret material does not need to live in the manifest. A given parameter name must appear in either Parameters or ParametersFromSecret, not both. Only string-valued parameters are supported via this field; numeric, boolean, and list-valued parameters must be set inline in Parameters. If a SecretKeySelector has Optional set to true, a missing Secret or missing key is silently skipped — the resulting Integration will be created or updated in Coralogix without that parameter. Other read errors (RBAC, transient API failures) still cause reconciliation to fail and retry.	false

#### Integration.spec.parametersFromSecret[key] {.hidden-heading}

Integration.spec.parametersFromSecret[key]

SecretKeySelector selects a key of a Secret.

Name	Type	Description	Required
key	string	The key of the secret to select from. Must be a valid secret key.	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 Secret or its key must be defined	false

#### Integration.status {.hidden-heading}

Integration.status

IntegrationStatus defines the observed state of Integration.

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

#### Integration.status.conditions[index] {.hidden-heading}

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

### IPAccess {.hidden-heading}

IPAccess

**Samples:**

ip-access-sample.yaml{target='_blank'}

IPAccess is the Schema for the ipaccesses API. See also ../../../user-guides/account-management/user-management/login-access-policy/index.mdx Added in v1.2.0

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	IPAccess	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	IPAccessSpec defines the desired state of IPAccess.	false
status	object	IPAccessStatus defines the observed state of IPAccess.	false

IPAccess.spec {.hidden-heading}

IPAccess.spec

IPAccessSpec defines the desired state of IPAccess.

Name	Type	Description	Required
enableCoralogixCustomerSupportAccess	enum	The Coralogix customer support access setting. Enum: unspecified, disabled, enabled	true
ipAccess	[]object	The list of IP access entries.	false

#### IPAccess.spec.ipAccess[index] {.hidden-heading}

IPAccess.spec.ipAccess[index]

IPAccessRule represents a single IP access entry.

Name	Type	Description	Required
ipRange	string	The IP range in CIDR notation.	true
enabled	boolean	Whether this IP access entry is enabled.	false
name	string	The name of the IP access entry.	false

#### IPAccess.status {.hidden-heading}

IPAccess.status

IPAccessStatus defines the observed state of IPAccess.

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

#### IPAccess.status.conditions[index] {.hidden-heading}

IPAccess.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 {.hidden-heading}

OutboundWebhook

**Samples:**

aws-event-bridge.yaml{target='_blank'}
demisto.yaml{target='_blank'}
email-group.yaml{target='_blank'}
generic-webhook.yaml{target='_blank'}
jira.yaml{target='_blank'}
microsoft-teams.yaml{target='_blank'}
opsgenie.yaml{target='_blank'}
pagerduty.yaml{target='_blank'}
sendlog.yaml{target='_blank'}
slack.yaml{target='_blank'}

OutboundWebhook is the Schema for the API See also ../../../user-guides/alerting/outbound-webhooks/aws-eventbridge-outbound-webhook/index.mdx

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 {.hidden-heading}

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: • (has(self.genericWebhook) ? 1 : 0) + (has(self.slack) ? 1 : 0) + (has(self.pagerDuty) ? 1 : 0) + (has(self.sendLog) ? 1 : 0) + (has(self.emailGroup) ? 1 : 0) + (has(self.microsoftTeams) ? 1 : 0) + (has(self.jira) ? 1 : 0) + (has(self.opsgenie) ? 1 : 0) + (has(self.demisto) ? 1 : 0) + (has(self.awsEventBridge) ? 1 : 0) == 1: Exactly one of the following fields must be set: genericWebhook, slack, pagerDuty, sendLog, emailGroup, microsoftTeams, jira, opsgenie, demisto, awsEventBridge	true

#### OutboundWebhook.spec.outboundWebhookType {.hidden-heading}

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 {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.awsEventBridge

AWS eventbridge message.

Name	Type	Required
detail	string	true
detailType	string	true
eventBusArn	string	true
roleName	string	true
source	string	true

#### OutboundWebhook.spec.outboundWebhookType.demisto {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.demisto

Demisto notification.

Name	Type	Required
payload	string	true
url	string	true
uuid	string	true

#### OutboundWebhook.spec.outboundWebhookType.emailGroup {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.emailGroup

Email notification.

Name	Type	Description	Required
emailAddresses	[]string	Recipients	true

#### OutboundWebhook.spec.outboundWebhookType.genericWebhook {.hidden-heading}

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 {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.jira

Jira issue.

Name	Type	Description	Required
apiToken	string	API token	true
email	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 {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.microsoftTeams

Teams message.

Name	Type	Description	Required
url	string	Teams URL	true

#### OutboundWebhook.spec.outboundWebhookType.opsgenie {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.opsgenie

Opsgenie notification.

Name	Type	Description	Required
url	string		true

#### OutboundWebhook.spec.outboundWebhookType.pagerDuty {.hidden-heading}

OutboundWebhook.spec.outboundWebhookType.pagerDuty

PagerDuty notification.

Name	Type	Description	Required
serviceKey	string	PagerDuty service key.	true

#### OutboundWebhook.spec.outboundWebhookType.sendLog {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

OutboundWebhook.status

OutboundWebhookStatus defines the observed state of OutboundWebhook

Name	Type	Required
conditions	[]object	false
externalId	string	false
id	string	false
printableStatus	string	false

#### OutboundWebhook.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Preset

**Samples:**

email.yaml{target='_blank'}
generic-https.yaml{target='_blank'}
pager-duty.yaml{target='_blank'}
slack.yaml{target='_blank'}

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 ../../../user-guides/notification-center/presets/introduction/index.mdx

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 {.hidden-heading}

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, pagerDuty, pagerDutyIncidents, or email. Enum: slack, genericHttps, pagerDuty, pagerDutyIncidents, email	true
description	string	Description is the description of the preset.	true
entityType	enum	EntityType is the entity type for the preset. Can be one of alerts or cases. Enum: alerts, cases	true
name	string	Name is the name of the preset.	true
attachmentConfig	enum	AttachmentConfig controls whether notification payloads include attachments. Defaults to AUTO. Enum: AUTO, ENABLED, DISABLED	false
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] {.hidden-heading}

Preset.spec.configOverrides[index]

Name	Type	Description	Required
conditionType	object	ConditionType is the condition type for the config override. Validations: • has(self.matchEntityType) != has(self.matchEntityTypeAndSubType): exactly one of matchEntityType or matchEntityTypeAndSubType must be set	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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

Preset.status

PresetStatus defines the observed state of Preset.

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

#### Preset.status.conditions[index] {.hidden-heading}

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

### QuotaAllocationRuleSet {.hidden-heading}

QuotaAllocationRuleSet

**Samples:**

example-quota-allocation-rule-set.yaml{target='_blank'}

QuotaAllocationRuleSet is the Schema for the QuotaAllocationRuleSet API. NOTE: This account-level singleton resource replaces all user-managed backend quota allocation rules. Coralogix-managed rules returned by the backend are preserved by the controller.

Added in v0.4.0

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	QuotaAllocationRuleSet	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	QuotaAllocationRuleSetSpec defines the desired state of Coralogix quota allocation rules.	false
status	object	QuotaAllocationRuleSetStatus defines the observed state of QuotaAllocationRuleSet.	false

QuotaAllocationRuleSet.spec {.hidden-heading}

QuotaAllocationRuleSet.spec

QuotaAllocationRuleSetSpec defines the desired state of Coralogix quota allocation rules.

Name	Type	Description	Required
rules	[]object	Coralogix quota allocation rules.	true

#### QuotaAllocationRuleSet.spec.rules[index] {.hidden-heading}

QuotaAllocationRuleSet.spec.rules[index]

QuotaAllocationRule defines quota allocation for a single entity type.

Name	Type	Description	Required
allocation	int or string	Allocation value. Percent allocations are 0-100; locked unit allocations are absolute units. Fractional values must be supplied as quoted quantities, for example "12.5".	true
canOverflow	boolean	Whether this quota allocation rule can overflow.	true
enabled	boolean	Whether this quota allocation rule is enabled.	true
entityType	string	Entity type to allocate quota for.	true
allocationType	enum	Interprets allocation as a percentage, locked units, or unspecified. Defaults to percentage when omitted. Enum: percentage, lockedUnits, unspecified	false

#### QuotaAllocationRuleSet.status {.hidden-heading}

QuotaAllocationRuleSet.status

QuotaAllocationRuleSetStatus defines the observed state of QuotaAllocationRuleSet.

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

#### QuotaAllocationRuleSet.status.conditions[index] {.hidden-heading}

QuotaAllocationRuleSet.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 {.hidden-heading}

RecordingRuleGroupSet

**Samples:**

coralogix_v1alpha1_recordingrulegroupset.yaml{target='_blank'}

RecordingRuleGroupSet is the Schema for the RecordingRuleGroupSets API See also ../../../user-guides/data-transformation/metric-rules/recording-rules/index.mdx

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

RecordingRuleGroupSet.status

RecordingRuleGroupSetStatus defines the observed state of RecordingRuleGroupSet

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

#### RecordingRuleGroupSet.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

RuleGroup

**Samples:**

block.yaml{target='_blank'}
extract.yaml{target='_blank'}
extract_timestamp.yaml{target='_blank'}
json_extract.yaml{target='_blank'}
mixed_rulegroup.yaml{target='_blank'}
parse.yaml{target='_blank'}
parse_json_field.yaml{target='_blank'}
remove_fields.yaml{target='_blank'}
replace.yaml{target='_blank'}
stringify_json_field.yaml{target='_blank'}

RuleGroup is the Schema for the RuleGroups API See also ../../../user-guides/data-transformation/metric-rules/recording-rules/index.mdx

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

RuleGroup.status

RuleGroupStatus defines the observed state of RuleGroup

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

#### RuleGroup.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

Scope

**Samples:**

example-scope.yaml{target='_blank'}

Scope is the Schema for the scopes API. See also ../../../user-guides/account-management/user-management/scopes/index.mdx

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

Scope.status

ScopeStatus defines the observed state of Coralogix Scope.

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

#### Scope.status.conditions[index] {.hidden-heading}

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

### SLO {.hidden-heading}

SLO

**Samples:**

request-based.yaml{target='_blank'}
window-based.yaml{target='_blank'}

SLO is the Schema for the slos API. See also https://coralogix.com/platform/apm/slo-management/

Name	Type	Description	Required
apiVersion	string	coralogix.com/v1alpha1	true
kind	string	SLO	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	SLOSpec defines the desired state of SLO. For more information, see: https://coralogix.com/platform/apm/slo-management/	false
status	object	SLOStatus defines the observed state of SLO.	false

SLO.spec {.hidden-heading}

SLO.spec

SLOSpec defines the desired state of SLO. For more information, see: https://coralogix.com/platform/apm/slo-management/

Name	Type	Description	Required
name	string	SLO name	true
sliType	object	SliType defines the type of SLI used for the SLO. Exactly one of metric or windowBasedMetric must be set. Validations: • has(self.requestBasedMetric) != has(self.windowBasedMetric): Exactly one of requestBasedMetricSli or windowBasedMetric must be set	true
targetThresholdPercentage	int or string	TargetThresholdPercentage is the target threshold percentage for the SLO.	true
window	object	Window defines the time window for the SLO.	true
description	string	Optional SLO description	false
labels	map[string]string	Labels are additional labels to be added to the SLO.	false

#### SLO.spec.sliType {.hidden-heading}

SLO.spec.sliType

SliType defines the type of SLI used for the SLO. Exactly one of metric or windowBasedMetric must be set.

Name	Type	Description	Required
requestBasedMetric	object		false
windowBasedMetric	object		false

#### SLO.spec.sliType.requestBasedMetric {.hidden-heading}

SLO.spec.sliType.requestBasedMetric

Name	Type	Description	Required
goodEvents	object	GoodEvents defines the good events metric.	true
totalEvents	object	TotalEvents defines the total events metric.	true
groupByLabels	[]string	GroupByLabels defines the labels to group the SLI by.	false

#### SLO.spec.sliType.requestBasedMetric.goodEvents {.hidden-heading}

SLO.spec.sliType.requestBasedMetric.goodEvents

GoodEvents defines the good events metric.

Name	Type	Description	Required
query	string	Query is the metric query string.	true

#### SLO.spec.sliType.requestBasedMetric.totalEvents {.hidden-heading}

SLO.spec.sliType.requestBasedMetric.totalEvents

TotalEvents defines the total events metric.

Name	Type	Description	Required
query	string	Query is the metric query string.	true

#### SLO.spec.sliType.windowBasedMetric {.hidden-heading}

SLO.spec.sliType.windowBasedMetric

Name	Type	Description	Required
comparisonOperator	enum	ComparisonOperator defines the comparison operator for the SLO. Valid values are "unspecified", "greaterThan", "lessThan", "greaterThanOrEquals", and "lessThanOrEquals". Enum: unspecified, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals	false
query	object	Optional query for the metric.	false
threshold	int or string	Threshold defines the threshold for the SLO.	false
window	enum	Window defines the time window for the SLO. Valid values are "unspecified", "1m", and "5m". Enum: unspecified, 1m, 5m	false

#### SLO.spec.sliType.windowBasedMetric.query {.hidden-heading}

SLO.spec.sliType.windowBasedMetric.query

Optional query for the metric.

Name	Type	Description	Required
query	string	Query is the metric query string.	true

#### SLO.spec.window {.hidden-heading}

SLO.spec.window

Window defines the time window for the SLO.

Name	Type	Description	Required
timeFrame	enum	TimeFrame defines the time frame for the SLO window. Valid values are "unspecified", "7d", "14d", "21d", and "28d". Deprecated: "90d" is no longer supported by the Coralogix API and will be rejected by the operator. Enum: unspecified, 7d, 14d, 21d, 28d, 90d	false

#### SLO.status {.hidden-heading}

SLO.status

SLOStatus defines the observed state of SLO.

Name	Type	Description	Required
conditions	[]object		false
id	string		false
printableStatus	string		false
revision	integer	Format: int32	false

#### SLO.status.conditions[index] {.hidden-heading}

SLO.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 {.hidden-heading}

TCOLogsPolicies

**Samples:**

example-tco-logs-policies.yaml{target='_blank'}

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 ../../../developer-portal/apis/tco-controls/tco-optimizer-http-api/index.mdx

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 {.hidden-heading}

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] {.hidden-heading}

TCOLogsPolicies.spec.policies[index]

A TCO policy for logs.

Name	Type	Description	Required
name	string	Name of the policy.	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
disabled	boolean	Whether the policy is disabled.	false
priority	enum	The policy priority. Required when targets is not set. Mutually exclusive with targets, which carry their own per-target priorities. Enum: block, high, medium, low	false
subsystems	object	The subsystems to apply the policy on. Applies the policy on all the subsystems by default.	false
targets	[]object	Targets defines the datasets to route matched data to, each with its own required priority. Setting targets requires omitting the policy-level priority; the two are mutually exclusive.	false

#### TCOLogsPolicies.spec.policies[index].applications {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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.spec.policies[index].targets[index] {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index]

TCOPolicyTarget defines a dataset destination with its own priority for matched log data.

Name	Type	Description	Required
dataset	string	The dataset to route data to.	true
priority	enum	Per-target priority. Required on every target. Mutually exclusive with the policy-level priority. Enum: block, high, low, medium	true
archiveRetention	object	Matches the specified archive retention for this target.	false
dataspace	string	The dataspace within the dataset.	false
priorityOverride	object	Dynamic quota-based priority override for this target.	false

#### TCOLogsPolicies.spec.policies[index].targets[index].archiveRetention {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index].archiveRetention

Matches the specified archive retention for this target.

Name	Type	Description	Required
backendRef	object	Reference to the retention policy	true

#### TCOLogsPolicies.spec.policies[index].targets[index].archiveRetention.backendRef {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index].archiveRetention.backendRef

Reference to the retention policy

Name	Type	Description	Required
name	string	Name of the policy.	true

#### TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride

Dynamic quota-based priority override for this target.

Name	Type	Description	Required
quotaBased	object	TCOPolicyQuotaBased maps daily quota consumption percentages to priority levels.	false

#### TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride.quotaBased {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride.quotaBased

TCOPolicyQuotaBased maps daily quota consumption percentages to priority levels.

Name	Type	Description	Required
usageTiers	[]object		true

#### TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride.quotaBased.usageTiers[index] {.hidden-heading}

TCOLogsPolicies.spec.policies[index].targets[index].priorityOverride.quotaBased.usageTiers[index]

TCOPolicyUsageTier maps a daily quota threshold percentage to a priority.

Name	Type	Description	Required
dailyQuotaPercentage	int or string		true
priority	enum	Enum: block, high, low, medium	true

#### TCOLogsPolicies.status {.hidden-heading}

TCOLogsPolicies.status

TCOLogsPoliciesStatus defines the observed state of TCOLogsPolicies.

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

#### TCOLogsPolicies.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

TCOTracesPolicies

**Samples:**

example-tco-traces-policies.yaml{target='_blank'}

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 ../../../developer-portal/apis/tco-controls/tco-optimizer-http-api/index.mdx

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 {.hidden-heading}

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] {.hidden-heading}

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
disabled	boolean	Whether the policy is disabled.	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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

TCOTracesPolicies.status

TCOTracesPoliciesStatus defines the observed state of TCOTracesPolicies.

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

#### TCOTracesPolicies.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

ViewFolder.status

ViewFolderStatus defines the observed state of ViewFolder.

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

#### ViewFolder.status.conditions[index] {.hidden-heading}

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 {.hidden-heading}

View

View is the Schema for the Views API. See also ../../../user-guides/data_exploration/views_queries/index.mdx

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 {.hidden-heading}

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: • has(self.quickSelection) != has(self.customSelection): Exactly one of quickSelection or customSelection must be set	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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

View.status

ViewStatus defines the observed state of View.

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

#### View.status.conditions[index] {.hidden-heading}

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

## coralogix.com/v1beta1

Alert {.hidden-heading}

Alert

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: • !has(self.alertType.logsImmediate) \|\| !has(self.groupByKeys): groupByKeys is not supported for this alert type • !(self.phantomMode && has(self.notificationGroup)): Phantom alerts must not have a notification group set	false
status	object	AlertStatus defines the observed state of Alert	false

Alert.spec {.hidden-heading}

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

#### Alert.spec.alertType {.hidden-heading}

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. Validations: • !has(self.undetectedValuesManagement) \|\| self.rules.exists(r, r.condition.conditionType == 'lessThan'): undetectedValuesManagement requires at least one rule with a lessThan condition	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
sloThreshold	object	Alerts for SLO thresholds. Validations: • has(self.errorBudget) != has(self.burnRate): Exactly one of errorBudget or burnRate is required	false
tracingImmediate	object	Immediate alerts for traces.	false
tracingThreshold	object	Alerts for when traces crosses a threshold.	false

#### Alert.spec.alertType.flow {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	true
not	boolean	Inversion. Default: false	true

#### Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index].alertRef {.hidden-heading}

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: • has(self.id) != has(self.name): One of id or name is required	false
resourceRef	object	Kubernetes resource reference.	false

#### Alert.spec.alertType.flow.stages[index].flowStagesType.groups[index].alertDefs[index].alertRef.backendRef {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

Alert.spec.alertType.logsAnomaly

Anomaly alerts for logs.

Name	Type	Description	Required
rules	[]object	Rules that match the alert to the data.	true
anomalyAlertSettings	object	Settings for anomaly alerts.	false
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false
logsFilter	object	Filter to filter the logs with.	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false

#### Alert.spec.alertType.logsAnomaly.rules[index] {.hidden-heading}

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 {.hidden-heading}

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
conditionType	enum	Condition type. Enum: moreThanUsual Default: moreThanUsual	false

#### Alert.spec.alertType.logsAnomaly.rules[index].condition.timeWindow {.hidden-heading}

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.anomalyAlertSettings {.hidden-heading}

Alert.spec.alertType.logsAnomaly.anomalyAlertSettings

Settings for anomaly alerts.

Name	Type	Description	Required
percentageOfDeviation	int or string	The percentage of deviation from the baseline for triggering the alert.	true

#### Alert.spec.alertType.logsAnomaly.logsFilter {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false
groupByFor	enum	Which side of the ratio the group-by keys are applied to. Enum: both, numeratorOnly, denominatorOnly	false
ignoreInfinity	boolean	Ignore infinity on the threshold value. Default: false	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false
undetectedValuesManagement	object	How to work with undetected values.	false

#### Alert.spec.alertType.logsRatioThreshold.denominator {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

Alert.spec.alertType.logsRatioThreshold.rules[index]

The rule to match the alert's conditions.

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

#### Alert.spec.alertType.logsRatioThreshold.rules[index].condition {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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.logsRatioThreshold.undetectedValuesManagement {.hidden-heading}

Alert.spec.alertType.logsRatioThreshold.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.logsThreshold {.hidden-heading}

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
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false
logsFilter	object	Filter to filter the logs with.	false
noDataPolicy	object	Policy for handling missing data.	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false
undetectedValuesManagement	object	How to work with undetected values.	false

#### Alert.spec.alertType.logsThreshold.rules[index] {.hidden-heading}

Alert.spec.alertType.logsThreshold.rules[index]

The rule to match the alert's conditions.

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

#### Alert.spec.alertType.logsThreshold.rules[index].condition {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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.noDataPolicy {.hidden-heading}

Alert.spec.alertType.logsThreshold.noDataPolicy

Policy for handling missing data.

Name	Type	Description	Required
state	enum	State to use when no data is present. Enum: ok, alerting, keepLast, noData	true
autoRetireSeconds	integer	The timeframe in seconds for auto retiring values that were detected as no-data. Must be a multiple of 60 seconds. Format: int32	false

#### Alert.spec.alertType.logsThreshold.undetectedValuesManagement {.hidden-heading}

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 {.hidden-heading}

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
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false
notificationPayloadFilter	[]string	Filter for the notification payload.	false
undetectedValuesManagement	object	How to work with undetected values.	false

#### Alert.spec.alertType.logsTimeRelativeThreshold.logsFilter {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

Alert.spec.alertType.logsTimeRelativeThreshold.rules[index]

The rule to match the alert's conditions.

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

#### Alert.spec.alertType.logsTimeRelativeThreshold.rules[index].condition {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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
anomalyAlertSettings	object	Settings for anomaly alerts.	false
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false

#### Alert.spec.alertType.metricAnomaly.metricFilter {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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: int64 Maximum: 100	true
minNonNullValuesPct	integer	Replace with a number Format: int64 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 {.hidden-heading}

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.metricAnomaly.anomalyAlertSettings {.hidden-heading}

Alert.spec.alertType.metricAnomaly.anomalyAlertSettings

Settings for anomaly alerts.

Name	Type	Description	Required
percentageOfDeviation	int or string	The percentage of deviation from the baseline for triggering the alert.	true

#### Alert.spec.alertType.metricThreshold {.hidden-heading}

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
evaluationDelayMs	integer	Evaluation delay in milliseconds. Format: int32	false
noDataPolicy	object	Policy for handling missing data.	false
undetectedValuesManagement	object	How to work with undetected values.	false

#### Alert.spec.alertType.metricThreshold.metricFilter {.hidden-heading}

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 {.hidden-heading}

Alert.spec.alertType.metricThreshold.missingValues

Missing values strategies.

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

#### Alert.spec.alertType.metricThreshold.rules[index] {.hidden-heading}

Alert.spec.alertType.metricThreshold.rules[index]

Rules that match the alert to the data.

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

#### Alert.spec.alertType.metricThreshold.rules[index].condition {.hidden-heading}

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: • has(self.specificValue) != has(self.dynamicDuration): Exactly one of specificValue or dynamicDuration is required	true
threshold	int or string		true

#### Alert.spec.alertType.metricThreshold.rules[index].condition.ofTheLast {.hidden-heading}

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 {.hidden-heading}

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.noDataPolicy {.hidden-heading}

Alert.spec.alertType.metricThreshold.noDataPolicy

Policy for handling missing data.

Name	Type	Description	Required
state	enum	State to use when no data is present. Enum: ok, alerting, keepLast, noData	true
autoRetireSeconds	integer	The timeframe in seconds for auto retiring values that were detected as no-data. Must be a multiple of 60 seconds. Format: int32	false

#### Alert.spec.alertType.metricThreshold.undetectedValuesManagement {.hidden-heading}

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.sloThreshold {.hidden-heading}

Alert.spec.alertType.sloThreshold

Alerts for SLO thresholds.

Name	Type	Required
sloDefinition	object	true
burnRate	object	false
errorBudget	object	false

#### Alert.spec.alertType.sloThreshold.sloDefinition {.hidden-heading}

Alert.spec.alertType.sloThreshold.sloDefinition

Name	Type	Description	Required
sloRef	object	Validations: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	true

#### Alert.spec.alertType.sloThreshold.sloDefinition.sloRef {.hidden-heading}

Alert.spec.alertType.sloThreshold.sloDefinition.sloRef

Name	Type	Description	Required
backendRef	object	Validations: • has(self.id) != has(self.name): Exactly one of id or name must be set	false
resourceRef	object	Reference to a resource within the cluster.	false

#### Alert.spec.alertType.sloThreshold.sloDefinition.sloRef.backendRef {.hidden-heading}

Alert.spec.alertType.sloThreshold.sloDefinition.sloRef.backendRef

Name	Type	Description	Required
id	string		false
name	string		false

#### Alert.spec.alertType.sloThreshold.sloDefinition.sloRef.resourceRef {.hidden-heading}

Alert.spec.alertType.sloThreshold.sloDefinition.sloRef.resourceRef

Reference to a resource within the cluster.

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

#### Alert.spec.alertType.sloThreshold.burnRate {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate

Name	Type	Description	Required
rules	[]object		true
type	object	Validations: • has(self.single) != has(self.dual): Exactly one of single or dual must be set	true

#### Alert.spec.alertType.sloThreshold.burnRate.rules[index] {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.rules[index]

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

#### Alert.spec.alertType.sloThreshold.burnRate.rules[index].condition {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.rules[index].condition

Condition to match

Name	Type	Description	Required
threshold	int or string		true

#### Alert.spec.alertType.sloThreshold.burnRate.rules[index].override {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.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.sloThreshold.burnRate.type {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.type

Name	Type	Description	Required
dual	object		false
single	object		false

#### Alert.spec.alertType.sloThreshold.burnRate.type.dual {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.type.dual

Name	Type	Description	Required
timeDuration	object		true

#### Alert.spec.alertType.sloThreshold.burnRate.type.dual.timeDuration {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.type.dual.timeDuration

Name	Type	Description	Required
duration	integer		true
unit	enum	Time duration unit for a Burn Rate Slo. Enum: unspecified, hours	true

#### Alert.spec.alertType.sloThreshold.burnRate.type.single {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.type.single

Name	Type	Description	Required
timeDuration	object		true

#### Alert.spec.alertType.sloThreshold.burnRate.type.single.timeDuration {.hidden-heading}

Alert.spec.alertType.sloThreshold.burnRate.type.single.timeDuration

Name	Type	Description	Required
duration	integer		true
unit	enum	Time duration unit for a Burn Rate Slo. Enum: unspecified, hours	true

#### Alert.spec.alertType.sloThreshold.errorBudget {.hidden-heading}

Alert.spec.alertType.sloThreshold.errorBudget

#### Alert.spec.alertType.sloThreshold.errorBudget.rules[index] {.hidden-heading}

Alert.spec.alertType.sloThreshold.errorBudget.rules[index]

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

#### Alert.spec.alertType.sloThreshold.errorBudget.rules[index].condition {.hidden-heading}

Alert.spec.alertType.sloThreshold.errorBudget.rules[index].condition

Condition to match

Name	Type	Description	Required
threshold	int or string	Threshold to match to.	true

#### Alert.spec.alertType.sloThreshold.errorBudget.rules[index].override {.hidden-heading}

Alert.spec.alertType.sloThreshold.errorBudget.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.tracingImmediate {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

Alert.spec.alertType.tracingImmediate.tracingFilter.simple.tracingLabelFilters

Filter for traces.

Name	Type	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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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
conditionType	enum	Condition type. Enum: moreThan Default: moreThan	false

#### Alert.spec.alertType.tracingThreshold.rules[index].condition.timeWindow {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

Alert.spec.alertType.tracingThreshold.tracingFilter.simple.tracingLabelFilters

Filter for traces.

Name	Type	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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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.dataSources[index] {.hidden-heading}

Alert.spec.dataSources[index]

Data source to run the alert on.

Name	Type	Description	Required
dataSet	string	Dataset of the data source.	true
dataSpace	string	Data space of the data source.	true

#### Alert.spec.incidentsSettings {.hidden-heading}

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 {.hidden-heading}

Alert.spec.incidentsSettings.retriggeringPeriod

When to re-notify.

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

#### Alert.spec.notificationGroup {.hidden-heading}

Alert.spec.notificationGroup

Where notifications should be sent to.

Name	Type	Description	Required
destinations	[]object	Do not use. Deprecated: This field is deprecated and will be removed in a future version.	false
groupByKeys	[]string	Group notification by these keys.	false
router	object	The router for notifications (Notification Center feature) where to route notifications to.	false
webhooks	[]object	Webhooks to trigger for notifications.	false

#### Alert.spec.notificationGroup.destinations[index] {.hidden-heading}

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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	false
resolvedRoutingOverrides	object	Optional routing configuration to override from the connector/preset for resolved notifications.	false
retriggeringPeriodMinutes	integer	The time in minutes before a new notification is sent for this destination. Format: int64 Minimum: 0	false

#### Alert.spec.notificationGroup.destinations[index].connector {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

Alert.spec.notificationGroup.router

The router for notifications (Notification Center feature) where to route notifications to.

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

#### Alert.spec.notificationGroup.webhooks[index] {.hidden-heading}

Alert.spec.notificationGroup.webhooks[index]

Settings for a notification webhook.

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

#### Alert.spec.notificationGroup.webhooks[index].integration {.hidden-heading}

Alert.spec.notificationGroup.webhooks[index].integration

Type and spec of webhook.

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

#### Alert.spec.notificationGroup.webhooks[index].integration.integrationRef {.hidden-heading}

Alert.spec.notificationGroup.webhooks[index].integration.integrationRef

Reference to the webhook.

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

#### Alert.spec.notificationGroup.webhooks[index].integration.integrationRef.backendRef {.hidden-heading}

Alert.spec.notificationGroup.webhooks[index].integration.integrationRef.backendRef

Backend reference for the outbound webhook.

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

#### Alert.spec.notificationGroup.webhooks[index].integration.integrationRef.resourceRef {.hidden-heading}

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 {.hidden-heading}

Alert.spec.notificationGroup.webhooks[index].retriggeringPeriod

When to re-trigger.

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

#### Alert.spec.notificationGroupExcess[index] {.hidden-heading}

Alert.spec.notificationGroupExcess[index]

Notification group to use for alert notifications.

Name	Type	Description	Required
destinations	[]object	Do not use. Deprecated: This field is deprecated and will be removed in a future version.	false
groupByKeys	[]string	Group notification by these keys.	false
router	object	The router for notifications (Notification Center feature) where to route notifications to.	false
webhooks	[]object	Webhooks to trigger for notifications.	false

#### Alert.spec.notificationGroupExcess[index].destinations[index] {.hidden-heading}

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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	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: • has(self.backendRef) != has(self.resourceRef): Exactly one of backendRef or resourceRef must be set	false
resolvedRoutingOverrides	object	Optional routing configuration to override from the connector/preset for resolved notifications.	false
retriggeringPeriodMinutes	integer	The time in minutes before a new notification is sent for this destination. Format: int64 Minimum: 0	false

#### Alert.spec.notificationGroupExcess[index].destinations[index].connector {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

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] {.hidden-heading}

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] {.hidden-heading}

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 {.hidden-heading}

Alert.spec.notificationGroupExcess[index].router

The router for notifications (Notification Center feature) where to route notifications to.

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

#### Alert.spec.notificationGroupExcess[index].webhooks[index] {.hidden-heading}

Alert.spec.notificationGroupExcess[index].webhooks[index]

Settings for a notification webhook.

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

#### Alert.spec.notificationGroupExcess[index].webhooks[index].integration {.hidden-heading}

Alert.spec.notificationGroupExcess[index].webhooks[index].integration

Type and spec of webhook.

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

#### Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef {.hidden-heading}

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: • has(self.id) != has(self.name): One of id or name is required	false
resourceRef	object	Resource reference for use with the alert notification.	false

#### Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef.backendRef {.hidden-heading}

Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef.backendRef

Backend reference for the outbound webhook.

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

#### Alert.spec.notificationGroupExcess[index].webhooks[index].integration.integrationRef.resourceRef {.hidden-heading}

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 {.hidden-heading}

Alert.spec.notificationGroupExcess[index].webhooks[index].retriggeringPeriod

When to re-trigger.

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

#### Alert.spec.schedule {.hidden-heading}

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 {.hidden-heading}

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 {.hidden-heading}

Alert.status

AlertStatus defines the observed state of Alert

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

#### Alert.status.conditions[index] {.hidden-heading}

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

Last updated on May 8, 2025

coralogix.com/v1alpha1​

AICustomEvaluation {.hidden-heading}​

AICustomEvaluation.spec {.hidden-heading}​

AIEvaluation.spec {.hidden-heading}​

AlertScheduler.spec {.hidden-heading}​

ApiKey.spec {.hidden-heading}​

ArchiveLogsTarget.spec {.hidden-heading}​

ArchiveMetricsTarget.spec {.hidden-heading}​

Connector.spec {.hidden-heading}​

CustomEnrichment.spec {.hidden-heading}​

CustomRole.spec {.hidden-heading}​

Dashboard.spec {.hidden-heading}​

DashboardsFolder.spec {.hidden-heading}​

Enrichment.spec {.hidden-heading}​

Events2Metric.spec {.hidden-heading}​

GlobalRouter.spec {.hidden-heading}​

Group.spec {.hidden-heading}​

Integration.spec {.hidden-heading}​

IPAccess.spec {.hidden-heading}​

OutboundWebhook.spec {.hidden-heading}​

Preset.spec {.hidden-heading}​

QuotaAllocationRuleSet.spec {.hidden-heading}​

RecordingRuleGroupSet.spec {.hidden-heading}​

RuleGroup.spec {.hidden-heading}​

Scope.spec {.hidden-heading}​

SLO.spec {.hidden-heading}​

TCOLogsPolicies.spec {.hidden-heading}​

TCOTracesPolicies.spec {.hidden-heading}​

ViewFolder.spec {.hidden-heading}​

View.spec {.hidden-heading}​

Alert {.hidden-heading}​

Alert.spec {.hidden-heading}​

coralogix.com/v1alpha1

AICustomEvaluation {.hidden-heading}

AICustomEvaluation.spec {.hidden-heading}

AIEvaluation.spec {.hidden-heading}

AlertScheduler.spec {.hidden-heading}

ApiKey.spec {.hidden-heading}

ArchiveLogsTarget.spec {.hidden-heading}

ArchiveMetricsTarget.spec {.hidden-heading}

Connector.spec {.hidden-heading}

CustomEnrichment.spec {.hidden-heading}

CustomRole.spec {.hidden-heading}

Dashboard.spec {.hidden-heading}

DashboardsFolder.spec {.hidden-heading}

Enrichment.spec {.hidden-heading}

Events2Metric.spec {.hidden-heading}

GlobalRouter.spec {.hidden-heading}

Group.spec {.hidden-heading}

Integration.spec {.hidden-heading}

IPAccess.spec {.hidden-heading}

OutboundWebhook.spec {.hidden-heading}

Preset.spec {.hidden-heading}

QuotaAllocationRuleSet.spec {.hidden-heading}

RecordingRuleGroupSet.spec {.hidden-heading}

RuleGroup.spec {.hidden-heading}

Scope.spec {.hidden-heading}

SLO.spec {.hidden-heading}

TCOLogsPolicies.spec {.hidden-heading}

TCOTracesPolicies.spec {.hidden-heading}

ViewFolder.spec {.hidden-heading}

View.spec {.hidden-heading}

Alert {.hidden-heading}

Alert.spec {.hidden-heading}