Add OS support to transforms on website

Hoverbear · Hoverbear · commit 03e921fc31ad · 2020-06-10T10:40:00.000-07:00
Signed-off-by: Ana Hobden &lt;operator@hoverbear.org&gt;
diff --git a/.meta/.schemas/meta.json b/.meta/.schemas/meta.json
@@ -656,6 +656,14 @@
           "description": "A simple title for this transform, typically one word.",
           "minLength": 1,
           "max_lenfth": 50
+        },
+        "only_operating_systems": {
+          "$ref": "#/definitions/operating_systems",
+          "description": "A whitelist of operating systems supported by this source."
+        },
+        "except_operating_systems": {
+          "$ref": "#/definitions/operating_systems",
+          "description": "A blacklist of operating systems not supported by this source."
         }
       }
     }
diff --git a/.meta/transforms/wasm.toml.erb b/.meta/transforms/wasm.toml.erb
@@ -7,6 +7,7 @@ function_category = "program"
 input_types = ["log"]
 output_types = ["log"]
 requirements = {}
+only_operating_systems = ["Linux"]
 
 <%= render("_partials/fields/_component_options.toml", type: "transform", name: "wasm") %>
 
diff --git a/scripts/generate/templates/_partials/_component_header.md.erb b/scripts/generate/templates/_partials/_component_header.md.erb
@@ -7,7 +7,7 @@ description: <%= "The Vector `#{component.name}` #{component.type} #{component_s
 event_types: <%= component.event_types.to_json %>
 function_category: <%= component.function_category.to_json %>
 issues_url: <%= metadata.links.fetch("urls.#{component.id}_issues") %>
-<%- if !component.transform? -%>
+<%- if !component.transform? || component.respond_to?(:operating_systems) -%>
 operating_systems: <%= component.operating_systems.to_json %>
 <%- end -%>
 <%- if component.posts.any? -%>
@@ -17,7 +17,7 @@ sidebar_label: <%= "#{component.name}|#{component.event_types.to_json}".to_json
 source_url: <%= metadata.links.fetch("urls.#{component.id}_source") %>
 status: <%= component.status.to_json %>
 title: <%= "#{component.title} #{component.type.titleize}".to_json %>
-<%- if !component.transform? -%>
+<%- if !component.transform? || component.respond_to?(:operating_systems) -%>
 unsupported_operating_systems: <%= component.unsupported_operating_systems.to_json %>
 <%- end -%>
 ---
