Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.x] Remove beta warning label from categorization fields docs (#1067) #1196

Merged
merged 1 commit into from
Dec 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Thanks, you're awesome :-) -->

#### Improvements

* Event categorization fields GA. #1067
* Note `[` and `]` bracket characters may enclose a literal IPv6 address when populating `url.domain`. #1131

#### Deprecated
Expand Down
27 changes: 0 additions & 27 deletions docs/field-values.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@
[[ecs-category-field-values-reference]]
== {ecs} Categorization Fields

WARNING: This section of ECS is in beta and is subject to change. These allowed values
are still under active development. Additional values will be published gradually,
and some of the values or relationships described here may change.
Users who want to provide feedback, or who want to have a look at
upcoming allowed values can visit this public feedback document
https://ela.st/ecs-categories-draft.

At a high level, ECS provides fields to classify events in two different ways:
"Where it's from" (e.g., `event.module`, `event.dataset`, `agent.type`, `observer.type`, etc.),
and "What it is." The categorization fields hold the "What it is" information,
Expand Down Expand Up @@ -38,11 +31,6 @@ This is one of four ECS Categorization Fields, and indicates the highest level i

The value of this field can be used to inform how these kinds of events should be handled. They may warrant different retention, different access control, it may also help understand whether the data coming in at a regular interval or not.

WARNING: After the beta period for categorization, only the allowed categorization
values listed in the ECS repository and official ECS documentation should be considered
official. Use of any other values may result in incompatible implementations
that will require subsequent breaking changes.

*Allowed Values*

* <<ecs-event-kind-alert,alert>>
Expand Down Expand Up @@ -125,11 +113,6 @@ This is one of four ECS Categorization Fields, and indicates the second level in

This field is an array. This will allow proper categorization of some events that fall in multiple categories.

WARNING: After the beta period for categorization, only the allowed categorization
values listed in the ECS repository and official ECS documentation should be considered
official. Use of any other values may result in incompatible implementations
that will require subsequent breaking changes.

*Allowed Values*

* <<ecs-event-category-authentication,authentication>>
Expand Down Expand Up @@ -345,11 +328,6 @@ This is one of four ECS Categorization Fields, and indicates the third level in

This field is an array. This will allow proper categorization of some events that fall in multiple event types.

WARNING: After the beta period for categorization, only the allowed categorization
values listed in the ECS repository and official ECS documentation should be considered
official. Use of any other values may result in incompatible implementations
that will require subsequent breaking changes.

*Allowed Values*

* <<ecs-event-type-access,access>>
Expand Down Expand Up @@ -510,11 +488,6 @@ Also note that in the case of a compound event (a single event that contains mul

Further note that not all events will have an associated outcome. For example, this field is generally not populated for metric events, events with `event.type:info`, or any events for which an outcome does not make logical sense.

WARNING: After the beta period for categorization, only the allowed categorization
values listed in the ECS repository and official ECS documentation should be considered
official. Use of any other values may result in incompatible implementations
that will require subsequent breaking changes.

*Allowed Values*

* <<ecs-event-outcome-failure,failure>>
Expand Down
12 changes: 0 additions & 12 deletions scripts/templates/field_values.j2
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@
[[ecs-category-field-values-reference]]
== {ecs} Categorization Fields

WARNING: This section of ECS is in beta and is subject to change. These allowed values
are still under active development. Additional values will be published gradually,
and some of the values or relationships described here may change.
Users who want to provide feedback, or who want to have a look at
upcoming allowed values can visit this public feedback document
https://ela.st/ecs-categories-draft.

At a high level, ECS provides fields to classify events in two different ways:
"Where it's from" (e.g., `event.module`, `event.dataset`, `agent.type`, `observer.type`, etc.),
and "What it is." The categorization fields hold the "What it is" information,
Expand All @@ -34,11 +27,6 @@ once the appropriate categorization values are published, in a later release.

{{ field['description']|replace("\n", "\n\n") }}

WARNING: After the beta period for categorization, only the allowed categorization
values listed in the ECS repository and official ECS documentation should be considered
official. Use of any other values may result in incompatible implementations
that will require subsequent breaking changes.

*Allowed Values*
{% for value_details in field['allowed_values'] %}
* <<ecs-{{ field['dashed_name'] }}-{{ value_details['name'] }},{{ value_details['name'] }}>>
Expand Down