Webhooks and Zabbix Integration

Input and output integration overview

The Webhooks plugin allows Telegraf to receive and process HTTP requests from various external services via webhooks. This plugin enables users to collect real-time metrics and events and integrate them into their monitoring solutions.

This plugin sends metrics to Zabbix via traps, allowing for efficient monitoring of systems and applications. It supports automated configuration and data sending based on dynamic metrics collected by Telegraf.

Integration details

Webhooks

This Telegraf plugin is designed to act as a webhook listener by starting an HTTP server that registers multiple webhook endpoints. It provides a way to collect events from various services by capturing HTTP requests sent to defined paths. Each service can be configured with its specific authentication details and request handling options. The plugin stands out by allowing integration with any Telegraf output plugin, making it versatile for event-driven architectures. By enabling efficient reception of events, it opens possibilities for real-time monitoring and response systems, essential for modern applications that need instantaneous event handling and processing.

Zabbix

The Telegraf Zabbix plugin is designed to send metrics to Zabbix, an open-source monitoring solution, using the trap protocol. It supports various versions from 3.0 to 6.0, ensuring compatibility with recent updates. The plugin facilitates easy integration with the Zabbix ecosystem, allowing users to send collected metrics and monitor system performance seamlessly. Key functionalities include the ability to define the address and port of the Zabbix server, options for prefixing keys, determining the type of data sent (active vs. trapper), and features for low-level discovery (LLD) enabling dynamic item creation based on the metrics observed. Configuration options also allow for autoregistration and resending intervals for LLD data, ensuring that the metrics are up-to-date and relevant. Additionally, the trap format used for sending metrics is structured to facilitate efficient data transfer and processing in Zabbix.

Configuration

Webhooks

[[inputs.webhooks]]
  ## Address and port to host Webhook listener on
  service_address = ":1619"

  ## Maximum duration before timing out read of the request
  # read_timeout = "10s"
  ## Maximum duration before timing out write of the response
  # write_timeout = "10s"

  [inputs.webhooks.filestack]
    path = "/filestack"

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.github]
    path = "/github"
    # secret = ""

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.mandrill]
    path = "/mandrill"

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.rollbar]
    path = "/rollbar"

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.papertrail]
    path = "/papertrail"

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.particle]
    path = "/particle"

    ## HTTP basic auth
    #username = ""
    #password = ""

  [inputs.webhooks.artifactory]
    path = "/artifactory"

Zabbix

[[outputs.zabbix]]
  ## Address and (optional) port of the Zabbix server
  address = "zabbix.example.com:10051"

  ## Send metrics as type "Zabbix agent (active)"
  # agent_active = false

  ## Add prefix to all keys sent to Zabbix.
  # key_prefix = "telegraf."

  ## Name of the tag that contains the host name. Used to set the host in Zabbix.
  ## If the tag is not found, use the hostname of the system running Telegraf.
  # host_tag = "host"

  ## Skip measurement prefix to all keys sent to Zabbix.
  # skip_measurement_prefix = false

  ## This field will be sent as HostMetadata to Zabbix Server to autoregister the host.
  ## To enable this feature, this option must be set to a value other than "".
  # autoregister = ""

  ## Interval to resend auto-registration data to Zabbix.
  ## Only applies if autoregister feature is enabled.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # autoregister_resend_interval = "30m"

  ## Interval to send LLD data to Zabbix.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_send_interval = "10m"

  ## Interval to delete stored LLD known data and start capturing it again.
  ## This value is a lower limit, the actual resend should be triggered by the next flush interval.
  # lld_clear_interval = "1h"

Input and output integration examples

Webhooks

1. Real-time Notifications from Github: Integrate the Webhooks Input Plugin with Github to receive real-time notifications for events such as pull requests, commits, and issues. This allows development teams to instantly monitor crucial changes and updates in their repositories, improving collaboration and response times.

2. Automated Alerting with Rollbar: Use this plugin to listen for errors reported from Rollbar, enabling teams to react swiftly to bugs and issues in production. By forwarding these alerts into a centralized monitoring system, teams can prioritize their responses based on severity and prevent escalated downtime.

3. Performance Monitoring from Filestack: Capture events from Filestack to track file uploads, transformations, and errors. This setup helps businesses understand user interactions with file management processes, optimize workflow, and ensure high availability of file services.

4. Centralized Logging with Papertrail: Tie in all logs sent to Papertrail through webhooks, allowing you to consolidate your logging strategy. With real-time log forwarding, teams can analyze trends and anomalies efficiently, ensuring they maintain visibility over critical operations.

Zabbix

1. Dynamic Monitoring of Containerized Applications: Integration of the Zabbix plugin can be leveraged to monitor Docker containers dynamically. As containers are created and removed, the plugin can automatically update Zabbix with the appropriate metrics, ensuring that monitoring stays current without manual configuration. This enhances visibility into resource usage and performance metrics for microservices orchestrated with Kubernetes or Docker Swarm.

2. Real-Time Performance Monitoring with Auto-registration: By enabling the autoregister feature, the plugin can automatically register hosts in Zabbix based on the metrics received. This scenario provides a streamlined approach to add new hosts to monitoring without manual setup, which is particularly useful in environments where hosts may frequently spin up and down, such as serverless architectures or cloud-based deployments.

3. Leveraging Low-level Discovery for Flexible Metric Capture: Using low-level discovery, this plugin allows Zabbix to adaptively create items for metrics that are not predefined. In a scenario involving multiple network devices reporting different performance metrics, the plugin can dynamically inform Zabbix about new metrics as they appear, thus ensuring comprehensive monitoring capabilities that evolve with the monitored systems.

4. Centralized Monitoring of Distributed Systems: The Zabbix plugin can be utilized in a centralized monitoring setup for distributed systems where multiple Telegraf instances are running across different geographical locations. By sending all metrics to a central Zabbix server, organizations can achieve a holistic view of their infrastructure’s performance and make informed operational decisions.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.