Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
d3e31f5
Keep intro only one page
Mar 20, 2019
060e6d0
Fix sidebar issue
Mar 20, 2019
ca432ea
Temporarily hide use cases section.
Mar 20, 2019
99b04f7
Add a 'what is ecs' section at the top of the index page
Mar 20, 2019
dee7a71
Let's address the main objection right at the beginning
Mar 20, 2019
7608520
Space. The final frontier.
Mar 20, 2019
6a4aa6d
Restructure part 1
Mar 20, 2019
fc3d034
Finish the structuring of the docs
Mar 20, 2019
5ec021f
Create a broader 'migrating to ecs' section
Mar 20, 2019
13bd8f2
Flesh out the ecs-solutions page a little bit. Bogus links, though.
Mar 20, 2019
eaed272
Minor wording tweak
Mar 20, 2019
951498b
All of the feedback + my take on `converting.asciidoc`
Mar 21, 2019
4c77323
`make reload_doc` runs generator, then generates documentation
Mar 21, 2019
df0a22a
base wording and ECS definition
Mar 21, 2019
cefa0f1
Small tweaks based on review
Mar 21, 2019
1f3874b
Merge 2 sections in guidelines, reorder and reword to make more consi…
Mar 21, 2019
0b6477c
Try to replace the `prefix` wording with `field set` wording.
Mar 21, 2019
7f827c6
Disable Logstash section for now
Mar 21, 2019
d48e50c
Address the 'solutions' wording and remove links we don't have
Mar 21, 2019
4ce188f
Remove logstash include
Mar 21, 2019
af2c92f
Make the list of products much less chatty
Mar 21, 2019
27d54df
Do a pass on conventions page.
Mar 22, 2019
8c289e5
I think it's important to mention the version of ECS this documentati…
Mar 22, 2019
36f9739
Update ECS definition with my latest attempt...
Mar 22, 2019
61a6d16
Move the updated definitions of core and extended to 'guidelines'
Mar 22, 2019
4f0b407
Additional details about field levels in overview paragraph
Mar 22, 2019
7b68602
Ensure multi-line field set definitions actually render multiple para…
Mar 22, 2019
b863e60
Ensure field descriptions also render paragraphs correctly
Mar 22, 2019
ce1edac
Fix JSON code block in faq
Mar 22, 2019
238e07e
make fmt
Mar 25, 2019
9f65973
Streamline the SemVer text in the overview page
Mar 25, 2019
8f81b52
Minor wording tweaks in conventions page
Mar 25, 2019
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
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,9 @@ readme:
cat docs/about.md >> README.md
cat docs/generated-files.md >> README.md

.PHONY: reload_docs
reload_docs: generator docs

# Download and setup tooling dependencies.
.PHONY: setup
setup: ve
Expand Down
7 changes: 7 additions & 0 deletions docs/additional.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[[ecs-additional-information]]
== Additional Information

// include::use-cases.asciidoc[]
include::faq.asciidoc[]
include::glossary.asciidoc[]
include::contributing.asciidoc[]
3 changes: 1 addition & 2 deletions docs/contributing.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[[ecs-contributing]]
== Contributing to {ecs}
=== Contributing to {ecs}

All information related to ECS is versioned in the https://github.com/elastic/ecs[elastic/ecs] repository. All
changes to ECS happen through Pull Requests submitted through Git.

See the https://github.com/elastic/ecs/blob/master/CONTRIBUTING.md[Contribution Guidelines].

52 changes: 0 additions & 52 deletions docs/convert.asciidoc

This file was deleted.

46 changes: 46 additions & 0 deletions docs/converting.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
[[ecs-converting]]
=== Converting a Custom Implementation

A common schema helps you correlate and use data from various sources.

Fields for most Elastic modules and solutions (version 7.0 and later) are mapped
to the Elastic Common Schema. You may want to map data from other
implementations to ECS to help you correlate data across all of your products
and solutions.

Before you start a conversion, be sure that you understand the basics below.

