Skip to content

Commit

Permalink
Improvements for the RFC template, and adjustments to existing RFCs. (#…
Browse files Browse the repository at this point in the history
…898)

* Clarify guidance at the header of the rfc template.
* Add "references" section to RFC template and a place to link stage PRs of that RFC.
  * RFCs should link to each of their stage advancement PRs.
  * This will help people review past discussions around RFCs they're interested in.
* Add the stage 0 PR links to each of the merged RFCs.
  • Loading branch information
Mathieu Martin authored Jul 28, 2020
1 parent b9d8273 commit 4994b26
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 5 deletions.
22 changes: 19 additions & 3 deletions rfcs/0000-rfc-template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 0000: Name of RFC
<!--^ The ECS team will assign a unique, contiguous RFC number upon merging the initial stage of this RFC, taking care not to conflict with other RFCs.-->
<!-- Leave this ID at 0000. The ECS team will assign a unique, contiguous RFC number upon merging the initial stage of this RFC. -->

- Stage: **0 (strawperson)** <!-- Update to reflect target stage -->
- Date: **TBD** <!-- Update to reflect date of most recent stage advancement -->
- Stage: **0 (strawperson)** <!-- Update to reflect target stage. See https://elastic.github.io/ecs/stages.html -->
- Date: **TBD** <!-- The ECS team sets this date at merge time. This is the date of the latest stage advancement. -->

<!--
Stage 0: Provide a high level summary of the premise of these changes. Briefly describe the nature, purpose, and impact of the changes. ~2-5 sentences.
Expand Down Expand Up @@ -93,3 +93,19 @@ e.g.:
* @JaneDoe | grammar, spelling, prose
* @Mariana
-->


## References

<!-- Insert any links appropriate to this RFC in this section. -->

### RFC Pull Requests

<!-- An RFC should link to the PRs for each of it stage advancements. -->

* Stage 0: https://github.com/elastic/ecs/pull/NNN

<!--
* Stage 1: https://github.com/elastic/ecs/pull/NNN
...
-->
16 changes: 16 additions & 0 deletions rfcs/text/0001-wildcard-data-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,19 @@ The following are the people that consulted on the contents of this RFC.
* [0] Wildcard queries on `text` fields are limited to matching individual tokens rather than the original value of the field.
* [1] Keyword fields are not tokenized like `text` fields, so patterns can match multiple words. However they suffer from slow performance with wildcard searching (especially with leading wildcards).
* [2] https://github.com/elastic/elasticsearch/pull/58483


## References

<!-- Insert any links appropriate to this RFC in this section. -->

### RFC Pull Requests

<!-- An RFC should link to the PRs for each of it stage advancements. -->

* Stage 0: https://github.com/elastic/ecs/pull/890

<!--
* Stage 1: https://github.com/elastic/ecs/pull/NNN
...
-->
20 changes: 18 additions & 2 deletions rfcs/text/0002-rfc-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Observability: data produced by the infrastruture and application layers. Data t
Security: security data should also benefit of specifying the `environment` from which they are emitted to offer filtering (SIEM...) on Elastic cluster spreading across multiple environments (e.g. "production" and "staging").


Logs are typically being collected by Filebeat, metrics are collected by Metricbeat,
Logs are typically being collected by Filebeat, metrics are collected by Metricbeat,
<!--
Stage 1: Provide a high-level description of example sources of data. This does not yet need to be a concrete example of a source document, but instead can simply describe a potential source (e.g. nginx access log). This will ultimately be fleshed out to include literal source examples in a future stage. The goal here is to identify practical sources for these fields in the real world. ~1-3 sentences or unordered list.
-->
Expand Down Expand Up @@ -157,7 +157,7 @@ The goal here is to research and understand the impact of these changes on users
* https://github.com/elastic/ecs/issues/268 Add new top level field "environment" #268
* https://github.com/elastic/ecs/issues/704 New field: organization.environment #704
* https://github.com/elastic/ecs/issues/143 agent.environment and service.environment #143

<!--
Stage 1: Identify potential concerns, implementation challenges, or complexity. Spend some time on this. Play devil's advocate. Try to identify the sort of non-obvious challenges that tend to surface later. The goal here is to surface risks early, allow everyone the time to work through them, and ultimately document resolution for posterity's sake.
-->
Expand Down Expand Up @@ -233,3 +233,19 @@ logging.level: info
* ? | sponsor
* @roncohen | subject matter expert
* ? | grammar, spelling, prose


## References

<!-- Insert any links appropriate to this RFC in this section. -->

### RFC Pull Requests

<!-- An RFC should link to the PRs for each of it stage advancements. -->

* Stage 0: https://github.com/elastic/ecs/pull/891

<!--
* Stage 1: https://github.com/elastic/ecs/pull/NNN
...
-->
16 changes: 16 additions & 0 deletions rfcs/text/0003-object-field.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,19 @@ e.g.:
* @JaneDoe | grammar, spelling, prose
* @Mariana
-->


## References

<!-- Insert any links appropriate to this RFC in this section. -->

### RFC Pull Requests

<!-- An RFC should link to the PRs for each of it stage advancements. -->

* Stage 0: https://github.com/elastic/ecs/pull/883

<!--
* Stage 1: https://github.com/elastic/ecs/pull/NNN
...
-->

0 comments on commit 4994b26

Please sign in to comment.