Install clustered On-premise version of BugSnag.
If you have the Single Machine version of BugSnag On-premise, please follow the single machine installation guide instead.
To get started with your BugSnag On-premise installation, you’ll need the following things prepared in advance:
1.23and at most version
If you are installing BugSnag On-premise on AWS please follow the CloudFormation installation guide.
If you are installing BugSnag On-premise on an airgapped cluster or wish to use your own registry please follow the airgapped installation guide.
BugSnag On-premise uses Replicated KOTS to perform and manage installations.
Run the install script to download and install the Replicated KOTS CLI. The KOTS CLI is a
kubectl plugin that runs locally on any computer.
curl https://kots.io/install/1.103.2 | bash
The Replicated KOTS admin console provides a user interface for installing and managing BugSnag On-premise in your kubernetes cluster. Install the admin console by running the following command:
kubectl kots install bugsnag-clustered-kots/stable \ --name Bugsnag \ --namespace bugsnag
See install reference for all of the options available for the install command.
You can change the namespace you wish to install Replicated KOTS to, however ensure that the namespace matches the namespace in the configuration for BugSnag.
You will be asked to create a password for accessing the admin console.
After installation, the Replicated KOTS admin console will be available at
In the Replicated KOTS admin console you will be prompted for the password you created in the previous step. You can then upload the BugSnag On-premise license file you received from BugSnag to continue to the next step.
You will then be presented with the settings page. Here you can configure your BugSnag installation.
You will then be presented with the preflight check page, this will analyze the system to determine whether the environment meets the minimum requirements. These checks are done to ensure that your installation is successful.
Once complete BugSnag will be deployed to the cluster. It can take several minutes for BugSnag On-premise to fully start up; when it is ready the admin console will indicate that it is
Now BugSnag is running, you should be able to access the BugSnag dashboard, where you’ll need to create your account and first project.
Visit your BugSnag dashboard in a web browser to set up your account and create projects for each of the applications you wish to monitor.
Once you have created your account and first project you will need to configure your applications to send errors and sessions information to your BugSnag instance instead of notify.bugsnag.com and sessions.bugsnag.com respectively. Follow the instructions on configuring platform notifiers for how to do this.
Similarly, you will also need to configure your applications to send performance trace/span data to your BugSnag instance instead of otlp.bugsnag.com/v1/traces/. Follow our performance integration guides to get started.