Skip to content

Commit

Permalink
Try to clarify the meaning of the non-directional 'internal' and 'ext…
Browse files Browse the repository at this point in the history
…ernal' values.

Also quoting the values, when they're mentioned in the description.
  • Loading branch information
Mathieu Martin committed Oct 2, 2020
1 parent 2b45c5e commit 0796cc3
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 16 deletions.
11 changes: 9 additions & 2 deletions code/go/ecs/network.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions docs/field-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3342,9 +3342,11 @@ Recommended values are:



When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values ingress or egress.
When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress".

When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of your network perimeter, using the values inbound, outbound, internal or external.
When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of your network perimeter, using the values "inbound", "outbound", "internal" or "external".

Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to their perimeter. This could for example be useful for ISPs or VPN service providers.

type: keyword

Expand Down
11 changes: 8 additions & 3 deletions generated/beats/fields.ecs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2596,10 +2596,15 @@
description: "Direction of the network traffic.\nRecommended values are:\n \
\ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\
\ * unknown\n\nWhen mapping events from a host-based monitoring context,\
\ populate this field from the host's point of view, using the values ingress\
\ or egress.\nWhen mapping events from a network or perimeter-based monitoring\
\ populate this field from the host's point of view, using the values \"ingress\"\
\ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\
\ context, populate this field from the point of view of your network perimeter,\
\ using the values inbound, outbound, internal or external."
\ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\
.\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\
\ to describe communication between two hosts within the perimeter. Note also\
\ that \"external\" is meant to describe traffic between two hosts that are\
\ external to their perimeter. This could for example be useful for ISPs or\
\ VPN service providers."
example: inbound
- name: forwarded_ip
level: core
Expand Down
12 changes: 8 additions & 4 deletions generated/ecs/ecs_flat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3986,10 +3986,14 @@ network.direction:
description: "Direction of the network traffic.\nRecommended values are:\n * ingress\n\
\ * egress\n * inbound\n * outbound\n * internal\n * external\n * unknown\n\
\nWhen mapping events from a host-based monitoring context, populate this field\
\ from the host's point of view, using the values ingress or egress.\nWhen mapping\
\ events from a network or perimeter-based monitoring context, populate this field\
\ from the point of view of your network perimeter, using the values inbound,\
\ outbound, internal or external."
\ from the host's point of view, using the values \"ingress\" or \"egress\".\n\
When mapping events from a network or perimeter-based monitoring context, populate\
\ this field from the point of view of your network perimeter, using the values\
\ \"inbound\", \"outbound\", \"internal\" or \"external\".\nNote that \"internal\"\
\ is not crossing perimeter boundaries, and is meant to describe communication\
\ between two hosts within the perimeter. Note also that \"external\" is meant\
\ to describe traffic between two hosts that are external to their perimeter.\
\ This could for example be useful for ISPs or VPN service providers."
example: inbound
flat_name: network.direction
ignore_above: 1024
Expand Down
11 changes: 8 additions & 3 deletions generated/ecs/ecs_nested.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4734,10 +4734,15 @@ network:
description: "Direction of the network traffic.\nRecommended values are:\n \
\ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\
\ * unknown\n\nWhen mapping events from a host-based monitoring context,\
\ populate this field from the host's point of view, using the values ingress\
\ or egress.\nWhen mapping events from a network or perimeter-based monitoring\
\ populate this field from the host's point of view, using the values \"ingress\"\
\ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\
\ context, populate this field from the point of view of your network perimeter,\
\ using the values inbound, outbound, internal or external."
\ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\
.\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\
\ to describe communication between two hosts within the perimeter. Note also\
\ that \"external\" is meant to describe traffic between two hosts that are\
\ external to their perimeter. This could for example be useful for ISPs or\
\ VPN service providers."
example: inbound
flat_name: network.direction
ignore_above: 1024
Expand Down
10 changes: 8 additions & 2 deletions schemas/network.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,17 @@
* unknown
When mapping events from a host-based monitoring context, populate this
field from the host's point of view, using the values ingress or egress.
field from the host's point of view, using the values "ingress" or "egress".
When mapping events from a network or perimeter-based monitoring context,
populate this field from the point of view of your network perimeter,
using the values inbound, outbound, internal or external.
using the values "inbound", "outbound", "internal" or "external".
Note that "internal" is not crossing perimeter boundaries, and is meant
to describe communication between two hosts within the perimeter. Note also
that "external" is meant to describe traffic between two hosts that are
external to their perimeter. This could for example be useful for ISPs or
VPN service providers.
example: inbound

- name: forwarded_ip
Expand Down

0 comments on commit 0796cc3

Please sign in to comment.