docs, update tests

taylor-swanson · taylor-swanson · commit 8e07ee645003 · 2025-11-10T13:15:20.000-06:00
diff --git a/README.md b/README.md
@@ -68,7 +68,7 @@ to [JSON Schema](https://json-schema.org/), but with a couple of differences:
 
 Expected package files, e.g. `manifest.yml` themselves have a structure to their contents. This structure is described in specification files using JSON schema (this is point 2. above). These specification files are also written as YAML for readability.
 
-Note that the specification files primarily define the structure (syntax) of a package's contents. To a limited extent they may also define some semantics, e.g. enumeration values for certain fields. Richer semantics, however, will need to be expressed as validation code.
+Note that the specification files primarily define the structure (syntax) of a package's contents. To a limited extent they may also define some semantics, e.g. enumeration values for certain fields. Richer semantics, however, will need to be expressed as [validation code](docs/validations.md).
 
 # Specification Versioning
 
diff --git a/docs/validations.md b/docs/validations.md
@@ -0,0 +1,80 @@
+# Validation Codes
+
+| Validation          | Short description                     |
+|---------------------|---------------------------------------|
+| **[JSE][JSE00001]** | **JSON Schema Errors**                |
+| [JSE00001]          | Rename message to event.original      |
+| **[PSR][PSR00001]** | **Package Spec Rule**                 |
+| [PSR00001]          | Non GA spec used in GA package        |
+| [PSR00002]          | Prerelease feature used in GA package |
+| **[SVR][SVR00001]** | **Semantic Validation Rules**         |
+| [SVR00001]          | Dashboard with query but no filter    |
+| [SVR00002]          | Dashboard without filter              |
+| [SVR00003]          | Dangling object IDs                   |
+| [SVR00004]          | Visualization by value                |
+| [SVR00005]          | Minimum Kibana version                |
+| [SVR00006]          | Processor tag is required             |
+| [SVR00007]          | Processor tag duplicated in pipeline  |
+
+## JSE00001 - Rename message to event.original
+[JSE00001]: #jse00001---rename-message-to-eventoriginal
+
+**Available since [3.1.0](https://github.com/elastic/package-spec/releases/tag/v3.1.0)**
+
+## PSR00001 - Non GA spec used in GA package
+[PSR00001]: #psr00001---non-ga-spec-used-in-ga-package
+
+**Available since [3.0.1](https://github.com/elastic/package-spec/releases/tag/v3.0.1)**
+
+## PSR00002 - Prerelease feature used in GA package
+[PSR00002]: #psr00002---prerelease-feature-used-in-ga-package
+
+**Available since [3.0.0](https://github.com/elastic/package-spec/releases/tag/v3.0.0)**
+
+## SVR00001 - Dashboard with query but no filter
+[SVR00001]: #svr00001---dashboard-with-query-but-no-filter
+
+**Available since [2.13.0](https://github.com/elastic/package-spec/releases/tag/v2.13.0)**
+
+## SVR00002 - Dashboard without filter
+[SVR00002]: #svr00002---dashboard-without-filter
+
+**Available since [2.13.0](https://github.com/elastic/package-spec/releases/tag/v2.13.0)**
+
+## SVR00003 - Dangling object IDs
+[SVR00003]: #svr00003---dangling-object-ids
+
+**Available since [2.13.0](https://github.com/elastic/package-spec/releases/tag/v2.13.0)**
+
+## SVR00004 - Visualization by value
+[SVR00004]: #svr00004---visualization-by-value
+
+**Available since [3.0.0](https://github.com/elastic/package-spec/releases/tag/v3.0.0)**
+
+## SVR00005 - Minimum Kibana version
+[SVR00005]: #svr00005---minimum-kibana-version
+
+**Available since [3.0.0](https://github.com/elastic/package-spec/releases/tag/v3.0.0)**
+
+## SVR00006 - Processor tag is required
+[SVR00006]: #svr00006---processor-tag-is-required
+
+**Available since [3.6.0](https://github.com/elastic/package-spec/releases/tag/v3.6.0)**
+
+Every processor in an ingest pipeline must include a unique tag, which is used to
+annotate the processor in metrics and logs.
+
+```yaml
+set:
+  tag: set_event_category
+  field: event.category
+  value: [network]
+```
+
+## SVR00007 - Processor tag duplicated in pipeline
+[SVR00007]: #svr00007---processor-tag-duplicated-in-pipeline
+
+**Available since [3.6.0](https://github.com/elastic/package-spec/releases/tag/v3.6.0)**
+
+A processor tag must not be repeated in an ingest pipeline. A tag must uniquely
+identify a processor in a pipeline so it can be annotated in metrics and logs.
diff --git a/test/packages/good_v3/changelog.yml b/test/packages/good_v3/changelog.yml
@@ -1,3 +1,8 @@
+- version: 1.1.0
+  changes:
+    - description: Add processor tags
+      type: enhancement
+      link: https://github.com/elastic/package-spec/pull/1010
 - version: 1.0.1
   changes:
     - description: Add kibana configuration links
diff --git a/test/packages/good_v3/data_stream/agent_settings/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/agent_settings/elasticsearch/ingest_pipeline/default.yml
@@ -2,6 +2,7 @@
 description: Pipeline for processing sample logs
 processors:
 - set:
+    tag: set_sample_field
     field: sample_field
     value: "1"
 on_failure:
diff --git a/test/packages/good_v3/data_stream/ecs_import_mappings/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/ecs_import_mappings/elasticsearch/ingest_pipeline/default.yml
@@ -2,6 +2,7 @@
 description: Pipeline for processing sample logs
 processors:
 - set:
+    tag: set_sample_field
     field: sample_field
     value: "1"
 on_failure:
diff --git a/test/packages/good_v3/data_stream/foo/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/foo/elasticsearch/ingest_pipeline/default.yml
@@ -3,6 +3,7 @@ description: Pipeline for Microsoft DHCP
 
 processors:
   - rename:
+      tag: rename_foo_to_message
       field: foo
       target_field: message
       ignore_missing: true
diff --git a/test/packages/good_v3/data_stream/rename_message/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/rename_message/elasticsearch/ingest_pipeline/default.yml
@@ -3,12 +3,14 @@ description: Test pipeline with renaming processor
 processors:
     # cf. https://github.com/elastic/integrations/pull/7026/files#diff-dafc5693f21abb74b294987b502cdc5770f22cccff3c5a8fee0d48510791b811
     - rename:
+        tag: rename message_to_event_original
         field: message
         target_field: event.original
         ignore_missing: true
         if: 'ctx.event?.original == null'
         description: 'Renames the original `message` field to `event.original` to store a copy of the original message. The `event.original` field is not touched if the document already has one; it may happen when Logstash sends the document.'
     - remove:
+        tag: remove_message
         field: message
         ignore_missing: true
         if: 'ctx.event?.original != null'
diff --git a/test/packages/good_v3/data_stream/root/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/root/elasticsearch/ingest_pipeline/default.yml
@@ -2,6 +2,7 @@
 description: Pipeline for processing sample logs
 processors:
 - set:
+    tag: set_sample_field
     field: sample_field
     value: "1"
 on_failure:
diff --git a/test/packages/good_v3/data_stream/routing_rules/elasticsearch/ingest_pipeline/default.yml b/test/packages/good_v3/data_stream/routing_rules/elasticsearch/ingest_pipeline/default.yml
@@ -2,6 +2,7 @@
 description: Pipeline for processing sample logs
 processors:
 - set:
+    set: sample_field
     field: sample_field
     value: "1"
 on_failure:
diff --git a/test/packages/good_v3/manifest.yml b/test/packages/good_v3/manifest.yml
@@ -2,7 +2,7 @@ format_version: 3.6.0
 name: good_v3
 title: Good package
 description: This package is good for format version 3
-version: 1.0.1
+version: 1.1.0
 type: integration
 source:
   license: "Apache-2.0"
