Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

packetbeat/protos/tcp: add metrics for TCP header flags #36975

Merged
merged 1 commit into from
Nov 11, 2023
Merged

packetbeat/protos/tcp: add metrics for TCP header flags #36975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ Setting environmental variable ELASTIC_NETINFO:false in Elastic Agent pod will d

*Packetbeat*

- Add metrics for TCP flags. {issue}36992[36992] {pull}36975[36975]

*Packetbeat*

Expand Down
10 changes: 10 additions & 0 deletions packetbeat/docs/protocol-metrics-packetbeat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ observe the activity of Packetbeat for the monitored protocol.
| `tcp.dropped_because_of_gaps` | Number of packets dropped because of gaps.
| `arrival_period` | Histogram of the elapsed time between packet arrivals.
| `processing_time` | Histogram of the elapsed time between packet receipt and publication.
| `fin_flags_total` | Number of TCP FIN (finish) flags observed.
| `syn_flags_total` | Number of TCP SYN (synchronization) flags observed.
| `rst_flags_total` | Number of TCP RST (reset) flags observed.
| `psh_flags_total` | Number of TCP PSH (push) flags observed.
| `ack_flags_total` | Number of TCP ACK (acknowledgement) flags observed.
| `urg_flags_total` | Number of TCP URG (urgent) flags observed.
| `ece_flags_total` | Number of TCP ECE (ECN echo) flags observed.
| `cwr_flags_total` | Number of TCP CWR (congestion window reduced) flags observed.
| `ns_flags_total` | Number of TCP NS (nonce sum) flags observed.
| `received_headers_total` | Number of headers observed, including unprocessed packets.
|=======


Expand Down
52 changes: 52 additions & 0 deletions packetbeat/protos/tcp/tcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ func (tcp *TCP) removalListener(_ common.Key, value common.Value) {
func (tcp *TCP) Process(id *flows.FlowID, tcphdr *layers.TCP, pkt *protos.Packet) {
tcp.expiredConns.notifyAll()

tcp.metrics.logFlags(tcphdr)

stream, created := tcp.getStream(pkt)
if stream.conn == nil {
return
Expand Down Expand Up @@ -392,6 +394,11 @@ type inputMetrics struct {

lastPacket time.Time

// TCP flag counts.
fin, syn, rst, psh, ack, urg, ece, cwr, ns *monitoring.Uint
// Total number of headers, including zero length packets.
headers *monitoring.Uint

device *monitoring.String // name of the device being monitored
packets *monitoring.Uint // number of packets processed
bytes *monitoring.Uint // number of bytes processed
Expand All @@ -418,6 +425,16 @@ func newInputMetrics(id, device string, ports map[uint16]protos.Protocol) *input
packets: monitoring.NewUint(reg, "received_events_total"),
bytes: monitoring.NewUint(reg, "received_bytes_total"),
overlapped: monitoring.NewUint(reg, "tcp_overlaps"),
fin: monitoring.NewUint(reg, "fin_flags_total"),
syn: monitoring.NewUint(reg, "syn_flags_total"),
rst: monitoring.NewUint(reg, "rst_flags_total"),
psh: monitoring.NewUint(reg, "psh_flags_total"),
ack: monitoring.NewUint(reg, "ack_flags_total"),
urg: monitoring.NewUint(reg, "urg_flags_total"),
ece: monitoring.NewUint(reg, "ece_flags_total"),
cwr: monitoring.NewUint(reg, "cwr_flags_total"),
ns: monitoring.NewUint(reg, "ns_flags_total"),
headers: monitoring.NewUint(reg, "received_headers_total"),
dropped: monitoring.NewInt(reg, "tcp.dropped_because_of_gaps"), // Name and type retained for compatibility.
arrivalPeriod: metrics.NewUniformSample(1024),
processingTime: metrics.NewUniformSample(1024),
Expand Down Expand Up @@ -450,6 +467,41 @@ func portList(m map[uint16]protos.Protocol) string {
return strings.Join(s, "-")
}

// logFlags logs flag metric for the given packet header.
func (m *inputMetrics) logFlags(hdr *layers.TCP) {
if m == nil {
return
}
m.headers.Add(1)
if hdr.FIN {
m.fin.Add(1)
}
if hdr.SYN {
m.syn.Add(1)
}
if hdr.RST {
m.rst.Add(1)
}
if hdr.PSH {
m.psh.Add(1)
}
if hdr.ACK {
m.ack.Add(1)
}
if hdr.URG {
m.urg.Add(1)
}
if hdr.ECE {
m.ece.Add(1)
}
if hdr.CWR {
m.cwr.Add(1)
}
if hdr.NS {
m.ns.Add(1)
}
}

// log logs metric for the given packet.
func (m *inputMetrics) log(pkt *protos.Packet) {
if m == nil {
Expand Down