Getting started

Sleuth is a deployment tracker that helps you move fast without breaking things. It only takes a few minutes to connect Sleuth to a change source and start analyzing the health of your code.

A change source can be a code deployment on Bitbucket or GitHub, feature flags on LaunchDarkly, or issues on Clubhouse or Jira, with many other integrations available.

To get started with Sleuth:

  • Create an account. You can use an email address or connect via SSO thru Google, GitHub or Bitbucket. Read Signing up for more information.

  • Name your project. You can also add a description, which is optional.

  • Add a code deployment. This can be a repo on GitHub, feature flags on LaunchDarkly, issues from Jira, stories from Clubhouse, or one of the many other available integrations.

  • Add an integration. An integration can be change sources, chat ops, issue trackers, and error and metric trackers. Make sure you have access credentials for any integration you want to connect. Also, be sure to generate any API tokens ahead of time so you can breeze on through the setup process.

For a more detailed walkthrough of the setup process, click through the tabs below:

Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 1

Go to the Sleuth Dashboard

Step 2

Select Create, then Create project

Step 3

Add a name and description for your project

Step 4

Connect integrations

Integrations are what enables Sleuth to gather data from disparate systems and present them to you in a single, easy-to-parse interface—the Dashboard.

Integrations are made at the Sleuth organization level. You can then add as many projects as you like within the organization. Once integrations are made to the organization, all projects created under the organization have access to the integrations' connections. Furthermore, any custom settings to an integration can be made for each project. For example, your staging project might send Slack notifications to one team, your production project to another.

Learn more about integrations.

Step 5

Invite team members

If you're part of an organization that has already set up a Sleuth environment and your email address uses the same domain, integrations might already be connected to your organization. In this case, you won't need to add the integration yourself.

You can add existing members to your organization or add the email address of someone you'd like to have invited to join your organization. If the invitation's accepted, the user will automatically be added to your organization. Go to Organization settings for more information on inviting team members.

You should also configure Sleuth's RBAC (Role-Based Access Control) system to control what team members can do with their Sleuth account. For more information, see Access Control, then head to the Organization's Members settings to set it all up.

Step 6

Add change sources

  • See commits, issues, pull requests, changed files and authors for every deploy.

  • Get notified when you or others on your team deploy, and know exactly what's changed and how it impacts your code.

  • Get release notes sent to specified Slack channels.

  • See an aggregate of what's been deployed today, this week or the entire month.

  • Allow everyone in your organization to understand what code changes you're shipping.

Step 7

Configure settings for your:

💥 You're ready!

Start seeing the impact of your changes in the Sleuth Dashboard. Happy deploying!