app.stats
=========

Retrieve statistics of apps.

This event is generated by a dynamic source. If you want to specify subscription params, subscribe to it using the name in the following format `app.stats:{"param": "value"}`

.. raw:: html

    <div id="json-schema"> <span class="badge badge-dark value-type">Type: object</span><br/> <div class="accordion" id="accordionSubscription_parameters"> <div class="card"> <div class="card-header" id="headingSubscription_parameters"> <h2 class="mb-0"> <button aria-controls="Subscription_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Subscription_parameters" data-toggle="collapse" onclick="setAnchor('#Subscription_parameters')" type="button"><span class="property-name">Subscription parameters</span></button> </h2> </div> <div aria-labelledby="headingSubscription_parameters" class="collapse property-definition-div" data-parent="#accordionSubscription_parameters" id="Subscription_parameters"> <div class="card-body pl-5"> <h4>AppStatsEventSourceArgs</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionSubscription_parameters_interval"> <div class="card"> <div class="card-header" id="headingSubscription_parameters_interval"> <h2 class="mb-0"> <button aria-controls="Subscription_parameters_interval" aria-expanded="" class="btn btn-link property-name-button" data-target="#Subscription_parameters_interval" data-toggle="collapse" onclick="setAnchor('#Subscription_parameters_interval')" type="button"><span class="property-name">interval</span></button> </h2> </div> <div aria-labelledby="headingSubscription_parameters_interval" class="collapse property-definition-div" data-parent="#accordionSubscription_parameters_interval" id="Subscription_parameters_interval"> <div class="card-body pl-5"> <h4>Interval</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 2</span><br/> <p><span class="badge badge-light restriction numeric-restriction" id="Subscription_parameters_interval_number">Value must be greater or equal to <code>2</code></span></p> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionADDED"> <div class="card"> <div class="card-header" id="headingADDED"> <h2 class="mb-0"> <button aria-controls="ADDED" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED" data-toggle="collapse" onclick="setAnchor('#ADDED')" type="button"><span class="property-name">ADDED</span></button> </h2> </div> <div aria-labelledby="headingADDED" class="collapse property-definition-div" data-parent="#accordionADDED" id="ADDED"> <div class="card-body pl-5"> <h4>AppStatsEventSourceEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_fields"> <div class="card"> <div class="card-header" id="headingADDED_fields"> <h2 class="mb-0"> <button aria-controls="ADDED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields" data-toggle="collapse" onclick="setAnchor('#ADDED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields" class="collapse property-definition-div" data-parent="#accordionADDED_fields" id="ADDED_fields"> <div class="card-body pl-5"> <h4>Fields</h4><span class="badge badge-dark value-type">Type: array of object</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="ADDED_fields_items"> <h4>AppStatsEventSourceEventItem</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_fields_items_app_name"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_app_name"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_app_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_app_name" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_app_name')" type="button"><span class="property-name">app_name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_app_name" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_app_name" id="ADDED_fields_items_app_name"> <div class="card-body pl-5"> <h4>App Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_cpu_usage"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_cpu_usage"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_cpu_usage" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_cpu_usage" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_cpu_usage')" type="button"><span class="property-name">cpu_usage</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_cpu_usage" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_cpu_usage" id="ADDED_fields_items_cpu_usage"> <div class="card-body pl-5"> <h4>Cpu Usage</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Percentage of cpu used by an app.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_memory"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_memory"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_memory" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_memory" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_memory')" type="button"><span class="property-name">memory</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_memory" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_memory" id="ADDED_fields_items_memory"> <div class="card-body pl-5"> <h4>Memory</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Current memory (in bytes) used by an app.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_networks"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_networks"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_networks" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_networks" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_networks')" type="button"><span class="property-name">networks</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_networks" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_networks" id="ADDED_fields_items_networks"> <div class="card-body pl-5"> <h4>Networks</h4><span class="badge badge-dark value-type">Type: array of object</span><br/> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="ADDED_fields_items_networks_items"> <h4>AppStatsEventSourceEventItemNetwork</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_fields_items_networks_items_interface_name"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_networks_items_interface_name"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_networks_items_interface_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_networks_items_interface_name" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_networks_items_interface_name')" type="button"><span class="property-name">interface_name</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_networks_items_interface_name" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_networks_items_interface_name" id="ADDED_fields_items_networks_items_interface_name"> <div class="card-body pl-5"> <h4>Interface Name</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>Name of the interface used by the app.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_networks_items_rx_bytes"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_networks_items_rx_bytes"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_networks_items_rx_bytes" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_networks_items_rx_bytes" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_networks_items_rx_bytes')" type="button"><span class="property-name">rx_bytes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_networks_items_rx_bytes" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_networks_items_rx_bytes" id="ADDED_fields_items_networks_items_rx_bytes"> <div class="card-body pl-5"> <h4>Rx Bytes</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Received bytes/s by an interface.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_networks_items_tx_bytes"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_networks_items_tx_bytes"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_networks_items_tx_bytes" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_networks_items_tx_bytes" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_networks_items_tx_bytes')" type="button"><span class="property-name">tx_bytes</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_networks_items_tx_bytes" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_networks_items_tx_bytes" id="ADDED_fields_items_networks_items_tx_bytes"> <div class="card-body pl-5"> <h4>Tx Bytes</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Transmitted bytes/s by an interface.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_blkio"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_blkio"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_blkio" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_blkio" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_blkio')" type="button"><span class="property-name">blkio</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_blkio" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_blkio" id="ADDED_fields_items_blkio"> <div class="card-body pl-5"> <h4>AppStatsEventSourceEventItemBlkio</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionADDED_fields_items_blkio_read"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_blkio_read"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_blkio_read" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_blkio_read" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_blkio_read')" type="button"><span class="property-name">read</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_blkio_read" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_blkio_read" id="ADDED_fields_items_blkio_read"> <div class="card-body pl-5"> <h4>Read</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Blkio read bytes.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionADDED_fields_items_blkio_write"> <div class="card"> <div class="card-header" id="headingADDED_fields_items_blkio_write"> <h2 class="mb-0"> <button aria-controls="ADDED_fields_items_blkio_write" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_items_blkio_write" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_items_blkio_write')" type="button"><span class="property-name">write</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingADDED_fields_items_blkio_write" class="collapse property-definition-div" data-parent="#accordionADDED_fields_items_blkio_write" id="ADDED_fields_items_blkio_write"> <div class="card-body pl-5"> <h4>Write</h4><span class="badge badge-dark value-type">Type: integer</span><br/> <span class="description"><p>Blkio write bytes.</p> </span> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div><br><br>

*Required roles:* APPS_READ