Skip to content

Commit

Permalink
Update json doc (#325)
Browse files Browse the repository at this point in the history
* Update json doc

* remove cross-ref link
  • Loading branch information
jotak authored Apr 11, 2023
1 parent e143bf6 commit 36de463
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 2 deletions.
75 changes: 74 additions & 1 deletion docs/flows-format.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,19 @@ Destination owner, such as Deployment, StatefulSet, etc.

FlowDirection::

• *FlowDirection*: <<Enumeration: FlowDirection,`FlowDirection`>>
• *FlowDirection*: `FlowDirection` (see the following section, Enumeration: FlowDirection)

Flow direction from the node observation point

'''

_RecordType::

• `Optional` *_RecordType*: `RecordType`

Type of record: 'flowLog' for regular flow logs, or 'allConnections',
'newConnection', 'heartbeat', 'endConnection' for conversation tracking


== Fields

Expand Down Expand Up @@ -191,6 +200,14 @@ L4 protocol

'''

Interface::

• `Optional` *Interface*: `string`

Network interface

'''

Packets::

• *Packets*: `number`
Expand All @@ -199,6 +216,22 @@ Number of packets in this flow

'''

Packets_AB::

• `Optional` *Packets_AB*: `number`

In conversation tracking, A to B packets counter per conversation

'''

Packets_BA::

• `Optional` *Packets_BA*: `number`

In conversation tracking, B to A packets counter per conversation

'''

Bytes::

• *Bytes*: `number`
Expand All @@ -207,6 +240,22 @@ Number of bytes in this flow

'''

Bytes_AB::

• `Optional` *Bytes_AB*: `number`

In conversation tracking, A to B bytes counter per conversation

'''

Bytes_BA::

• `Optional` *Bytes_BA*: `number`

In conversation tracking, B to A bytes counter per conversation

'''

TimeFlowStartMs::

• *TimeFlowStartMs*: `number`
Expand All @@ -229,6 +278,30 @@ TimeReceived::

Timestamp when this flow was received and processed by the flow collector, in seconds

'''

_HashId::

• `Optional` *_HashId*: `string`

In conversation tracking, the conversation identifier

'''

_IsFirst::

• `Optional` *_IsFirst*: `string`

In conversation tracking, a flag identifying the first flow

'''

numFlowLogs::

• `Optional` *numFlowLogs*: `number`

In conversation tracking, a counter of flow logs per conversation


== Enumeration: FlowDirection

Expand Down
2 changes: 1 addition & 1 deletion hack/asciidoc-flows-gen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ kramdoc -o - <(curl -fsSL ${MD_SOURCE}/interfaces/Labels.md) \
| sed -r 's/^= /== /' \
| sed -r 's/Interface: //' \
| sed -r '/Properties/d' \
| sed -r 's~xref:.*FlowDirection\.adoc\[`FlowDirection`\]~<<Enumeration: FlowDirection,`FlowDirection`>>~' >> $ADOC
| sed -r 's~xref:.*FlowDirection\.adoc\[`FlowDirection`\]~`FlowDirection` (see the following section, Enumeration: FlowDirection)~' >> $ADOC

# Fields
echo -e "\n" >> $ADOC
Expand Down

0 comments on commit 36de463

Please sign in to comment.