Merge pull request #20 from ovh/feat/doc/mask

Feat/doc/mask

Author: Florentin DUBOIS

spec/doc.md

@@ -457,6 +457,15 @@ The following TSL methods can be used to apply limit operators on metrics:
 * The **maxWith** operator. MaxWith will test all values to keep only the one **above maxWith parameter** and **replace** all other values per maxWith parameter, example: *.maxWith(2)*
 * The **minWith** operator. MinWith will test all values to keep only the one **below minWith parameter** and **replace** all other values per minWith parameter, example: *.minWith(2)*
 
+#### Metrics type convertor
+
+The following TSL methods can be used to convert metrics values:
+
+* The **toboolean** operator used to convert all metrics values to boolean, example: _.toboolean()._
+* The **todouble** operator used to convert all metrics values to double, example: _.todouble()._
+* The **tolong** operator used to convert all metrics values to long, example: _.tolong()._
+* The **tostring** operator used to convert all metrics values to long, example: _.tostring()._
+
 #### Metrics time operators
 
 The following TSL methods can be used to apply time related operators on metrics:
@@ -524,6 +533,9 @@ _For example: we can add the values of a first series with a second one. Value w
 * The **greaterOrEqual** operator between metrics sets, example: _greaterOrEqual(select(...), select(...), ...)_
 * The **lessThan** operator between metrics sets, example: _lessThan(select(...), select(...), ...)_
 * The **lessOrEqual** operator between metrics sets, example: _lessOrEqual(select(...), select(...), ...)_
+* The **mask** operator to use a [Warp 10 mask](https://www.warp10.io/doc/op.mask), example: _mask(select(...).toboolean(), select(...))_
+* The **negmask** operator to use a [Warp 10 negmask](https://www.warp10.io/doc/op.negmask), example: _negmask(select(...).toboolean(), select(...))_
+
 
 Example:
 

tsl/generateWarpScript.go

@@ -246,7 +246,7 @@ func (protoParser *ProtoParser) getFrameworksOp(selectStatement SelectStatement,
 			buffer.WriteString("\n")
 		case ABS, ADDSERIES, ANDL, CEIL, COUNT, DAY, DELTA, DIVSERIES, EQUAL, FLOOR, GREATERTHAN, GREATEROREQUAL, LESSTHAN, LESSOREQUAL,
 			LN, LOG2, LOG10, LOGN, HOUR, MAX, MAXWITH, MEAN, MEDIAN, MIN, MINWITH, MINUTE, MONTH, MULSERIES, NOTEQUAL, ORL, RATE, STDDEV, STDVAR,
-			ROUND, SQRT, SUM, TIMESTAMP, WEEKDAY, YEAR, JOIN, PERCENTILE, CUMULATIVE, WINDOW, FINITE:
+			ROUND, SQRT, SUM, TIMESTAMP, WEEKDAY, YEAR, JOIN, PERCENTILE, CUMULATIVE, WINDOW, FINITE, TOBOOLEAN, TODOUBLE, TOLONG, TOSTRING:
 
 			buffer.WriteString(protoParser.getMapper(framework, sampleSpan))
 			buffer.WriteString("\n")

tsl/genericParser.go

@@ -746,7 +746,7 @@ loop:
 			if err != nil {
 				return nil, err
 			}
-		case ABS, CEIL, CUMULATIVESUM, DAY, FLOOR, HOUR, LN, LOG2, LOG10, MINUTE, MONTH, ROUND, RESETS, SQRT, TIMESTAMP, WEEKDAY, YEAR:
+		case ABS, CEIL, CUMULATIVESUM, DAY, FLOOR, HOUR, LN, LOG2, LOG10, MINUTE, MONTH, ROUND, RESETS, SQRT, TIMESTAMP, WEEKDAY, YEAR, TOBOOLEAN, TODOUBLE, TOLONG, TOSTRING:
 			instruction, err = p.parseNoOperator(tok, pos, lit, instruction)
 
 			if err != nil {

tsl/token.go

@@ -151,8 +151,12 @@ const (
 	TIMESTAMP
 	TIMESCALE
 	TIMESPLIT
+	TOBOOLEAN
+	TODOUBLE
+	TOLONG
 	TOPN
 	TOPNBY
+	TOSTRING
 	WARP
 	WEEKDAY
 	WHERE
@@ -284,8 +288,12 @@ var tokens = [...]string{
 	STORE:             "store",
 	SUBSERIES:         "sub",
 	SUM:               "sum",
+	TOBOOLEAN:         "toboolean",
+	TODOUBLE:          "todouble",
+	TOLONG:            "tolong",
 	TOPN:              "topN",
 	TOPNBY:            "topNBy",
+	TOSTRING:          "tostring",
 	TIMECLIP:          "timeclip",
 	TIMEMODULO:        "timemodulo",
 	TIMESTAMP:         "timestamp",