Component schema

OperationPatternRuleDefinition

object4 direct references

Definition

A Pattern Rule abstracts a high-cardinality span operation name (e.g. /users/1234) into a templated one (e.g. /users/<userId>), so the collector's Operation Processor can collapse matching operation names together. Rows are either authored by a human through this API (spec.ownership: user_defined) or inferred by the Operation 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

"Dash0OperationPatternRule"

OperationPatternRuleMetadatarequired

OperationPatternRuleSpecrequired

Used by 4

These schemas and endpoints reference this type directly.

SchemaOperationPatternRuleCreateRequestSchemaOperationPatternRuleListResponseSchemaOperationPatternRuleResponseSchemaOperationPatternRuleUpdateRequest

json

OpenAPI source12345678910111213141516171819202122
{
  "description": "A Pattern Rule abstracts a high-cardinality span operation name (e.g. `/users/1234`)\ninto a templated one (e.g. `/users/<userId>`), so the collector's Operation Processor\ncan collapse matching operation names together. Rows are either authored by a human\nthrough this API (`spec.ownership: user_defined`) or inferred by the Operation Miner\n(`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": [
        "Dash0OperationPatternRule"
      ]
    },
    "metadata": {
      "$ref": "#/components/schemas/OperationPatternRuleMetadata"
    },
    "spec": {
      "$ref": "#/components/schemas/OperationPatternRuleSpec"
    }
  },
  "required": [
    "kind",
    "metadata",
    "spec"
  ]
}