github.com/inspektor-gadget/inspektor-gadget@v0.28.1/docs/crds/gadgets/socket-collector.md (about)

     1  ---
     2  # Code generated by 'make generate-documentation'. DO NOT EDIT.
     3  title: Gadget socket-collector
     4  ---
     5  
     6  The socket-collector gadget gathers information about TCP and UDP sockets.
     7  
     8  ### Example CR
     9  
    10  ```yaml
    11  apiVersion: gadget.kinvolk.io/v1alpha1
    12  kind: Trace
    13  metadata:
    14    name: socket-collector
    15    namespace: gadget
    16  spec:
    17    node: my-node
    18    gadget: socket-collector
    19    filter:
    20      namespace: default
    21      podname: mypod
    22    runMode: Manual
    23    outputMode: Status
    24    parameters:
    25      proto: all # all, udp and tcp are allowed
    26  ```
    27  
    28  ### Operations
    29  
    30  
    31  #### collect
    32  
    33  Create a snapshot of the currently open TCP and UDP sockets. Once taken, the snapshot is not updated automatically. However one can call the collect operation again at any time to update the snapshot.
    34  
    35  ```bash
    36  $ kubectl annotate -n gadget trace/socket-collector \
    37      gadget.kinvolk.io/operation=collect
    38  ```
    39  
    40  ### Output Modes
    41  
    42  * Status