Skip to content

Commit

Permalink
Add the address field to client and server as well.
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathieu Martin committed Dec 7, 2018
1 parent 9b2c7a0 commit 7f65b2f
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,12 @@ Examples: In the case of Beats for logs, the agent.name is filebeat. For APM, it

## <a name="client"></a> Client fields

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 conjuction with server fields. Client fields are generally not populated for packet-level events.
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 conjuction with server fields. Client fields are generally not populated for packet-level events.


| Field | Description | Level | Type | Example |
|---|---|---|---|---|
| <a name="client.address"></a>client.address | Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.<br/>Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. | extended | keyword | |
| <a name="client.ip"></a>client.ip | IP address of the client.<br/>Can be one or multiple IPv4 or IPv6 addresses. | core | ip | |
| <a name="client.port"></a>client.port | Port of the client. | core | long | |
| <a name="client.mac"></a>client.mac | MAC address of the client. | core | keyword | |
Expand Down Expand Up @@ -415,6 +416,7 @@ A Server is defined as the responder in a network connection for events regardin

| Field | Description | Level | Type | Example |
|---|---|---|---|---|
| <a name="server.address"></a>server.address | Some event server addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field.<br/>Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. | extended | keyword | |
| <a name="server.ip"></a>server.ip | IP address of the server.<br/>Can be one or multiple IPv4 or IPv6 addresses. | core | ip | |
| <a name="server.port"></a>server.port | Port of the server. | core | long | |
| <a name="server.mac"></a>server.mac | MAC address of the server. | core | keyword | |
Expand Down
26 changes: 24 additions & 2 deletions fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,21 @@
title: Client
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 conjuction with server fields. Client fields are generally not populated for packet-level events.
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 conjuction with server fields. Client fields are generally not populated for packet-level events.
type: group
fields:

- name: address
level: extended
type: keyword
description: >
Some event client addresses are defined ambiguously. The event will
sometimes list an IP, a domain or a unix socket. You should always
store the raw address in the `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which
one it is.

- name: ip
level: core
type: ip
Expand Down Expand Up @@ -1258,7 +1269,7 @@
level: extended
type: keyword
description: >
Some event source addresses are defined ambiguously. The event will
Some event server addresses are defined ambiguously. The event will
sometimes list an IP, a domain or a unix socket. You should always
store the raw address in the `.address` field.
Expand Down Expand Up @@ -1395,6 +1406,17 @@
type: group
fields:

- name: address
level: extended
type: keyword
description: >
Some event source addresses are defined ambiguously. The event will
sometimes list an IP, a domain or a unix socket. You should always
store the raw address in the `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which
one it is.

- name: ip
level: core
type: ip
Expand Down
2 changes: 2 additions & 0 deletions schema.csv
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ agent.id,keyword,core,8a4f500d
agent.name,keyword,core,foo
agent.type,keyword,core,filebeat
agent.version,keyword,core,6.0.0-rc2
client.address,keyword,extended,
client.bytes,long,core,184
client.domain,keyword,core,
client.ip,ip,core,
Expand Down Expand Up @@ -129,6 +130,7 @@ process.thread.id,long,extended,4242
process.title,keyword,extended,
process.working_directory,keyword,extended,/home/alice
related.ip,ip,extended,
server.address,keyword,extended,
server.bytes,long,core,184
server.domain,keyword,core,
server.ip,ip,core,
Expand Down
13 changes: 12 additions & 1 deletion schemas/client.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,21 @@
title: Client
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 conjuction with server fields. Client fields are generally not populated for packet-level events.
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 conjuction with server fields. Client fields are generally not populated for packet-level events.
type: group
fields:

- name: address
level: extended
type: keyword
description: >
Some event client addresses are defined ambiguously. The event will
sometimes list an IP, a domain or a unix socket. You should always
store the raw address in the `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which
one it is.
- name: ip
level: core
type: ip
Expand Down
11 changes: 11 additions & 0 deletions schemas/server.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@
type: group
fields:

- name: address
level: extended
type: keyword
description: >
Some event server addresses are defined ambiguously. The event will
sometimes list an IP, a domain or a unix socket. You should always
store the raw address in the `.address` field.
Then it should be duplicated to `.ip` or `.domain`, depending on which
one it is.
- name: ip
level: core
type: ip
Expand Down
8 changes: 8 additions & 0 deletions template.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@
},
"client": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
},
"bytes": {
"type": "long"
},
Expand Down Expand Up @@ -617,6 +621,10 @@
},
"server": {
"properties": {
"address": {
"ignore_above": 1024,
"type": "keyword"
},
"bytes": {
"type": "long"
},
Expand Down

0 comments on commit 7f65b2f

Please sign in to comment.