Documentation

TCP event handler

The TCP event handler sends JSON encoded alert data to a TCP endpoint.

Options

The following TCP event handler options can be set in a handler file or when using .tcp() in a TICKscript.

NameTypeDescription
addressstringAddress of TCP endpoint.

Example: handler file

id: handler-id
topic: topic-name
kind: tcp
options:
  address: 127.0.0.1:7777
  • Copy
  • Fill window

Example: TICKscript

|alert()
  // ...
  .tcp('127.0.0.1:7777')
  • Copy
  • Fill window

Using the TCP event handler

The TCP event handler can be used in both TICKscripts and handler files to send alert data to TCP endpoint.

Send alert data to a TCP endpoint from a TICKscript

The following TICKscript uses the .tcp() event handler to send alert data whenever idle CPU usage drops below 10%.

tcp-cpu-alert.tick

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .tcp('127.0.0.1:7777')
  • Copy
  • Fill window

Send alert data to a TCP endpoint from a defined handler

The following setup sends an alert to the cpu topic with the message, “Hey, check your CPU”. A TCP handler is added that subscribes to the cpu topic and sends all alert messages to a TCP endpoint.

Create a TICKscript that publishes alert messages to a topic. The TICKscript below sends an alert message to the cpu topic any time idle CPU usage drops below 10%.

cpu_alert.tick

stream
  |from()
    .measurement('cpu')
  |alert()
    .crit(lambda: "usage_idle" < 10)
    .message('Hey, check your CPU')
    .topic('cpu')
  • Copy
  • Fill window

Add and enable the TICKscript:

kapacitor define cpu_alert -tick cpu_alert.tick
kapacitor enable cpu_alert
  • Copy
  • Fill window

Create a handler file that subscribes to the cpu topic and uses the TCP event handler to send alert data to a TCP endpoint.

tcp_cpu_handler.yaml

id: tcp-cpu-alert
topic: cpu
kind: tcp
options:
  address: 127.0.0.1:7777
  • Copy
  • Fill window

Add the handler:

kapacitor define-topic-handler tcp_cpu_handler.yaml
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: