From 6cd906aaa24201202772ca9e2a5c755e2259a304 Mon Sep 17 00:00:00 2001 From: Dieter Plaetinck Date: Tue, 14 Jun 2016 13:20:52 -0400 Subject: [PATCH] docs: document lookupSeries. --- docs/expressions.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/expressions.md b/docs/expressions.md index a14ee56830..ad24a6ccfe 100644 --- a/docs/expressions.md +++ b/docs/expressions.md @@ -512,7 +512,12 @@ Returns the first count (scalar) results of number. ## lookup(table string, key string) numberSet +Returns the first key from the given lookup table with matching tags, this searches the built-in index and so only makes sense when using OpenTSDB and sending data to /index or relaying through bosun. + +## lookupSeries(series seriesSet, table string, key string) numberSet + Returns the first key from the given lookup table with matching tags. +The first argument is a series to use from which to derive the tag information. This is good for alternative storage backends such as graphite and influxdb. ## month(offset scalar, startEnd string) scalar