SwarmAutoscaleNode

Constructor

Chaining Method Description
swarmAutoscale ( ) Create a node that can trigger autoscale events for a docker swarm cluster.

Property Methods

Setters Description
cluster ( value string) Cluster is the ID docker swarm cluster to use. The ID of the cluster is specified in the kapacitor configuration.
currentField ( value string) CurrentField is the name of a field into which the current replica count will be set as an int. If empty no field will be set. Useful for computing deltas on the current state.
decreaseCooldown ( value time.Duration) Only one decrease event can be triggered per resource every DecreaseCooldown interval.
increaseCooldown ( value time.Duration) Only one increase event can be triggered per resource every IncreaseCooldown interval.
max ( value int64) The maximum scale factor to set. If 0 then there is no upper limit. Default: 0, a.k.a no limit.
min ( value int64) The minimum scale factor to set. Default: 1
outputServiceNameTag ( value string) OutputServiceName is the name of a tag into which the service name will be written for output autoscale events. Defaults to the value of ServiceNameTag if its not empty.
replicas ( value ast.LambdaNode) Replicas is a lambda expression that should evaluate to the desired number of replicas for the resource.
serviceName ( value string) ServiceName is the name of the docker swarm service to autoscale.
serviceNameTag ( value string) ServiceName is the name of a tag which contains the name of the docker swarm service to autoscale.

Chaining Methods

Alert, Bottom, Combine, Count, CumulativeSum, Deadman, Default, Delete, Derivative, Difference, Distinct, Elapsed, Eval, First, Flatten, GroupBy, HoltWinters, HoltWintersWithFit, HttpOut, HttpPost, InfluxDBOut, Join, K8sAutoscale, KapacitorLoopback, Last, Log, Mean, Median, Mode, MovingAverage, Percentile, Sample, Shift, Sideload, Spread, StateCount, StateDuration, Stats, Stddev, Sum, SwarmAutoscale, Top, Union, Where, Window



Description

SwarmAutoscaleNode triggers autoscale events for a service on a Docker Swarm mode cluster. The node also outputs points for the triggered events.

Example:

     // Target 80% cpu per container
     var target = 80.0
     var min = 1
     var max = 10
     var period = 5m
     var every = period
     stream
         |from()
             .measurement('docker_container_cpu')
             .groupBy('container_name','com.docker.swarm.service.name')
             .where(lambda: "cpu" == 'cpu-total')
         |window()
             .period(period)
             .every(every)
         |mean('usage_percent')
             .as('mean_cpu')
         |groupBy('com.docker.swarm.service.name')
         |sum('mean_cpu')
             .as('total_cpu')
         |swarmAutoscale()
             // Get the name of the service from "com.docker.swarm.service.name" tag.
             .serviceNameTag('com.docker.swarm.service.name')
             .min(min)
             .max(max)
             // Set the desired number of replicas based on target.
             .replicas(lambda: int(ceil("total_cpu" / target)))
         |influxDBOut()
             .database('deployments')
             .measurement('scale_events')
             .precision('s')

The above example computes the mean of cpu usage_percent by container name and service name. Then sum of mean cpu_usage is calculated as total_cpu. Using the total_cpu over the last time period a desired number of replicas is computed based on the target percentage usage of cpu.

If the desired number of replicas has changed, Kapacitor makes the appropriate API call to Docker Swarm to update the replicas spec.

Any time the SwarmAutoscale node changes a replica count, it emits a point. The point is tagged with the service name, using the serviceName respectively In addition the group by tags will be preserved on the emitted point. The point contains two fields: old, and new representing change in the replicas.

Available Statistics:

  • increase_events – number of times the replica count was increased.
  • decrease_events – number of times the replica count was decreased.
  • cooldown_drops – number of times an event was dropped because of a cooldown timer.
  • errors – number of errors encountered, typically related to communicating with the Swarm manager API.

^

Properties

Property methods modify state on the calling node. They do not add another node to the pipeline, and always return a reference to the calling node. Property methods are marked using the . operator.

Cluster

Cluster is the ID docker swarm cluster to use. The ID of the cluster is specified in the kapacitor configuration.

swarmAutoscale.cluster(value string)

^

CurrentField

CurrentField is the name of a field into which the current replica count will be set as an int. If empty no field will be set. Useful for computing deltas on the current state.

Example:

    |swarmAutoscale()
        .currentField('replicas')
        // Increase the replicas by 1 if the qps is over the threshold
        .replicas(lambda: if("qps" > threshold, "replicas" + 1, "replicas"))
swarmAutoscale.currentField(value string)

^

DecreaseCooldown

Only one decrease event can be triggered per resource every DecreaseCooldown interval.

swarmAutoscale.decreaseCooldown(value time.Duration)

^

IncreaseCooldown

Only one increase event can be triggered per resource every IncreaseCooldown interval.

swarmAutoscale.increaseCooldown(value time.Duration)

^

Max

The maximum scale factor to set. If 0 then there is no upper limit. Default: 0, a.k.a no limit.

swarmAutoscale.max(value int64)

