| Docs

Appearance

Return to top
On this page

Install Metrist Orchestrator

Introduction

In order to get started with Metrist, you need to download the software into a compute environment you own. This allows you to monitor your individual experience with a cloud product. After creating a Metrist account, the process for you monitoring your cloud dependencies is as follows:

  1. Download & install Metrist
  2. Configure service monitors
  3. Configure alerting

Please contact us with any questions or schedule an onboarding call to get started.

Guided Installation

  1. To start a guided installation of Orchestrator, run this command and follow the prompts. You will, for example, need your API token which you can get from app.metrist.io/profile.

    sh
    curl https://dist.metrist.io/install.sh >/tmp/install.sh; bash /tmp/install.sh

    If you are running on a platform that the script supports, you will have a running copy of Orchestrator.

    TIP

    journalctl --unit metrist-orchestrator should show a running process.

    sudo systemctl stop metrist-orchestrator will stop the process.

    sudo systemctl start metrist-orchestrator will start the process.

  2. Also, if logged in at app.metrist.io, you can:

    • Add the Metrist monitor to your dashboard (click + Add/Remove dependencies),
    • select the Metrist monitor for display on your dashboard,
    • Save Changes,
    • then navigate to the Metrist monitor > Realtime Data > My Agent Data.

    You should see your Orchestrator reporting telemetry data to a region called fake-dev-instance (this is configurable, see below).

    Metrist monitor telemetry example

INFO

We do not support every combination/distribution of operating system. If the script detects that your system is not supported for guided installation, it will refer you back here.

Please see other installation options. These options are a good starting point for unattended installations, docker environments, etc.

Verification of Binaries

All binaries are signed by a key that is listed in our public keyring. Our installation instructions always include verify commands, such as:

gpg --verify --keyring=/tmp/metrist.gpg $orch_latest.asc

# where %orch_lastest.asc is the path to one of our binaries

Example:

sh
wget -nc https://raw.githubusercontent.com/Metrist-Software/orchestrator/main/dist/trustedkeys.gpg -O /tmp/metrist.gpg
orch_latest=$(curl https://dist.metrist.io/orchestrator/ubuntu/20.04.x86_64.latest.txt)
wget https://dist.metrist.io/orchestrator/ubuntu/$orch_latest
wget https://dist.metrist.io/orchestrator/ubuntu/$orch_latest.asc
gpg --verify --keyring=/tmp/metrist.gpg $orch_latest.asc
On warning: “gpg: Can't check signature: No public key”

Note the message: gpg: Signature made Day ## Month yyyy hh:mm:ss. This indicates the binary’s signature is valid.

You will also see: gpg: Can't check signature: No public key. This is to be expected and indicates that you have not, with your own private key, declared trust in our keyring. Contact us for more information.

Read about how we sign code for more information.

Copyright © 2021-present Metrist Inc.