[float]
[[core-or-ext]]
==== Core and extended levels

Make sure you understand the distinction between Core and Extended fields,
as explained in the <<ecs-guidelines>>.

[float]
[[ecs-conv]]
==== An approach to mapping an existing implementation

Here's the recommended approach for converting an existing implementation to {ecs}.

. Review each field in your original event and map it to the relevant ECS field.

- Start by mapping your field to the relevant ECS Core field.
- If a relevant ECS Core field does not exist, map your field to the relevant ECS Extended field.
- If no relevant ECS Extended field exists, consider keeping your field with its original details,
or possibly renaming it using ECS naming guidelines and attempt to map one
or more of your original event fields to it.

. Review each ECS Core field, and attempt to populate it.

- Review your original event data again
- Consider populating the field based on additional meta-data such as static
information (e.g. add `event.type:syslog` even if syslog events don't mention this fact),
or information gathered from the environment (e.g. host information).

. Review other extended fields from any field set you are already using, and
attempt to populate it as well.

. Set `ecs.version` to the version of the schema you are conforming to. This will
allow you to upgrade your sources, pipelines and content (like dashboards)
smoothly in the future.
33 changes: 15 additions & 18 deletions docs/faq.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[[ecs-faq]]
== FAQ
=== Questions and Answers

[float]
[[ecs-benefits]]
=== What are the benefits of using ECS?
==== What are the benefits of using ECS?

The benefits to a user adopting these fields and names in their clusters are:

Expand All @@ -18,7 +18,7 @@ The benefits to a user adopting these fields and names in their clusters are:

[float]
[[conflict]]
=== What if I have fields that conflict with ECS?
==== What if I have fields that conflict with ECS?

The
{ref}/rename-processor.html[rename
Expand All @@ -30,34 +30,33 @@ field. If your field does not match ECS, you can rename your field to

[float]
[[addl-fields]]
=== What if my events have additional fields?
==== What if my events have additional fields?

Events may contain fields in addition to ECS fields. These fields can follow the
ECS naming and writing rules, but this is not a requirement.

[float]
[[dot-notation]]
=== Why does ECS use a dot notation instead of an underline notation?
==== Why does ECS use a dot notation instead of an underline notation?

There are two common key formats for ingesting data into Elasticsearch:

* Dot notation: `user.firstname: Nicolas`, `user.lastname: Ruflin`
* Underline notation: `user_firstname: Nicolas`, `user_lastname: Ruflin`

ECS uses the dot notation to represent nested objects.
ECS uses the dot notation to represent nested objects.

[float]
[[notation-diff]]
==== What is the difference between the two notations?
===== What is the difference between the two notations?

Ingesting `user.firstname: Nicolas` and `user.lastname: Ruflin` is identical to ingesting the following JSON:

```
"user": {
"firstname": "Nicolas",
"lastname": "Ruflin"
}
```
[source,json]
"user": {
"firstname": "Nicolas",
"lastname": "Ruflin"
}

In Elasticsearch, `user` is represented as an {ref}/object.html[object
datatype]. In the case of the underline notation, both are just
Expand All @@ -68,7 +67,7 @@ datatypes], which are arrays of objects.

[float]
[[dot-adv]]
==== Advantages of dot notation
===== Advantages of dot notation

With dot notation, each prefix in Elasticsearch is an object. Each object can have
{ref}/object.html#object-params[parameters]
Expand All @@ -87,7 +86,7 @@ modifying each part of the final event easier.

[float]
[[dot-disadv]]
==== Disadvantage of dot notation
===== Disadvantage of dot notation

In Elasticsearch, each key can have only one type. For example, if `user` is an
`object`, you can't use it as a `keyword` type in the same index, like `{"user":
Expand All @@ -96,9 +95,7 @@ the ECS data itself, this is not an issue because all fields are predefined.

[float]
[[underline]]
==== What if I already use the underline notation?
===== What if I already use the underline notation?

As long as there are no conflicts, underline notation and ECS dot notation can
coexist in the same document.


Loading