^

Min

The minimum scale factor to set. Default: 1

swarmAutoscale.min(value int64)

^

OutputServiceNameTag

OutputServiceName is the name of a tag into which the service name will be written for output autoscale events. Defaults to the value of ServiceNameTag if its not empty.

swarmAutoscale.outputServiceNameTag(value string)

^

Replicas

Replicas is a lambda expression that should evaluate to the desired number of replicas for the resource.

swarmAutoscale.replicas(value ast.LambdaNode)

^

ServiceName

ServiceName is the name of the docker swarm service to autoscale.

swarmAutoscale.serviceName(value string)

^

ServiceNameTag

ServiceName is the name of a tag which contains the name of the docker swarm service to autoscale.

swarmAutoscale.serviceNameTag(value string)

^

Chaining Methods

Chaining methods create a new node in the pipeline as a child of the calling node. They do not modify the calling node. Chaining methods are marked using the | operator.

Alert

Create an alert node, which can trigger alerts.

swarmAutoscale|alert()

Returns: AlertNode

^

Bottom

Select the bottom num points for field and sort by any extra tags or fields.

swarmAutoscale|bottom(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode

^

Combine

Combine this node with itself. The data are combined on timestamp.

swarmAutoscale|combine(expressions ...ast.LambdaNode)

Returns: CombineNode

^

Count

Count the number of points.

swarmAutoscale|count(field string)

Returns: InfluxQLNode

^

CumulativeSum

Compute a cumulative sum of each point that is received. A point is emitted for every point collected.

swarmAutoscale|cumulativeSum(field string)

Returns: InfluxQLNode

^

Deadman

Helper function for creating an alert on low throughput, a.k.a. deadman’s switch.

  • Threshold – trigger alert if throughput drops below threshold in points/interval.
  • Interval – how often to check the throughput.
  • Expressions – optional list of expressions to also evaluate. Useful for time of day alerting.

Example:

    var data = stream
        |from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |deadman(100.0, 10s)
    //Do normal processing of data
    data...

The above is equivalent to this Example:

    var data = stream
        |from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |stats(10s)
            .align()
        |derivative('emitted')
            .unit(10s)
            .nonNegative()
        |alert()
            .id('node \'stream0\' in task \'{{ .TaskName }}\'')
            .message('{{ .ID }} is {{ if eq .Level "OK" }}alive{{ else }}dead{{ end }}: {{ index .Fields "emitted" | printf "%0.3f" }} points/10s.')
            .crit(lambda: "emitted" <= 100.0)
    //Do normal processing of data
    data...

The id and message alert properties can be configured globally via the ‘deadman’ configuration section.

Since the AlertNode is the last piece it can be further modified as usual. Example:

    var data = stream
        |from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    data
        |deadman(100.0, 10s)
            .slack()
            .channel('#dead_tasks')
    //Do normal processing of data
    data...

You can specify additional lambda expressions to further constrain when the deadman’s switch is triggered. Example:

    var data = stream
        |from()...
    // Trigger critical alert if the throughput drops below 100 points per 10s and checked every 10s.
    // Only trigger the alert if the time of day is between 8am-5pm.
    data
        |deadman(100.0, 10s, lambda: hour("time") >= 8 AND hour("time") <= 17)
    //Do normal processing of data
    data...
swarmAutoscale|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode)

Returns: AlertNode

^

Default

Create a node that can set defaults for missing tags or fields.

swarmAutoscale|default()

Returns: DefaultNode

^

Delete

Create a node that can delete tags or fields.

swarmAutoscale|delete()

Returns: DeleteNode

^

Derivative

Create a new node that computes the derivative of adjacent points.

swarmAutoscale|derivative(field string)

Returns: DerivativeNode

^

Difference

Compute the difference between points independent of elapsed time.

swarmAutoscale|difference(field string)

Returns: InfluxQLNode

^

Distinct

Produce batch of only the distinct points.

swarmAutoscale|distinct(field string)

Returns: InfluxQLNode

^

Elapsed

Compute the elapsed time between points

swarmAutoscale|elapsed(field string, unit time.Duration)

Returns: InfluxQLNode

^

Eval

Create an eval node that will evaluate the given transformation function to each data point. A list of expressions may be provided and will be evaluated in the order they are given. The results are available to later expressions.

swarmAutoscale|eval(expressions ...ast.LambdaNode)

Returns: EvalNode

^

First

Select the first point.

swarmAutoscale|first(field string)

Returns: InfluxQLNode

^

Flatten

Flatten points with similar times into a single point.

swarmAutoscale|flatten()

Returns: FlattenNode

^

GroupBy

Group the data by a set of tags.

Can pass literal * to group by all dimensions. Example:

    |groupBy(*)
swarmAutoscale|groupBy(tag ...interface{})

Returns: GroupByNode

^

HoltWinters

