Component schema

AttributePatternRuleDefinition

object4 direct references

Definition

A Pattern Rule abstracts a high-cardinality value of the telemetry attribute named by spec.targetAttribute (e.g. /users/1234) into a templated one (e.g. /users/<userId>), so the collector can collapse matching values together. For dash0.operation.name — the default, and the only target attribute mined today — that is the collector's Operation Processor collapsing span operation names. Rows are either authored by a human through this API (spec.ownership: user_defined) or inferred by the miner (spec.ownership: auto_derived).

Unlike most CRD-enveloped resources in this API, Pattern Rules have no independent, user-editable display name, versioning, folder, or sharing concept -- metadata.name is server-computed (see below). They are addressable either by their server-generated metadata.labels["dash0.com/id"] or by metadata.labels["dash0.com/origin"] (an IaC/Terraform-style stable label) -- see {originOrId} on each path below. metadata.labels["dash0.com/dataset"]/spec.serviceNamespace/spec.serviceName identify the partition (dataset + service) a rule belongs to, and are immutable once the rule is created.

stringrequired

"Dash0AttributePatternRule"

AttributePatternRuleMetadatarequired

AttributePatternRuleSpecrequired

Used by 4

These schemas and endpoints reference this type directly.

SchemaAttributePatternRuleCreateRequestSchemaAttributePatternRuleListResponseSchemaAttributePatternRuleResponseSchemaAttributePatternRuleUpdateRequest

json

OpenAPI source12345678910111213141516171819202122
{
  "description": "A Pattern Rule abstracts a high-cardinality value of the telemetry attribute named by\n`spec.targetAttribute` (e.g. `/users/1234`) into a templated one (e.g.\n`/users/<userId>`), so the collector can collapse matching values together. For\n`dash0.operation.name` — the default, and the only target attribute mined today —\nthat is the collector's Operation Processor collapsing span operation names. Rows are\neither authored by a human through this API (`spec.ownership: user_defined`) or\ninferred by the miner (`spec.ownership: auto_derived`).\n\nUnlike most CRD-enveloped resources in this API, Pattern Rules have no independent,\nuser-editable display name, versioning, folder, or sharing concept -- `metadata.name` is\nserver-computed (see below). They are addressable either by their server-generated\n`metadata.labels[\"dash0.com/id\"]` or by `metadata.labels[\"dash0.com/origin\"]` (an\nIaC/Terraform-style stable label) -- see `{originOrId}` on each path below.\n`metadata.labels[\"dash0.com/dataset\"]`/`spec.serviceNamespace`/`spec.serviceName` identify\nthe partition (dataset + service) a rule belongs to, and are immutable once the rule is\ncreated.\n",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "Dash0AttributePatternRule"
      ]
    },
    "metadata": {
      "$ref": "#/components/schemas/AttributePatternRuleMetadata"
    },
    "spec": {
      "$ref": "#/components/schemas/AttributePatternRuleSpec"
    }
  },
  "required": [
    "kind",
    "metadata",
    "spec"
  ]
}