Getting started

Track the health and status of your deployments with Sleuth. Let's get you started!

Sleuth Information Architecture

Sleuth can help you track the health and status of your deploys by providing a single of pane of glass through which you can view all of your change and impact sources. The Sleuth information architecture terms should already be familiar to you, since we use industry-standard CI/CD nomenclature (check out Terminology for more information).

In Sleuth you create a Project container, which houses all the necessary Environments your team might need to create, develop and test your applications. These Enviroments might include production, staging, development, and could even account for different deployment strategies such as canary, blue/green, etc.

Once you've created and configured the various Environments within your Project, you can start adding connections to your Change Sources and Impact Sources (see Integrations for more information on connecting Change Sources and Impact Sources).

Sleuth tracks Change Sources, such as Code Deployments, Feature Flags, and Infrastructure (coming soon), and constantly analyzes the information they contain to capture the state of your code before, during, and after deploys. Additionally, Sleuth intakes information provided by various Impact Sources, such as Error Rates, Uptime, and Other SLIs.

Dashboard

Combining Impact Source information with Change Source data is what drives the information you see on the Sleuth Dashboard.

You can instantly see the impact of your deploys on your entire project environment over a period of time by viewing the Trend Graph; for detailed information on individual deploys you can view a deploy card (see below).

You can view a live version of the Sleuth Dashboard at https://app.sleuth.io/sleuth/sleuth. It's what the Sleuth team uses everyday to make awesome!

Deploy cards

By viewing a deploy card, you can:

  • see who authored the deploy and how many PRs/commits/issues/files were in the deploy;

  • instantly view the pull request in whichever repository it resides in (GitHub or Bitbucket, for example);

  • know when the deploy occurred;

  • get an objective, historical assesment of your project's health (Unhealthy, Ailing, Healthy, Improved); and

  • know how large or small of an impact the deploy had on your project overall.

A Sleuth deploy card showing detailed information about a single deploy

Size

Another significant metric assessment Sleuth provides is Size. The Size chart shows you how many large versus small deploys you have committed to your repos (changes can be Small, Medium, Large, or Gigantic). Since the overall goal of solid CI/CD practice is to deploy small and deploy often, the Size chart gives you instant insight into whether you're continuously deploying small, effective changes to your repositories instead of occasional gigantic, unstable changes, which could prove problematic if a rollback is necessary when a change proves fatal to your application.

The Size chart in the Sleuth Dashboard

Slack notifications

You and your team can stay informed of your Project's status by connecting the Slack integration. By taking advantage of Slack's powerful team messaging features, you and your team can be notified when anything goes wrong, or when you just want to get an update that a deploy was successful.

Both team and one-to-one notifications can be configured in Slack. For example, your development team might want a notification on every deploy, but a product manager or CTO might only want a weekly digest or be notified only when there's an issue that might affect a release deadline.

A Slack notification generated by the Sleuth Slackbot

Let's get you started!

If you haven't already signed up for a Sleuth account, you'll need to do that first. Otherwise, let's continue by connecting Sleuth to a code repo. Click through tabs 1 thought 6 below:

Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
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

  • Connect GitHub, Bitbucket and LaunchDarkly change source integrations; Slack ChatOps integrations; and Jira and Clubhouse issue tracking integrations.

  • Enable GitHub or Bitbucket to track deploys made via your code repositories. See pull requests, commits, authors and issues associated with every deploy.

  • Enable LaunchDarkly to track changes made via your feature flags. Associate your flag changes with your code deployments.

  • Enable Slack to stay on top of your changes and alert your DevOps team members when changes have been deployed.

  • Enable Jira or Clubhouse to track the issues and epics you are deploying to your users

Step 5

Invite team members

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.

You can also configure your organization so that anyone signing up with an email from your company's domain will automatically join your organization without any additional action needed.

Step 6

Add change source

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

  • Quickly see when you've rolled out code and exactly what's changed to help squash bugs.

  • Release notes sent to your Slack team channels.

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

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

💥 You're ready!

You can now start seeing your code in the Sleuth Dashboard. Happy deploying!