Documentation forAppOptics

PSM/Scout (Pingdom Server Monitor)

Overview

This plugin provides a way for the PSM customers to use PSM plugins written in Ruby in AppOptics (including their own custom plugins). If PSM customers migrate to AppOptics, they will no longer have access to the PSM UI or PSM’s remote configuration. In this case, customers can still use PSM’s Ruby plugins, but they need to place those files on their servers themselves manually or via configuration management of choice (Ansible, Salt, etc).

This plugin is currently available for x86_64 Linux platforms.

Setup

The psm plugin is included with the SolarWinds Snap Agent by default. It’s an adapter for Ruby plugins written originally for PSM/Scout.

If you are a Scout client willing to migrate to AppOptics, please use the dedicated tool: https://github.com/pingdomserver/scout-ao

Prerequisites

This plugin requires that Ruby is available and Scout is installed but inactive on the target host.

Configuration

Normally you won't need to change anything here, the migration script does all the necessary setup.

  • If you wish to change the collector plugin settings, edit its configuration file /opt/SolarWinds/Snap/etc/plugins.d/psm.yaml:

    Copy
    ---
    collector:
      psm:
        all:
          ## Most probably you won't need to change those fields and may safely rely on the defaults
          ## For detailed configuration documentation please refer to https://server-monitor.readme.io/docs/agent
          # ruby_path
          # agent_ruby_bin
          # plugin_directory
          # agent_data_file
    load:
      plugin: snap-plugin-collector-psm
      task: task-psm.yaml

    The setting ruby_path is optional and defaults to the First ruby found in $PATH.

    The setting agent_ruby_bin is optional and defaults to /usr/share/scout/ruby/scout-client. It is an installation path of scout-client.

    The setting plugin_directory is optional and defaults to /opt/SolarWinds/Snap/bin/psm. It is a path to where the PSM plugins .rb files were downloaded (along with the corresponding .yaml files holding particular configs).

    The setting agent_data_file is optional and defaults to /var/lib/scoutd/client_history.yml.

    For more detailed configuration documentation please refer to scoutd docs

  • If you wish to change the collector task settings, edit its configuration file /opt/SolarWinds/Snap/etc/tasks.d/task-psm.yaml:

    Copy
    ---
    version: 1
    schedule:
      type: cron
      interval: "0 * * * * *"
    workflow:
      collect:
        metrics:
          # Don't change
          # Currently filtering is not supported for psm collector
          /psm/*: {}
        tags:
          /:
            ## Suggested tags:
            # roles: db
            # environment: production
            # hostname: localhost
        publish:
          - plugin_name: publisher-appoptics
            config:
              period: 60
              floor_seconds: 60

To make changes happen, restart the agent:

Copy
$ sudo service swisnapd restart

Unless you already did so, enable the PSM plugin in the AppOptics UI:

On the Integrations Page you will see the PSM plugin available. If you do not see the plugin, see Troubleshooting Linux.

Metrics

Metrics will appear as psm.plugin.<your_plugin_name>.<data_field_name>. As each customer has his/her own tailored set fo plugins, there’s no predefined default dashboard for this integration.

Tags

Each metric is annotated with the following tags:

Tag name Meaning
hostname Name of the host on which scout was running (used for host identification by the PSM API).
environment Annotation used in PSM for configuring different notifications for eg. production and staging servers. See the environments page in the PSM/Scout docs for more
roles Annotation used in PSM that let configuring servers in bulk. Servers could belong to many roles. See the roles page in the PSM/Scout docs for more
local_filename Name of the .rb file that reported metric
origin Origin of the plugin (eg. ‘local')
plugin_id Identificator of the original PSM/Scout plugin.

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.