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.
To explore Causely without installing the agent, you can use the Causely Sandbox. Or, reach out to us to get a demo of Causely.
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.
Retrieve Your Access Token
Once you have created your account, you need to retrieve your access token:
- Visit https://portal.causely.app and log in.
- Click on the gear icon in the top-right corner and select
Integrations - Click the
Details 🗝️button and copy your access token to use in the next step.
Install the Causely Agent
Run the following command to install the Causely CLI and the Causely agent.
If you prefer to use Helm, click on the helm tab to install the Causely agent from the Causely Helm chart.
- cli
- helm
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}"
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}"
The Causely agent is installed in the causely namespace. To verify the installation, run:
kubectl get pods -n causely
By default, the applications in your cluster will be instrumented automatically using OpenTelemetry eBPF instrumentation. This means, that Causely can use OpenTelemetry traces to discover service dependencies, monitor sync and async communication signals and detect root causes of issues in your environment.
For more information and custom installation options, see the installation guide.
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.
For a quick walkthrough, go to the First-Time Usage Guide.
Connect Your Telemetry
The out of the box configuration of Causely already allows you to start analyzing your applications without code changes.
However, 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 telemetry sources page to learn more about the data sources that Causely supports.