Compute the holt-winters (https://docs.influxdata.com/influxdb/latest/query_language/functions/#holt-winters) forecast of a data set.

swarmAutoscale|holtWinters(field string, h int64, m int64, interval time.Duration)

Returns: InfluxQLNode

^

HoltWintersWithFit

Compute the holt-winters (https://docs.influxdata.com/influxdb/latest/query_language/functions/#holt-winters) forecast of a data set. This method also outputs all the points used to fit the data in addition to the forecasted data.

swarmAutoscale|holtWintersWithFit(field string, h int64, m int64, interval time.Duration)

Returns: InfluxQLNode

^

HttpOut

Create an HTTP output node that caches the most recent data it has received. The cached data are available at the given endpoint. The endpoint is the relative path from the API endpoint of the running task. For example, if the task endpoint is at /kapacitor/v1/tasks/<task_id> and endpoint is top10, then the data can be requested from /kapacitor/v1/tasks/<task_id>/top10.

swarmAutoscale|httpOut(endpoint string)

Returns: HTTPOutNode

^

HttpPost

Creates an HTTP Post node that POSTS received data to the provided HTTP endpoint. HttpPost expects 0 or 1 arguments. If 0 arguments are provided, you must specify an endpoint property method.

swarmAutoscale|httpPost(url ...string)

Returns: HTTPPostNode

^

InfluxDBOut

Create an influxdb output node that will store the incoming data into InfluxDB.

swarmAutoscale|influxDBOut()

Returns: InfluxDBOutNode

^

Join

Join this node with other nodes. The data are joined on timestamp.

swarmAutoscale|join(others ...Node)

Returns: JoinNode

^

K8sAutoscale

Create a node that can trigger autoscale events for a kubernetes cluster.

swarmAutoscale|k8sAutoscale()

Returns: K8sAutoscaleNode

^

KapacitorLoopback

Create an kapacitor loopback node that will send data back into Kapacitor as a stream.

swarmAutoscale|kapacitorLoopback()

Returns: KapacitorLoopbackNode

^

Last

Select the last point.

swarmAutoscale|last(field string)

Returns: InfluxQLNode

^

Log

Create a node that logs all data it receives.

swarmAutoscale|log()

Returns: LogNode

^

Mean

Compute the mean of the data.

swarmAutoscale|mean(field string)

Returns: InfluxQLNode

^

Median

Compute the median of the data. Note, this method is not a selector, if you want the median point use .percentile(field, 50.0).

swarmAutoscale|median(field string)

Returns: InfluxQLNode

^

Mode

Compute the mode of the data.

swarmAutoscale|mode(field string)

Returns: InfluxQLNode

^

MovingAverage

Compute a moving average of the last window points. No points are emitted until the window is full.

swarmAutoscale|movingAverage(field string, window int64)

Returns: InfluxQLNode

^

Percentile

Select a point at the given percentile. This is a selector function, no interpolation between points is performed.

swarmAutoscale|percentile(field string, percentile float64)

Returns: InfluxQLNode

^

Sample

Create a new node that samples the incoming points or batches.

One point will be emitted every count or duration specified.

swarmAutoscale|sample(rate interface{})

Returns: SampleNode

^

Shift

Create a new node that shifts the incoming points or batches in time.

swarmAutoscale|shift(shift time.Duration)

Returns: ShiftNode

^

Sideload

Create a node that can load data from external sources

swarmAutoscale|sideload()

Returns: SideloadNode

^

Spread

Compute the difference between min and max points.

swarmAutoscale|spread(field string)

Returns: InfluxQLNode

^

StateCount

Create a node that tracks number of consecutive points in a given state.

swarmAutoscale|stateCount(expression ast.LambdaNode)

Returns: StateCountNode

^

StateDuration

Create a node that tracks duration in a given state.

swarmAutoscale|stateDuration(expression ast.LambdaNode)

Returns: StateDurationNode

^

Stats

Create a new stream of data that contains the internal statistics of the node. The interval represents how often to emit the statistics based on real time. This means the interval time is independent of the times of the data points the source node is receiving.

swarmAutoscale|stats(interval time.Duration)

Returns: StatsNode

^

Stddev

Compute the standard deviation.

swarmAutoscale|stddev(field string)

Returns: InfluxQLNode

^

Sum

Compute the sum of all values.

swarmAutoscale|sum(field string)

Returns: InfluxQLNode

^

SwarmAutoscale

Create a node that can trigger autoscale events for a docker swarm cluster.

swarmAutoscale|swarmAutoscale()

Returns: SwarmAutoscaleNode

^

Top

Select the top num points for field and sort by any extra tags or fields.

swarmAutoscale|top(num int64, field string, fieldsAndTags ...string)

Returns: InfluxQLNode

^

Union

Perform the union of this node and all other given nodes.

swarmAutoscale|union(node ...Node)

Returns: UnionNode

^

Where

Create a new node that filters the data stream by a given expression.

swarmAutoscale|where(expression ast.LambdaNode)

Returns: WhereNode

^

Window

Create a new node that windows the stream by time.

NOTE: Window can only be applied to stream edges.

swarmAutoscale|window()

Returns: WindowNode

^

This documentation is open source. See a typo? Please, open an issue.


Need help getting up and running? Get Support