This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

  • 1:
    • 2:
      • 3:

        Configure Agent Modes

        Agent modes provide the ability to control metric collection to fit your scale and specific requirement. You can choose one of the following modes to do so:

        • Monitor

        • Monitor Light

        • Troubleshooting

        • Secure

        • Custom Metrics Only

        Using a stripped-down mode limits collection of unneeded metrics, which in turn prevents the consumption of excess resources and helps reduce expenses.

        Monitor

        The Monitor mode offers an extensive collection of metrics. We recommend this mode to monitor enterprise environments.

        monitor is the default mode if you are running the Enterprise tier. To switch back to the Monitor mode from a different mode, do one of the following:

        • Add the following to the dragent.yaml file and restart the agent:

          feature:
            mode: monitor
          
        • Remove the parameter related to the existing mode from the dragent.yaml file and restart the agent. For example, to switch from troubleshooting mode to monitor, delete the following lines:

          feature:
            mode: troubleshooting
          

        Monitor Light

        Monitor Light caters to the users that run agents in a resource-restrictive environment, or to those who are interested only in a limited set of metrics.

        Monitor Light provides CPU, Memory, File, File system, and Network metrics. For more information, see Metrics Available in Monitor Light.

        Enable Monitor Light Mode

        To switch to the Monitor Light mode, edit the dragent.yaml file:

        1. Open the dragent.yaml file.

        2. Add the following configuration parameter:

          feature:
            mode: monitor_light
          
        3. Restart the agent.

        Troubleshooting

        Troubleshooting mode offers sophisticated metrics with detailed diagnostic capabilities. Some of these metrics are heuristic in nature.

        In addition to the extensive metrics available in the Monitor mode, Troubleshooting mode provides additional metrics such as net.sql and additional segmentation for file and network metrics. For more information, see Additional Metrics Values Available in Troubleshooting.

        Enable Troubleshooting Mode

        To switch to the Troubleshooting mode, edit the dragent.yaml file:

        1. Open the dragent.yaml file.

        2. Add the following configuration parameter:

          feature:
            mode: troubleshooting
          
        3. Restart the agent.

        Secure Mode

        The secure mode supports only Sysdig Secure features.

        Sysdig agent collects no metrics in the secure mode, which, in turn, minimizes network consumption and storage requirement in the Sysdig backend. Lower resource usage can help reduce costs and improve performance.

        In the Secure mode, the Monitor UI shows no data because no metrics are sent to the collector.

        This feature requires agent v10.5.0 or above.

        Enabling Secure Mode

        1. Open the dragent.yaml file.

        2. Add the following:

          feature:
            mode: secure
          
        3. Restart the agent.

        Custom Metrics Only Mode

        Custom Metrics Only mode collects the same metrics as the Monitor Light mode, but also adds the ability to collect the following:

        • Custom Metrics: StatsD, JMX, App Checks, and Prometheus
        • Kubernetes State Metrics

        As such, Custom Metrics Only mode is suitable if would like to use most of the features of Monitor mode but are limited in resources.

        This mode is not compatible with Secure. If your account is configured for Secure, you must explicitly disable Secure in the agent configuration if you wish to use this mode.

        This mode requires agent v12.4.0 or above.

        Enabling Custom Metrics Only Mode

        1. Open the dragent.yaml file.

        2. Add the following configuration parameter:

          feature:
            mode: custom-metrics-only
          
        3. If your account is enabled for Secure, add the following:

          security:
            enabled: false
          secure_audit_streams:
            enabled: false
          falcobaseline:
            enabled: false
          

          This configuration explicitly disables the Secure features in the agent. If you do not disable Secure, the agent will not start due to incompatiblity issues.

        4. Restart the agent.

        1 -

        Metrics Available in Monitor Light

        Monitor Light provides cpu, memory, file, file system, and network metrics.

        MetricsDescription
        cpu.cores.usedSee System.System
        cpu.cores.used.percent
        cpu.idle.percent
        cpu.iowait.percent
        cpu.nice.percent
        cpu.stolen.percent
        cpu.system.percent
        cpu.used.percent
        cpu.user.percent
        load.average.percpu.1m
        load.average.percpu.5m
        load.average.percpu.15m
        memory.bytes.available
        memory.bytes.total
        memory.bytes.used
        memory.bytes.used
        memory.bytes.virtual
        memory.pageFault.major
        memory.pageFault.minor
        memory.swap.bytes.available
        memory.swap.bytes.total
        memory.swap.bytes.used
        memory.swap.used.percent
        memory.used.percent
        file.bytes.in
        file.bytes.out
        file.bytes.total
        file.iops.in
        file.iops.out
        file.iops.total
        file.open.count
        file.time.in
        file.time.out
        file.time.total
        fs.bytes.free
        fs.bytes.total
        fs.bytes.used
        fs.free.percent
        fs.inodes.total.count
        fs.inodes.used.count
        fs.inodes.used.percent
        fs.largest.used.percent
        fs.root.used.percent
        fs.used.percent
        net.bytes.in
        net.bytes.out
        net.bytes.total
        proc.count
        thread.count
        container.count
        system.uptime
        uptime

        2 -

        Additional Metrics Values Available in Troubleshooting

        In addition to the extensive set of metrics available in the monitor mode, additional metrics, such as net.sql and net.mongodb, as well as additional segmentations for file and network metrics are available.

        MetricsAdditional Metrics Values Available When Segmented bySupported Agent Versions
        file.error.total.countfile.name and file.mount labelsVersion 10.1.0 or above
        file.bytes.total
        file.bytes.in
        file.bytes.out
        file.open.count
        file.time.total
        host.count
        host.error.count
        proc.count
        proc.start.count
        net.mongodb.collectionallVersion 10.2.0 or above
        net.mongodb.error.count
        net.mongodb.operation
        net.mongodb.request.count
        net.mongodb.request.time
        net.sql.queryall
        net.sql.error.count
        net.sql.query.type
        net.sql.request.count
        net.sql.request.time
        net.sql.table
        net.http.error.countnet.http.urlVersion 10.3.0 or above
        net.http.method
        net.http.request.count
        net.http.request.time
        net.bytes.in
        net.bytes.out
        net.request.time.worst.out
        net.request.count
        net.request.time
        net.bytes.total
        net.http.request.time.worstall

        3 -

        Metrics Not Available in Essentials Mode

        The following metrics will not be reported in the essentials mode when compared with monitor mode:

        MetricsSegmented By
        net.bytes.innet.connection.server, net.connection.direction, net.connection.l4proto , and net.connection.client labels
        net.bytes.out
        net.connection.count.total
        net.connection.count.in
        net.connection.count.out
        net.request.count
        net.request.count.in
        net.request.count.out
        net.request.time
        net.request.time.in
        net.request.time.out
        net.bytes.total
        net.mongodb.collectionall
        net.mongodb.error.count
        net.mongodb.operation
        net.mongodb.request.count
        net.mongodb.request.time
        net.sql.queryall
        net.sql.error.count
        net.sql.query.type
        net.sql.request.count
        net.sql.request.time
        net.sql.table
        net.sql.queryall
        net.sql.error.count
        net.sql.query.type
        net.sql.request.count
        net.sql.request.time
        net.sql.table
        net.http.method
        net.http.request.count
        net.http.request.time
        net.http.statusCode
        net.http.url