Packages

class MetricsAPI extends AnyRef

These API endpoints are useful for finding and listing metrics available in the system.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetricsAPI
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MetricsAPI(host: String, port: Int = 80)

    host

    - Graphite server address.

    port

    - Graphite server port. Default: 80

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def expand(query: String, groupByExpr: Boolean = false, leavesOnly: Boolean = false): Option[Expansion]

    Expands the given query with matching paths.

    Expands the given query with matching paths.

    query

    - The metrics query. Can be specified multiple times.

    groupByExpr

    - Whether to return a flat list of results (false) or group them by query (true). Default: false

    leavesOnly

    - Whether to only return leaves (false) or both branches and leaves (true). Default: false // fixme: dobule-check correctness

  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def find(query: String, format: String = "treejson", wildcards: Boolean = false, from: Instant = Instant.now.minus(WEEK), until: Instant = Instant.now): Option[Metrics]

    Finds metrics under a given path.

    Finds metrics under a given path.

    query

    - The query to search for.

    format

    - The output format to use. Can be "completer" or "treejson". Default: "treejson" [TODO: completer not yet supported; create types]

    wildcards

    - Whether to add a wildcard result at the end or no. Default: false

    from

    - Timestamp from which to consider metrics. Default: week ago

    until

    - Timestamp until which to consider metrics. Default: now

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  13. def index: Option[Index]

    Walks the metrics tree and returns every metric found as a sorted JSON array.

  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