Documentation forAppOptics

Community Plugin Catalog

SolarWinds Snap Agent supports custom plugins. Users can use those already developed by Snap community or develop their own. To see the most recent list of community plugins, please visit the Plugin Catalog. To start developing your own custom plugins, please visit Plugin Authoring.

When you add a community or a custom plugin to the SolarWinds Snap Agent, the plugin will appear on your Integrations view. Enable the community plugin to start collecting the metrics (collected metrics will also be accessible via metrics list) and easily create your own dashboard.

Community plugins are not maintained and tested by SolarWinds.

Community plugins are using V1 plugin framework and do not use tasks-autoload.d folder.

Enabling Community Plugins

Enabling community plugins in AppOptics is a straightforward process.

In a nutshell, it can be summarized as follows:

Once the community plugin is enabled, you'll be able to easily create a custom dashboard.

1. Download/Build Plugin Binary

Download or build plugin binary. The location of binary and how to build it is usually described on plugin's Github repository.

Copy the plugin binary over to /opt/SolarWinds/Snap/bin directory on the host where SolarWinds Snap Agent is running.

2. Create Plugin and Task Configuration files

In order to enable and run the plugin in AppOptics, you need to create two configuration files:

  • Task configuration - primarily controls plugin run schedule and metrics it collects.
  • Plugin configuration - contains plugin-specific configurations (for example: url, username, etc.)

You can typically find a sample task configuration file and plugin configuration file in the plugin's Github repository

Task Configuration

Create the task configuration file as:

Copy
task-<plugin-name>.yaml

Content of the task configuration file will typically be:

Copy
---
version: 1
schedule:
  # Run every minute
  type: cron
      interval: "0 * * * * *"
workflow:
  collect:
    metrics:
      /<plugin-provider>/<plugin-name>/*: {}
      config: {}
    publish:
      - plugin_name: publisher-appoptics
      config:
        period: 60
        floor_seconds: 60

Place the Task configuration file under /opt/SolarWinds/Snap/etc/tasks.d directory on the host where the SolarWinds Snap Agent is running.

Plugin Configuration

Create the plugin configuration file as:

Copy
<plugin-name>.yaml

Content of the plugin configuration file will typically be:

Copy
collector:
  <plugin-name>:
    all:
      <plugin-setting-1> : <value-1>
      <plugin-setting-2> : <value-2>
load:
  plugin: snap-plugin-collector-<plugin-name>
  task: task-<plugin-name>.yaml

Under the load configuration section, you should reference the plugin binary and task configuration files created earlier.

Place the Plugin configuration file under /opt/SolarWinds/Snap/etc/plugins.d directory on the host where the SolarWinds Snap Agent is running.

3. Restart the SolarWinds Snap Agent Service

Restart the SolarWinds Snap Agent service by running the following command:

Copy
sudo service swisnapd restart

This will start running the plugin on the SolarWinds Snap Agent.

4. Enable the Plugin

Login to AppOptics and go to the Integrations page. Your plugin should be listed there under the Community Plugins section.

Click on the plugin to expand the details panel and you'll be able to take following actions:

  1. Enable the plugin - Once enabled, AppOptics will start accepting the metrics from the plugin
  2. Create custom dashboard - Go to the Metrics tab on the plugin details panel where you can select a set of metrics. After selecting a set of metrics, click on Create Dashboard button to quickly create a custom dashboard

Don't forget to enable the plugin. Metrics will not be received and stored until the plugin has been enabled.

When the APM Integrated Experience is enabled, AppOptics shares a common navigation and settings with the other integrated experiences' products. How you navigate AppOptics and access its features may vary from these instructions. For more information, go to the APM Integrated Experience documentation.

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.