Quick Setup Guide for Causely

Setting up Causely takes just a few minutes. This comprehensive guide walks you through the essential steps to create your account, install the Causely CLI, and configure your data sources for optimal performance.

After completing this guide, you are able to use Causely to identify root causes of issues in your environment and push insights into your workflows, enabling faster problem resolution and improved system reliability.

info

To explore Causely without installing the agent, you can use the Causely Sandbox.

1

Create an account

First, you need to create a Causely account. You can create one at auth.causely.app. You can create your account with a Google, Microsoft, or GitHub account, or your email address.

2

Retrieve Your Access Token

Once you have created your account, you need to retrieve your access token:

1. Visit https://portal.causely.app and log in.
2. Click on the gear icon in the top-right corner and select Integrations
3. Click the Details 🗝️ button and copy your access token to use in the next step.

3

Install the Causely Agent

Run the following command to install the Causely CLI. The Causely CLI simply wraps Helm. If you prefer to use Helm directly, you can click on the helm tab to install the Causely agent using Helm.

cli

export CAUSELY_TOKEN=<my_token>
# Download the Causely CLI installer
bash -c "$(curl -fksSL https://install.causely.ai/install.sh)"
# Install the Causely agent
causely agent install --token "${CAUSELY_TOKEN}"

helm

export CAUSELY_TOKEN=<my_token>
helm upgrade --install causely \
             --create-namespace oci://us-docker.pkg.dev/public-causely/public/causely \
             --version <version> \
             --namespace=causely \
             --set image.tag=<version> \
             --set global.cluster_name=<my_cluster_name> \
             --set mediator.gateway.token="${CAUSELY_TOKEN}"

info

For more information and custom installation options, see the installation guide.

3

Review Discovery

You have successfully installed Causely! Navigate to https://portal.causely.app to verify your environment has been discovered. You should see entities populated in the Topology view. As root causes are identified, they appear in the Diagnose and Prevent menus.

4

Connect Your Telemetry

To ensure that Causely can detect a wide range of root causes in your environment, it is recommended that you configure additional data sources if they are available. Visit the integrations page to learn more about the data sources that Causely supports.

5

Push Insights into Your Workflows

Causely helps you act faster by pushing insights, like root causes impacting service health, directly into the tools your team uses every day. Visit the workflows page to learn more about how to push insights into your workflows.