Uploaded image for project: 'Network Observability'
  1. Network Observability
  2. NETOBSERV-2617

NETOBSERV-CLI: The oc-netobserv command failed when --help flag is not the first flag

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • netobserv-1.11
    • eBPF
    • None
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • Low
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

       

      Steps to Reproduce:

      ./oc-netobserv flows --interfaces=br-ex --max-time=10s --log-level=debug --background --help                    

      Actual results:

      using custom namespace netobserv-cli-1 
      using custom namespace netobserv-cli-1 
      using custom collector image quay.io/netobserv/network-observability-cli:53424a8 
      Setting up... 
      yq tools must be installed for proper usage of netobserv cli 
      Copy skipped 
      
      Cleaning up... 
      Deleting service monitor... 
      Deleting dashboard configmap... 
      Deleting daemonset... 
      Deleting pod... 
      Deleting namespace... 

      Expected results:

      using custom agent image quay.io/redhat-user-workloads/ocp-network-observab-tenant/netobserv-ebpf-agent-ystream@sha256:ba23e4670d84bff984beda4d82d6ecd439c74bfa213c8ba1fe4e52efd9605073
      using custom collector image quay.io/redhat-user-workloads/ocp-network-observab-tenant/network-observability-cli-ystream@sha256:34bfbbf0466b3e6a5ab68045c364d196c4cd55e8b9d84f918185dc01529388f3
      
      
      Netobserv allows you to capture flows, packets and metrics from your cluster.
      Find more information at: https://github.com/netobserv/network-observability-cli/
      
      
      Syntax: netobserv [flows|packets|metrics|follow|stop|copy|cleanup|version] [options]
      
      
      main commands:
        flows      Capture flows information in JSON format using collector pod.
        metrics    Capture metrics information in Prometheus using a ServiceMonitor (OCP cluster only).
        packets    Capture packets information in pcap format using collector pod.
      
      
      extra commands:
        cleanup    Remove netobserv components and configurations.
        copy       Copy collector generated files locally.
        follow     Follow collector logs when running in background.
        stop       Stop collection by removing agent daemonset.
        version    Print software version.
      
      
      basic examples:
        netobserv flows --drops                                     # Capture dropped flows on all nodes
        netobserv flows --query='SrcK8S_Namespace=~"app-.*"'        # Capture flows from any namespace starting by app-
        netobserv packets --port=8080                               # Capture packets on port 8080
        netobserv metrics --enable_all                              # Capture default cluster metrics including packet drop, dns, rtt, network events packet translation and UDN mapping features informations
      
      
      advanced examples:
        Capture flows in background and copy output locally
          netobserv flows --background \                            # Capture flows using background mode
          --max-time=15m \                                          # for a maximum of 15 minutes
          --protocol=TCP --port=8080 \                              # either on TCP 8080
          or --protocol=UDP                                         # or UDP
          netobserv follow                                          # Display the progression of the background capture
          netobserv stop                                            # Stop the background capture by deleting eBPF agents
          netobserv copy                                            # Copy the background capture output data
          netobserv cleanup                                         # Cleanup netobserv CLI by removing the remaining collector pod
      
      
        Capture flows from a specific pod
          netobserv flows                                           # Capture flows
          --node-selector=kubernetes.io/hostname:my-node            # on node matching label 'kubernetes.io/hostname=my-node'
          --query='SrcK8S_Name=~".*my-pod.*"                        # from any pod name containing 'my-pod'
                   or DstK8S_Name=~".*my-pod.*"'                    # or to any pod name containing 'my-pod'
      
      
        Capture packets on specific nodes and port
          netobserv packets                                         # Capture packets
          --node-selector=netobserv:true \                          # on nodes labelled with 'netobserv=true'
          --port=80 \                                               # on port 80 only
          --max-bytes=100000000                                     # for a maximum of 100MB
      
      
        Capture node and namespace drop metrics
          netobserv metrics \                                       # Capture metrics
          --drops                                                   # including drops
          --include_list=node,namespace                             # for all metrics matching 'node' or 'namespace' keywords
      
      
        Capture metrics in background
          netobserv metrics --background \                          # Capture metrics using background mode
          --max-time=24h                                            # for a maximum of 24 hours
        Then open the URL provided by the command to visualize the netobserv-cli dashboard anytime during or after the run.
      
      

              Unassigned Unassigned
              rh-ee-kapjain Kapil Jain
              None
              None
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: