Skip to content

Commit b288448

Browse files
committed
Add IPFIX export doc
1 parent 09be912 commit b288448

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/api.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,16 @@ Following is the supported API format for writing to standard output:
331331
stdout:
332332
format: the format of each line: printf (default - writes using golang's default map printing), fields (writes one key and value field per line) or json
333333
</pre>
334+
## Write IPFIX
335+
Following is the supported API format for writing to an IPFIX collector:
336+
337+
<pre>
338+
ipfix:
339+
targetHost: IPFIX Collector host target IP
340+
targetPort: IPFIX Collector host target port
341+
transport: Transport protocol (tcp/udp) to be used for the IPFIX connection
342+
enterpriseId: Enterprise ID for exporting transformations
343+
</pre>
334344
## Aggregate metrics API
335345
Following is the supported API format for specifying metrics aggregations:
336346

pkg/api/api.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ type API struct {
6262
TransformNetwork TransformNetwork `yaml:"network" doc:"## Transform Network API\nFollowing is the supported API format for network transformations:\n"`
6363
WriteLoki WriteLoki `yaml:"loki" doc:"## Write Loki API\nFollowing is the supported API format for writing to loki:\n"`
6464
WriteStdout WriteStdout `yaml:"stdout" doc:"## Write Standard Output\nFollowing is the supported API format for writing to standard output:\n"`
65+
WriteIPFIX WriteIpfix `yaml:"ipfix" doc:"## Write IPFIX\nFollowing is the supported API format for writing to an IPFIX collector:\n"`
6566
ExtractAggregate Aggregates `yaml:"aggregates" doc:"## Aggregate metrics API\nFollowing is the supported API format for specifying metrics aggregations:\n"`
6667
ConnectionTracking ConnTrack `yaml:"conntrack" doc:"## Connection tracking API\nFollowing is the supported API format for specifying connection tracking:\n"`
6768
ExtractTimebased ExtractTimebased `yaml:"timebased" doc:"## Time-based Filters API\nFollowing is the supported API format for specifying metrics time-based filters:\n"`

0 commit comments

Comments
 (0)