Documentation forAppOptics

Graphite Listener

Overview

This integration is a service input plugin that listens for messages from Graphite.

This integration is currently available for Windows and Linux platforms.

This integration was updated to V2 plugin framework. If you are still using depreciated way of configuring it, please refer to old documentation.

Setup

The graphite monitoring is accomplished by bridge-stream plugin which is included with the SolarWinds Snap Agent by default. Please follow the directions below to enable it for a agent instance. The bridge-stream plugin utilize Telegraf Socket Listener plugin.

Configuration

The agent provides an example task file to help you get started quickly, but requires you to provide the correct settings for your Collectd installation. To enable the task:

  1. Make a copy of the Graphite example task file task-bridge-graphite_listener.yaml.example, renaming it to task-bridge-graphite_listener.yaml:

    On Windows, using Explorer or PowerShell:

    Copy
    > copy "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-bridge-graphite_listener.yaml.example" "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-bridge-graphite_listener.yaml"

    On Linux using command line:

    Copy
    $ sudo cp /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-graphite_listener.yaml.example /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-graphite_listener.yaml
  2. Edit the task file with settings specific to your Graphite install:

    Copy
    ---
    version: 2

    schedule:
      type: "streaming"

    plugins:
      - plugin_name: bridge-stream

        config:
          graphite_listener:
            ## URL to listen on
            # service_address: "tcp://:8094"
            # service_address: "tcp://127.0.0.1:http"
            # service_address: "tcp4://:8094"
            # service_address: "tcp6://:8094"
            # service_address: "tcp6://[2001:db8::1]:8094"
            # service_address: "udp://:8094"
            # service_address: "udp4://:8094"
            # service_address: "udp6://:8094"
            # service_address: "unix:///tmp/graphite.sock"
            # service_address: "unixgram:///tmp/graphite.sock"
            
            ## Maximum number of concurrent connections.
            ## Only applies to stream sockets (e.g. TCP).
            ## 0 (default) is unlimited.
            # max_connections: 1024
            
            ## Read timeout.
            ## Only applies to stream sockets (e.g. TCP).
            ## 0 (default) is unlimited.
            # read_timeout: "30s"
            
            ## Maximum socket buffer size in bytes.
            ## For stream sockets, once the buffer fills up, the sender will start backing up.
            ## For datagram sockets, once the buffer fills up, metrics will start dropping.
            ## Defaults to the OS default.
            # read_buffer_size: 65535
            
            ## Period between keep alive probes.
            ## Only applies to TCP sockets.
            ## 0 disables keep alive probes.
            ## Defaults to the OS configuration.
            # keep_alive_period: "5m"
            
            ## Templates specify rules for translating metric names into tagged metrics. For more details:
            ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md#graphite
            # templates:
            #   - cpu.* measurement*
            
            ## Metric name prefix
            bridge_prefix: "graphite"
            data_format: "graphite"
            
        tags:
          collector_plugin: "graphite_listener"
          
        publish:
          - plugin_name: publisher-appoptics
  3. Restart the agent:

    On Windows command line:

    Copy
    > net stop swisnapd
    > net start swisnapd

    On Linux command line:

    Copy
    $ sudo service swisnapd restart
  4. Enable the Graphite integration in AppOptics

    On the Integrations Page you will see Graphite integration available if the previous steps were successful. It may take a couple minutes before the Graphite integration is identified. Select the Graphite integration to open the configuration menu in the UI, and enable it. If you do not see it, see Troubleshooting Linux.

Testing Integration

To check if and what metrics can be collected with given configuration, run bridge-stream plugin in debug mode:

On Windows command line:

Copy
> "C:\Program Files\SolarWinds\Snap\bin\snap-plugin-collector-bridge.exe" --debug-mode --plugin-config "{\"socket_listener\": {\"service_address\": \"tcp://:8094\", \"bridge_prefix\": \"graphite\", \"data_format\": \"graphite\"}}"

On Linux command line:

Copy
$ /opt/SolarWinds/Snap/bin/snap-plugin-collector-bridge-stream --debug-mode --plugin-config "{\"socket_listener\": {\"service_address\": \"tcp://:8094\", \"bridge_prefix\": \"graphite\", \"data_format\": \"graphite\"}}"

Metrics and Tags

The collected metrics will be prefixed with graphite.* in AppOptics (or the configured value for bridge_prefix on the task configuration).

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.