ActiveMQ and Clickhouse Integration

Input and output integration overview

The ActiveMQ Input Plugin collects metrics from the ActiveMQ message broker through its Console API, providing insights into the performance and status of message queues, topics, and subscribers.

Telegraf’s SQL plugin sends collected metrics to an SQL database using a straightforward table schema and dynamic column generation. When configured for ClickHouse, it adjusts DSN formatting and type conversion settings to ensure seamless data integration.

Integration details

ActiveMQ

The ActiveMQ Input Plugin interfaces with the ActiveMQ Console API to gather metrics related to queues, topics, and subscribers. ActiveMQ, a widely-used open-source message broker, supports various messaging protocols and provides a robust Web Console for management and monitoring. This plugin allows users to track essential metrics including queue sizes, consumer counts, and message counts across different ActiveMQ entities, thereby enhancing observability within messaging systems. Users can configure various parameters such as the WebConsole URL and basic authentication credentials to tailor the plugin to their environment. The metrics collected can be used for monitoring the health and performance of messaging applications, facilitating proactive management and troubleshooting.

Clickhouse

Telegraf’s SQL plugin is engineered to write metric data into an SQL database by dynamically creating tables and columns based on incoming metrics. When configured for ClickHouse, it utilizes the clickhouse-go v1.5.4 driver, which employs a unique DSN format and a set of specialized type conversion rules to map Telegraf’s data types directly to ClickHouse’s native types. This approach ensures optimal storage and retrieval performance in high-throughput environments, making it well-suited for real-time analytics and large-scale data warehousing. The dynamic schema creation and precise type mapping enable detailed time-series data logging, crucial for monitoring modern, distributed systems.

Configuration

ActiveMQ

[[inputs.activemq]]
  ## ActiveMQ WebConsole URL
  url = "http://127.0.0.1:8161"

  ## Required ActiveMQ Endpoint
  ##   deprecated in 1.11; use the url option
  # server = "192.168.50.10"
  # port = 8161

  ## Credentials for basic HTTP authentication
  # username = "admin"
  # password = "admin"

  ## Required ActiveMQ webadmin root path
  # webadmin = "admin"

  ## Maximum time to receive response.
  # response_timeout = "5s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

Clickhouse

[[outputs.sql]]
  ## Database driver
  ## Valid options include mssql, mysql, pgx, sqlite, snowflake, clickhouse
  driver = "clickhouse"

  ## Data source name
  ## For ClickHouse, the DSN follows the clickhouse-go v1.5.4 format.
  ## Example DSN: "tcp://localhost:9000?debug=true"
  data_source_name = "tcp://localhost:9000?debug=true"

  ## Timestamp column name
  timestamp_column = "timestamp"

  ## Table creation template
  ## Available template variables:
  ##  {TABLE}        - table name as a quoted identifier
  ##  {TABLELITERAL} - table name as a quoted string literal
  ##  {COLUMNS}      - column definitions (list of quoted identifiers and types)
  table_template = "CREATE TABLE {TABLE} ({COLUMNS})"

  ## Table existence check template
  ## Available template variables:
  ##  {TABLE} - table name as a quoted identifier
  table_exists_template = "SELECT 1 FROM {TABLE} LIMIT 1"

  ## Initialization SQL (optional)
  init_sql = ""

  ## Maximum amount of time a connection may be idle. "0s" means connections are never closed due to idle time.
  connection_max_idle_time = "0s"

  ## Maximum amount of time a connection may be reused. "0s" means connections are never closed due to age.
  connection_max_lifetime = "0s"

  ## Maximum number of connections in the idle connection pool. 0 means unlimited.
  connection_max_idle = 2

  ## Maximum number of open connections to the database. 0 means unlimited.
  connection_max_open = 0

  ## Metric type to SQL type conversion for ClickHouse.
  ## The conversion maps Telegraf metric types to ClickHouse native data types.
  [outputs.sql.convert]
    conversion_style = "literal"
    integer          = "Int64"
    text             = "String"
    timestamp        = "DateTime"
    defaultvalue     = "String"
    unsigned         = "UInt64"
    bool             = "UInt8"
    real             = "Float64"

Input and output integration examples

ActiveMQ

1. Proactive Queue Monitoring: Use the ActiveMQ plugin to monitor queue sizes in real-time for a high-volume trading application. This implementation allows teams to receive alerts when queue sizes exceed a certain threshold, enabling rapid response to potential downtime caused by backlogs, thereby ensuring continuous availability of trading operations.

2. Performance Baselines and Anomaly Detection: Integrate this plugin with machine learning frameworks to establish performance baselines for message throughput. By analyzing historical data collected through this plugin, teams can flag anomalies in processing rates, leading to quicker identification of issues impacting service reliability and performance.

3. Cross-Messaging System Analytics: Combine metrics from ActiveMQ with those from other messaging systems in a centralized dashboard. Users can visualize and compare performance data, such as enqueue and dequeue rates, providing valuable insights into the overall messaging architecture and assisting in optimizing the message flow between different brokers.

4. Subscriber Performance Insights: Leverage the subscriber metrics collected by this plugin to analyze behavior patterns and optimize configuration for consumer applications. Understanding metrics such as dispatched queue size and counter values can guide adjustments to improve processing efficiency and resource allocation.

Clickhouse

1. Real-Time Analytics for High-Volume Data: Use the plugin to feed streaming metrics from large-scale systems into ClickHouse. This setup supports ultra-fast query performance and near real-time analytics, ideal for monitoring high-traffic applications.

2. Time-Series Data Warehousing: Integrate the plugin with ClickHouse to create a robust time-series data warehouse. This use case allows organizations to store detailed historical metrics and perform complex queries for trend analysis and capacity planning.

3. Scalable Monitoring in Distributed Environments: Leverage the plugin to dynamically create tables per metric type in ClickHouse, making it easier to manage and query data from a multitude of distributed systems without prior schema definitions.

4. Optimized Storage for IoT Deployments: Deploy the plugin to ingest data from IoT sensors into ClickHouse. Its efficient schema creation and native type mapping facilitate the handling of massive volumes of data, enabling real-time monitoring and predictive maintenance.

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.