org.gridgain.visor.commands.alert

VisorAlertCommand

class VisorAlertCommand extends AnyRef

Overview

Visor 'alert' command implementation.

Help

+---------------------------------------------------------------------+
| alert | Generates email alerts for user-defined events.             |
|       | Node events and grid-wide events are defined via mnemonics. |
+---------------------------------------------------------------------+
Specification
alert
alert "-u {-id=|-a}"
alert "-r {-t=} {-=} ... {-=}"
Arguments
-u
    Unregisters alert(s). Either '-a' flag or '-id' parameter is required.
    Note that only one of the '-u' or '-r' is allowed.
    If neither '-u' or '-r' provided - all alerts will be printed.
-a
    When provided with '-u' - all alerts will be unregistered.
-id=<alert-id>
    When provided with '-u' - alert with matching ID will be unregistered.
-r
    Register new alert with mnemonic predicate(s).
    Note that only one of the '-u' or '-r' is allowed.
    If neither '-u' or '-r' provided - all alerts will be printed.

    NOTE: Email settings can be specified in GridGain configu
    Email notification will be sent for the alert only
    provided mnemonic predicates evaluate to 'true'."
-t
    Defines notification frequency in seconds. Default is 15 minutes.
    This parameter can only appear with '-r'.
-
    This defines a mnemonic for the metric that will be measured:

    Grid-wide metrics (not node specific):
       cc - Total number of available CPUs in the grid.
       nc - Total number of nodes in the grid.
       hc - Total number of physical hosts in the grid.
       cl - Current average CPU load (in %) in the grid.

    Per-node current metrics:
       aj - Active jobs on the node.
       cj - Cancelled jobs on the node.
       tc - Thread count on the node.
       ut - Up time on the node.
           Note:  can have 's', 'm', or 'h' suffix indicating
           seconds, minutes, and hours. By default (no suffix provided)
           value is assumed to be in milliseconds.
       je - Job execute time on the node.
       jw - Job wait time on the node.
       wj - Waiting jobs count on the node.
       rj - Rejected jobs count on the node.
       hu - Heap memory used (in MB) on the node.
       cd - Current CPU load on the node.
       hm - Heap memory maximum (in MB) on the node.
     ),

   Comparison part of the mnemonic predicate:
      eq - Equal '=' to '' number.
      neq - Not equal '!=' to '' number.
      gt - Greater than '>' to '' number.
      gte - Greater than or equal '>=' to '' number.
      lt - Less than '<' to 'NN' number.
      lte - Less than or equal '<=' to '' number.

    NOTE: Email notification will be sent for the alert only when all
          provided mnemonic predicates evaluate to 'true'.
Examples
alert
    Prints all currently registered alerts.
alert "-u -a"
    Unregisters all currently registered alerts.
alert "-u -id=12345678"
    Unregisters alert with provided ID.
alert "-r -t=900 -cc=gte4 -cl=gt50"
    Notify every 15 min if grid has >= 4 CPUs and > 50% CPU load.
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. VisorAlertCommand
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new VisorAlertCommand()

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. val DFLT_FREQ: Long

    Default alert frequency.

  5. def alert(args: String): Unit

    Registers, unregisters and list alerts.

    Command

    Registers, unregisters and list alerts.

    Examples

    <ex>alert "-u -a"</ex> Unregisters all currently registered alerts.

    <ex>alert "-i"</ex> Starts command in interactive mode.

    <ex>alert "-u -id=12345678"</ex> Unregisters alert with provided ID.

    <ex>alert "-r -t=900 -cc=gte4 -cl=gt50"</ex> Notify every 15 min if grid has >= 4 CPUs and > 50% CPU load.

    args

    Command arguments.

  6. def alert(): Unit

    Lists all registered alerts.

    Command

    Lists all registered alerts.

    Examples

    <ex>alert</ex> Prints all currently registered alerts.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  19. def toString(): String

    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped