Skip to content

Commit c01cc6b

Browse files
committed
fix fields in README
1 parent 4124f36 commit c01cc6b

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

packages/wiz/docs/README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,51 @@ An example event for `cloud_configuration_finding_full_posture` looks as followi
445445

446446
**Exported fields**
447447

448-
(no fields available)
448+
| Field | Description | Type |
449+
|---|---|---|
450+
| @timestamp | Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. If the event source has no original timestamp, this value is typically populated by the first time the event was received by the pipeline. Required field for all events. | date |
451+
| data_stream.dataset | The field can contain anything that makes sense to signify the source of the data. Examples include `nginx.access`, `prometheus`, `endpoint` etc. For data streams that otherwise fit, but that do not have dataset set we use the value "generic" for the dataset value. `event.dataset` should have the same value as `data_stream.dataset`. Beyond the Elasticsearch data stream naming criteria noted above, the `dataset` value has additional restrictions: \* Must not contain `-` \* No longer than 100 characters | constant_keyword |
452+
| data_stream.namespace | A user defined namespace. Namespaces are useful to allow grouping of data. Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with `default`. If no value is used, it falls back to `default`. Beyond the Elasticsearch index naming criteria noted above, `namespace` value has the additional restrictions: \* Must not contain `-` \* No longer than 100 characters | constant_keyword |
453+
| data_stream.type | An overarching type for the data stream. Currently allowed values are "logs" and "metrics". We expect to also add "traces" and "synthetics" in the near future. | constant_keyword |
454+
| event.dataset | Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. It's recommended but not required to start the dataset name with the module name, followed by a dot, then the dataset name. | constant_keyword |
455+
| event.module | Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), `event.module` should contain the name of this module. | constant_keyword |
456+
| input.type | Type of filebeat input. | keyword |
457+
| log.offset | Log offset. | long |
458+
| resource.id | | keyword |
459+
| resource.name | | keyword |
460+
| resource.sub_type | | keyword |
461+
| resource.type | | keyword |
462+
| result.evaluation | | keyword |
463+
| result.evidence.cloud_configuration_link | | text |
464+
| result.evidence.configuration_path | | text |
465+
| result.evidence.current_value | | text |
466+
| result.evidence.expected_value | | text |
467+
| rule.remediation | | keyword |
468+
| tags | List of keywords used to tag each event. | keyword |
469+
| wiz.cloud_configuration_finding_full_posture.analyzed_at | | date |
470+
| wiz.cloud_configuration_finding_full_posture.evidence.cloud_configuration_link | | text |
471+
| wiz.cloud_configuration_finding_full_posture.evidence.configuration_path | | text |
472+
| wiz.cloud_configuration_finding_full_posture.evidence.current_value | | text |
473+
| wiz.cloud_configuration_finding_full_posture.evidence.expected_value | | text |
474+
| wiz.cloud_configuration_finding_full_posture.id | | keyword |
475+
| wiz.cloud_configuration_finding_full_posture.name | | keyword |
476+
| wiz.cloud_configuration_finding_full_posture.resource.cloud_platform | | keyword |
477+
| wiz.cloud_configuration_finding_full_posture.resource.id | | keyword |
478+
| wiz.cloud_configuration_finding_full_posture.resource.name | | keyword |
479+
| wiz.cloud_configuration_finding_full_posture.resource.native_type | | keyword |
480+
| wiz.cloud_configuration_finding_full_posture.resource.provider_id | | keyword |
481+
| wiz.cloud_configuration_finding_full_posture.resource.region | | keyword |
482+
| wiz.cloud_configuration_finding_full_posture.resource.subscription.cloud_provider | | keyword |
483+
| wiz.cloud_configuration_finding_full_posture.resource.subscription.external_id | | keyword |
484+
| wiz.cloud_configuration_finding_full_posture.resource.subscription.name | | keyword |
485+
| wiz.cloud_configuration_finding_full_posture.resource.type | | keyword |
486+
| wiz.cloud_configuration_finding_full_posture.result | | keyword |
487+
| wiz.cloud_configuration_finding_full_posture.rule.description | | text |
488+
| wiz.cloud_configuration_finding_full_posture.rule.id | | keyword |
489+
| wiz.cloud_configuration_finding_full_posture.rule.name | | keyword |
490+
| wiz.cloud_configuration_finding_full_posture.rule.remediation_instructions | | text |
491+
| wiz.cloud_configuration_finding_full_posture.rule.short_id | | keyword |
492+
| wiz.cloud_configuration_finding_full_posture.status | | keyword |
449493

450494

451495
### Issue

0 commit comments

Comments
 (0)