diff --git a/website/docs/reference/transforms/add_fields.md b/website/docs/reference/transforms/add_fields.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Add Fields"
 description: "The Vector `add_fields` transform accepts and outputs `log` events, allowing you to add one or more log fields."
 event_types: ["log"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+add_fields%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "add_fields|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/add_fields.rs
 status: "prod-ready"
 title: "Add Fields Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/add_tags.md b/website/docs/reference/transforms/add_tags.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Add Tags"
 description: "The Vector `add_tags` transform accepts and outputs `metric` events, allowing you to add one or more metric tags."
 event_types: ["metric"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+add_tags%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "add_tags|[\"metric\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/add_tags.rs
 status: "prod-ready"
 title: "Add Tags Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/ansi_stripper.md b/website/docs/reference/transforms/ansi_stripper.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "ANSI Stripper"
 description: "The Vector `ansi_stripper` transform accepts and outputs `log` events, allowing you to strips ANSI escape sequences from the specified field."
 event_types: ["log"]
 function_category: "sanitize"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+ansi_stripper%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "ansi_stripper|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/ansi_stripper.rs
 status: "prod-ready"
 title: "ANSI Stripper Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/aws_ec2_metadata.md b/website/docs/reference/transforms/aws_ec2_metadata.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-21"
+last_modified_on: "2020-06-10"
 component_title: "AWS EC2 Metadata"
 description: "The Vector `aws_ec2_metadata` transform accepts and outputs `log` events, allowing you to enrich logs with AWS EC2 instance metadata."
 event_types: ["log"]
 function_category: "enrich"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+aws_ec2_metadata%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "aws_ec2_metadata|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/aws_ec2_metadata.rs
 status: "beta"
 title: "AWS EC2 Metadata Transform"
+unsupported_operating_systems: []
 ---
 
 import Alert from '@site/src/components/Alert';
diff --git a/website/docs/reference/transforms/coercer.md b/website/docs/reference/transforms/coercer.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Coercer"
 description: "The Vector `coercer` transform accepts and outputs `log` events, allowing you to coerce log fields into fixed types."
 event_types: ["log"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+coercer%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "coercer|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/coercer.rs
 status: "prod-ready"
 title: "Coercer Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/concat.md b/website/docs/reference/transforms/concat.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Concat"
 description: "The Vector `concat` transform accepts and outputs `log` events, allowing you to concat (substrings) of other fields to a new one."
 event_types: ["log"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+concat%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "concat|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/concat.rs
 status: "beta"
 title: "Concat Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/dedupe.md b/website/docs/reference/transforms/dedupe.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-21"
+last_modified_on: "2020-06-10"
 component_title: "Dedupe events"
 description: "The Vector `dedupe` transform accepts and outputs `log` events, allowing you to prevent duplicate Events from being outputted by using an LRU cache."
 event_types: ["log"]
 function_category: "filter"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+dedupe%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "dedupe|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/dedupe.rs
 status: "prod-ready"
 title: "Dedupe events Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/filter.md b/website/docs/reference/transforms/filter.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-04"
+last_modified_on: "2020-06-10"
 component_title: "Filter"
 description: "The Vector `filter` transform accepts and outputs `log` and `metric` events, allowing you to select events based on a set of logical conditions."
 event_types: ["log","metric"]
 function_category: "filter"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+filter%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "filter|[\"log\",\"metric\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/filter.rs
 status: "beta"
 title: "Filter Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/geoip.md b/website/docs/reference/transforms/geoip.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "GeoIP"
 description: "The Vector [`geoip`](#geoip) transform accepts and outputs `log` events, allowing you to enrich events with geolocation data from the MaxMind GeoIP2 and GeoLite2 city databases."
 event_types: ["log"]
 function_category: "enrich"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+geoip%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "geoip|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/geoip.rs
 status: "beta"
 title: "GeoIP Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/grok_parser.md b/website/docs/reference/transforms/grok_parser.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-19"
+last_modified_on: "2020-06-10"
 component_title: "Grok Parser"
 description: "The Vector `grok_parser` transform accepts and outputs `log` events, allowing you to parse a log field value with Grok."
 event_types: ["log"]
 function_category: "parse"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+grok_parser%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "grok_parser|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/grok_parser.rs
 status: "prod-ready"
 title: "Grok Parser Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/json_parser.md b/website/docs/reference/transforms/json_parser.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-18"
+last_modified_on: "2020-06-10"
 component_title: "JSON Parser"
 description: "The Vector `json_parser` transform accepts and outputs `log` events, allowing you to parse a log field value as JSON."
 event_types: ["log"]
 function_category: "parse"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+json_parser%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "json_parser|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/json_parser.rs
 status: "prod-ready"
 title: "JSON Parser Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/log_to_metric.md b/website/docs/reference/transforms/log_to_metric.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Log to Metric"
 description: "The Vector `log_to_metric` transform accepts `log` events, but outputs [`metric`](#metric) events, allowing you to convert logs into one or more metrics."
 event_types: ["log","metric"]
 function_category: "convert"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+log_to_metric%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "log_to_metric|[\"log\",\"metric\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/log_to_metric.rs
 status: "prod-ready"
 title: "Log to Metric Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/logfmt_parser.md b/website/docs/reference/transforms/logfmt_parser.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Logfmt Parser"
 description: "The Vector `logfmt_parser` transform accepts and outputs `log` events, allowing you to parse a log field's value in the logfmt format."
 event_types: ["log"]
 function_category: "parse"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+logfmt_parser%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "logfmt_parser|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/logfmt_parser.rs
 status: "beta"
 title: "Logfmt Parser Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/lua.md b/website/docs/reference/transforms/lua.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-21"
+last_modified_on: "2020-06-10"
 component_title: "Lua"
 description: "The Vector `lua` transform accepts and outputs `log` and `metric` events, allowing you to transform events with a full embedded Lua engine."
 event_types: ["log","metric"]
 function_category: "program"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+lua%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "lua|[\"log\",\"metric\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/lua
 status: "beta"
 title: "Lua Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/merge.md b/website/docs/reference/transforms/merge.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Merge"
 description: "The Vector [`merge`](#merge) transform accepts and outputs `log` events, allowing you to merge partial log events into a single event."
 event_types: ["log"]
 function_category: "aggregate"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+merge%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "merge|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/merge.rs
 status: "beta"
 title: "Merge Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/regex_parser.md b/website/docs/reference/transforms/regex_parser.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-14"
+last_modified_on: "2020-06-10"
 component_title: "Regex Parser"
 description: "The Vector `regex_parser` transform accepts and outputs `log` events, allowing you to parse a log field's value with a Regular Expression."
 event_types: ["log"]
 function_category: "parse"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+regex_parser%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "regex_parser|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/regex_parser.rs
 status: "prod-ready"
 title: "Regex Parser Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/remove_fields.md b/website/docs/reference/transforms/remove_fields.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Remove Fields"
 description: "The Vector `remove_fields` transform accepts and outputs `log` events, allowing you to remove one or more log fields."
 event_types: ["log"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+remove_fields%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "remove_fields|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/remove_fields.rs
 status: "prod-ready"
 title: "Remove Fields Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/remove_tags.md b/website/docs/reference/transforms/remove_tags.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Remove Tags"
 description: "The Vector `remove_tags` transform accepts and outputs `metric` events, allowing you to remove one or more metric tags."
 event_types: ["metric"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+remove_tags%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "remove_tags|[\"metric\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/remove_tags.rs
 status: "prod-ready"
 title: "Remove Tags Transform"
+unsupported_operating_systems: []
 ---
 
 import Fields from '@site/src/components/Fields';
diff --git a/website/docs/reference/transforms/rename_fields.md b/website/docs/reference/transforms/rename_fields.md
@@ -1,14 +1,16 @@
 ---
-last_modified_on: "2020-05-01"
+last_modified_on: "2020-06-10"
 component_title: "Rename Fields"
 description: "The Vector `rename_fields` transform accepts and outputs `log` events, allowing you to rename one or more log fields."
 event_types: ["log"]
 function_category: "schema"
 issues_url: https://github.com/timberio/vector/issues?q=is%3Aopen+is%3Aissue+label%3A%22transform%3A+rename_fields%22
+operating_systems: ["Linux","MacOS","Windows"]
 sidebar_label: "rename_fields|[\"log\"]"
 source_url: https://github.com/timberio/vector/tree/master/src/transforms/rename_fields.rs
 status: "prod-ready"
 title: "Rename Fields Transform"
+unsupported_operating_systems: []
 ---
 
 import Alert from '@site/src/components/Alert';
diff --git a/website/docs/reference/transforms/sampler.md b/website/docs/reference/transforms/sampler.md
diff --git a/website/docs/reference/transforms/split.md b/website/docs/reference/transforms/split.md
diff --git a/website/docs/reference/transforms/swimlanes.md b/website/docs/reference/transforms/swimlanes.md
diff --git a/website/docs/reference/transforms/tag_cardinality_limit.md b/website/docs/reference/transforms/tag_cardinality_limit.md
diff --git a/website/docs/reference/transforms/tokenizer.md b/website/docs/reference/transforms/tokenizer.md
diff --git a/website/docs/reference/transforms/wasm.md b/website/docs/reference/transforms/wasm.md
diff --git a/website/metadata.js b/website/metadata.js

Original file line number	Diff line number	Diff line change
`@@ -656,6 +656,14 @@`
`656`	`656`	`"description": "A simple title for this transform, typically one word.",`
`657`	`657`	`"minLength": 1,`
`658`	`658`	`"max_lenfth": 50`
	`659`	`+ },`
	`660`	`+ "only_operating_systems": {`
	`661`	`+ "$ref": "#/definitions/operating_systems",`
	`662`	`+ "description": "A whitelist of operating systems supported by this source."`
	`663`	`+ },`
	`664`	`+ "except_operating_systems": {`
	`665`	`+ "$ref": "#/definitions/operating_systems",`
	`666`	`+ "description": "A blacklist of operating systems not supported by this source."`
`659`	`667`	`}`
`660`	`668`	`}`
`661`	`669`	`}`