--- title: InfluxDBOutNode description: InfluxDBOutNode writes data to an InfluxDB database as it is received. url: https://docs.influxdata.com/kapacitor/v1/reference/nodes/influx_d_b_out_node/ estimated_tokens: 5361 product: Kapacitor version: v1 --- # InfluxDBOutNode The `influxDBOut` node writes data to InfluxDB as it is received. Example: ```js stream |from() .measurement('requests') |eval(lambda: "errors" / "total") .as('error_percent') // Write the transformed data to InfluxDB |influxDBOut() .database('mydb') .retentionPolicy('myrp') .measurement('errors') .tag('kapacitor', 'true') .tag('version', '0.2') ``` Available Statistics: - points\_written: number of points written to InfluxDB - write\_errors: number of errors attempting to write to InfluxDB ### Constructor | Chaining Method | Description | | --- | --- | | influxDBOut ( ) | Create an influxdb output node that will store the incoming data into InfluxDB. | ### Property Methods | Setters | Description | | --- | --- | | buffer ( value int64) | Number of points to buffer when writing to InfluxDB. Default: 1000 | | cluster ( value string) | The name of the InfluxDB instance to connect to. If empty the configured default will be used. | | create ( ) | Create indicates that both the database and retention policy will be created, when the task is started. If the retention policy name is empty then no retention policy will be specified and the default retention policy name will be created. | | database ( value string) | The name of the database. | | flushInterval ( value time.Duration) | Write points to InfluxDB after interval even if buffer is not full. Default: 10s | | measurement ( value string) | The name of the measurement. | | precision ( value string) | The precision to use when writing the data. | | quiet ( ) | Suppress all error logging events from this node. | | retentionPolicy ( value string) | The name of the retention policy. | | tag ( key string, value string) | Add a static tag to all data points. Tag can be called more then once. | | writeConsistency ( value string) | The write consistency to use when writing the data. | ### Chaining Methods [Deadman](#deadman), [Stats](#stats) ## 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. ### Buffer Number of points to buffer when writing to InfluxDB. Default: 1000 ```js influxDBOut.buffer(value int64) ``` ### Cluster The name of the InfluxDB instance to connect to. If empty the configured default will be used. ```js influxDBOut.cluster(value string) ``` ### Create Create indicates that both the database and retention policy will be created, when the task is started. If the retention policy name is empty then no retention policy will be specified and the default retention policy name will be created. If the database already exists nothing happens. ```js influxDBOut.create() ``` ### Database The name of the database. ```js influxDBOut.database(value string) ``` ### FlushInterval Write points to InfluxDB after interval even if buffer is not full. Default: 10s ```js influxDBOut.flushInterval(value time.Duration) ``` ### Measurement The name of the measurement. ```js influxDBOut.measurement(value string) ``` ### Precision The precision to use when writing the data. ```js influxDBOut.precision(value string) ``` ### Quiet Suppress all error logging events from this node. ```js influxDBOut.quiet() ``` ### RetentionPolicy The name of the retention policy. ```js influxDBOut.retentionPolicy(value string) ``` ### Tag Add a static tag to all data points. Tag can be called more then once. ```js influxDBOut.tag(key string, value string) ``` ### WriteConsistency The write consistency to use when writing the data. ```js influxDBOut.writeConsistency(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. ### 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: ```js 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: ```js 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](/kapacitor/v1/reference/nodes/alert_node/) is the last piece it can be further modified as usual. Example: ```js 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: ```js 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... ``` ```js influxDBOut|deadman(threshold float64, interval time.Duration, expr ...ast.LambdaNode) ``` Returns: [AlertNode](/kapacitor/v1/reference/nodes/alert_node/) ### 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. ```js influxDBOut|stats(interval time.Duration) ``` Returns: [StatsNode](/kapacitor/v1/reference/nodes/stats_node/)