Skip to content

Commit

Permalink
Require that source/destination are always populated (elastic#265)
Browse files Browse the repository at this point in the history
  • Loading branch information
webmat committed Dec 11, 2018
1 parent 5d62e2e commit 0716853
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ All notable changes to this project will be documented in this file based on the
* Clarify that `network.transport`, `network.type`, `network.application`,
and `network.protocol` must be lowercase. #251
* Clarify that `http.request.method` must be lowercase. #251
* Clarify that source/destination should be filled, even if client/server is
being used. #265

### Deprecated

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ Examples: In the case of Beats for logs, the agent.name is filebeat. For APM, it

A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term "originator" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.

Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.


| Field | Description | Level | Type | Example |
|---|---|---|---|---|
Expand Down Expand Up @@ -418,6 +420,8 @@ This field set is meant to facilitate pivoting around a piece of data. Some piec

A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term "responder" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.

Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.


| Field | Description | Level | Type | Example |
|---|---|---|---|---|
Expand Down
12 changes: 8 additions & 4 deletions fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,8 @@
group: 2
description: >
A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term "originator" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.
type: group
fields:

Expand Down Expand Up @@ -298,8 +300,8 @@
title: Destination
group: 2
description: >
Destination fields describe details about the destination of a
packet/event. Destination fields are usually populated in conjunction with source fields.
Destination fields describe details about the destination of a packet/event.
Destination fields are usually populated in conjunction with source fields.
type: group
fields:

Expand Down Expand Up @@ -1314,6 +1316,8 @@
group: 2
description: >
A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term "responder" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.
type: group
fields:

Expand Down Expand Up @@ -1453,8 +1457,8 @@
title: Source
group: 2
description: >
Source fields describe details about the source of a
packet/event. Source fields are usually populated in conjunction with destination fields.
Source fields describe details about the source of a packet/event.
Source fields are usually populated in conjunction with destination fields.
type: group
fields:

Expand Down
2 changes: 2 additions & 0 deletions schemas/client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
group: 2
description: >
A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term "originator" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjunction with server fields. Client fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.
type: group
fields:

Expand Down
4 changes: 2 additions & 2 deletions schemas/destination.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
title: Destination
group: 2
description: >
Destination fields describe details about the destination of a
packet/event. Destination fields are usually populated in conjunction with source fields.
Destination fields describe details about the destination of a packet/event.
Destination fields are usually populated in conjunction with source fields.
type: group
fields:

Expand Down
2 changes: 2 additions & 0 deletions schemas/server.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
group: 2
description: >
A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term "responder" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.
Client / server representations can add semantic context to an exchange, which is helpful to visualize the data in certain situations. If your context falls in that category, you should still ensure that source and destination are filled appropriately.
type: group
fields:

Expand Down
4 changes: 2 additions & 2 deletions schemas/source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
title: Source
group: 2
description: >
Source fields describe details about the source of a
packet/event. Source fields are usually populated in conjunction with destination fields.
Source fields describe details about the source of a packet/event.
Source fields are usually populated in conjunction with destination fields.
type: group
fields:

Expand Down

0 comments on commit 0716853

Please sign in to comment.