class MetricsAPI extends AnyRef
These API endpoints are useful for finding and listing metrics available in the system.
- Alphabetic
- By Inheritance
- MetricsAPI
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
MetricsAPI(host: String, port: Int = 80)
- host
- Graphite server address.
- port
- Graphite server port. Default: 80
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
def
index: Option[Index]
Walks the metrics tree and returns every metric found as a sorted JSON array.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )