Component schema

TelemetryFilter

object1 direct reference

Definition

The CRD API version used when this filter was created or last updated. Determines which spec shape the server returns on read. Defaults to v1alpha1 when absent.

"v1alpha1""v1alpha2"

string

Unique identifier for this spam filter. Server-generated on creation. For existing filters without an ID, a deterministic UUID is derived from a hash of the filter specification or of the condition.

string

Immutable external identifier for this spam filter, used by Infrastructure-as-Code tools (Terraform, Kubernetes operator). When set, the filter is read-only in the UI.

CrdSource

Origin of a Dash0 resource, derived from dash0.com/origin on read.

ui: created interactively in the Dash0 UI.
terraform: managed via the Dash0 Terraform provider.
operator: managed via the Dash0 Kubernetes operator.
dash0-cli: managed via the Dash0 CLI.
platform: owned by Dash0 rather than by anyone in your organization. Covers both resources Dash0 generates from another resource you own (the recording rules an SLO produces) and resources Dash0 ships with the product (the built-in views).
api: created directly through the API, and the fallback for any origin whose prefix is not recognized.

New values may be added over time. Treat an unrecognized value as api rather than rejecting the response.

"ui""terraform""operator""dash0-cli""platform""api"

boolean

Whether this telemetry filter is active. When absent or true, the filter is applied. When explicitly set to false, the filter is skipped.

string

An optional human-readable name for this telemetry filter.

TelemetryFilterContextrequired

The signal type this telemetry filter applies to.

"datapoint""span""log""web_event"

FilterCriteria

Structured filter criteria in human-readable form. When provided, the server compiles this into an OTTL condition. Mutually exclusive with condition.

OTTLConditionrequired

Raw OTTL condition expression. Mutually exclusive with filter. Use this for advanced filtering that cannot be expressed via structured FilterCriteria. If the condition resolves to true, the data will be dropped. Supports and, or, and ().

Used by 1

These schemas and endpoints reference this type directly.

SchemaDatasetSettings

json

OpenAPI source1234567891011121314151617181920212223242526272829303132333435363738394041424344
{
  "properties": {
    "apiVersion": {
      "$ref": "#/components/schemas/SpamFilterApiVersion",
      "description": "The CRD API version used when this filter was created or last updated.\nDetermines which spec shape the server returns on read.\nDefaults to `v1alpha1` when absent.\n"
    },
    "id": {
      "description": "Unique identifier for this spam filter. Server-generated on creation.\nFor existing filters without an ID, a deterministic UUID is derived\nfrom a hash of the filter specification or of the condition.\n",
      "type": "string",
      "format": "uuid"
    },
    "origin": {
      "description": "Immutable external identifier for this spam filter, used by\nInfrastructure-as-Code tools (Terraform, Kubernetes operator).\nWhen set, the filter is read-only in the UI.\n",
      "type": "string"
    },
    "source": {
      "$ref": "#/components/schemas/CrdSource"
    },
    "enabled": {
      "description": "Whether this telemetry filter is active. When absent or true, the filter\nis applied. When explicitly set to false, the filter is skipped.\n",
      "type": "boolean"
    },
    "name": {
      "description": "An optional human-readable name for this telemetry filter.",
      "type": "string"
    },
    "context": {
      "$ref": "#/components/schemas/TelemetryFilterContext",
      "description": "The signal type this telemetry filter applies to.\n"
    },
    "filter": {
      "$ref": "#/components/schemas/FilterCriteria",
      "description": "Structured filter criteria in human-readable form. When provided, the\nserver compiles this into an OTTL condition. Mutually exclusive with\n`condition`.\n"
    },
    "condition": {
      "$ref": "#/components/schemas/OTTLCondition",
      "description": "Raw OTTL condition expression. Mutually exclusive with `filter`. Use this\nfor advanced filtering that cannot be expressed via structured\n`FilterCriteria`. If the condition resolves to true, the data will be\ndropped. Supports `and`, `or`, and `()`.\n"
    }
  },
  "required": [
    "context",
    "condition"
  ]
}