github.com/mackerelio/mackerel-agent-plugins@v0.89.3/mackerel-plugin-sidekiq/README.md (about)

     1  mackerel-plugin-sidekiq
     2  ====
     3  
     4  ## Overview
     5  Sidekiq custom metrics plugin for mackerel.io agent.
     6  
     7  ## Description
     8  
     9  This plugin makes two graphs: one shows processed job diff and failed job diff, and another one shows number of busy, enqueued, scheduled, retry and dead jobs.
    10  
    11  ## Usage
    12  
    13  ```
    14  mackerel-plugin-sidekiq [-host=<host>] [-port=<port>] [-password=<password>] [-db=<db>] [-tempfile=<template file path>] [-redis-namespace=<redis namespace>]
    15  ```
    16  
    17  ### Example of mackerel-agent.conf
    18  
    19  ```
    20  [plugin.metrics.sidekiq]
    21  command = "/path/to/mackerel-plugin-sidekiq"
    22  ```
    23  
    24  ## Graphs and Metrics
    25  
    26  ### Sidekiq processed and failed count (sidekiq.ProcessedANDFailed)
    27  
    28  * processed (sidekiq.ProcessedANDFailed.processed)
    29  * failed (sidekiq.ProcessedANDFailed.failed)
    30  
    31  ### Sidekiq stats (sidekiq.Stats)
    32  
    33  * busy (sidekiq.Stats.busy)
    34  * enqueued (sidekiq.Stats.enqueued)
    35  * scheduled (sidekiq.Stats.scheduled)
    36  * retry (sidekiq.Stats.retry)
    37  * dead (sidekiq.Stats.dead)
    38  
    39  ### sidekiq queue latency (sidekiq.QueueLatency)
    40  
    41  * Latency sec (sidekiq.QueueLatency.#)
    42  
    43  ## Author
    44  
    45  [littlekbt](https://github.com/littlekbt)