Skip to content

Debian

Setup your collectors!

Epoch collectors can be run in both containerized as well as non-containerized environments. Only one collector is needed per host (VM or bare metal OS). Please follow the environment specific installation instructions below.

About

  • If you are viewing this documentation outside of the Epoch AOC, you may need to fill in untemplated variables in some of the steps below.
  • If you are running behind a load balancer, you will need to use the private IP address instead of the hostname ${host}.

Quickstart Installation

(Consult Supported Platforms and Collector Requirements before installing.)

Run the command below as a root user on the target instance. This command will install and start the collectors. You can view the auto-templated version of this command from the in-product documentation in the AOC.

wget --header="userport: ${port}" \
     -O /usr/bin/install-epoch-collectors.sh ${host}/install_epoch_collectors \
     && chmod +x /usr/bin/install-epoch-collectors.sh \
     && EPOCH_AOC_HOST=${your_epoch_host} EPOCH_ORGANIZATION_ID=${organizationId} EPOCH_AUTOUPGRADE_COLLECTORS=no EPOCH_INTERFACE=any EPOCH_ANALYSIS_DEPTH=layer7 EPOCH_L7_SAMPLINGRATE=20 /usr/bin/install-epoch-collectors.sh \
     && /etc/init.d/epoch-collectors restart

Tagging

Tagging the collectors is highly recommended in non-containerized environments. Tags help identify and group hosts in meaningful ways, e.g. Staging vs Production, DB vs Load Balancer vs App VM's etc. Refer Tagging Infrastructure

Manual Installation

This section provides instructions for manual installation of the collectors.

Run the commands below as a root user. Please remember to specify your AOC address and your organization ID.

  # Download the collectors with the command
  wget -q -O \
      epoch-collectors.deb \
      https://repo.epoch.nutanix.com/stable/epoch-collectors-debian-8-x64.deb

  # Install the collectors
  dpkg -i --force-overwrite epoch-collectors.deb

  # Configure the collectors.
  EPOCH_AOC_HOST=${your_epoch_host} EPOCH_ORGANIZATION_ID=${organizationId} EPOCH_AUTOUPGRADE_COLLECTORS=no EPOCH_INTERFACE=any EPOCH_ANALYSIS_DEPTH=layer7 EPOCH_L7_SAMPLINGRATE=20 /opt/nutanix/epoch/collectors/configure.sh

  # Start the collectors
  /etc/init.d/epoch-collectors start

Usage

# Start the collectors
/etc/init.d/epoch-collectors start

# Stop the collectors
/etc/init.d/epoch-collectors stop

Reconfiguration

To reconfigure the collectors, run the configure.sh script with the variables you wish to update.

  1. Edit the configure.sh script to change or add variables.

  2. Stop the collectors

    /etc/init.d/epoch-collectors stop
    
  3. Run the configure.sh script.

    EPOCH_AOC_HOST=${your_epoch_host} /opt/nutanix/epoch/collectors/configure.sh
    
  4. Restart the collectors

    /etc/init.d/epoch-collectors restart
    

Refer to the configuration section for a list of parameters you can configure.

Note: There are some known issues with collector autoupgrade on Debian-based systems. On Debian-based systems, Epoch is setting the environment variable EPOCH_COLLECTORS_AUTOUPGRADE=no by default to disable collector autoupgrades.

Installing Integrations

Creating the Config File

Create the necessary yaml config file in the /etc/epoch-dd-agent/conf.d directory of your collectors.

You can use the Configuration section from the instructions page for your integration as reference for the name and contents of the config file.

Checking Configuration

Check to make sure that all yaml files are valid with the following command:

/etc/init.d/epoch-collectors configcheck

Running the Integration

Run the integration by restarting the collector as follows:

/etc/init.d/epoch-collectors restart

Checking Runtime

Check to make sure that the integration is working with following command:

/etc/init.d/epoch-collectors info

The output of the info command should contain a section similar to the following:

    Checks
    ======
      [...]
      <name-of-integration>
      ----------
          - instance #0 [OK]
          - Collected 8 metrics & 0 events

Reporting Troubleshooting Information

If you are having issues with your collectors, you can run an inspect command which will gather troubleshooting information about the collectors, as well as any necessary logs.

  1. Generate the tar file.

    /etc/init.d/epoch-collectors inspect
    

    The tar file is created in the /tmp directory, and the file name begins with epoch-collectors-inspection.

  2. Send the tar file to Epoch support through email at epoch-support@nutanix.com

Uninstallation

To uninstall the collectors, run the following command:

apt-get purge epoch-collectors