Projects

Projects are the main container that Sleuth uses to organize your change sources. For example, a project can correlate to a web app you have created, or a staging or development environment for that application.

Creating a project

Sleuth will soon have support for environments. Until then, you can create multiple projects to house separate environments. For example, you can create a Super Web App Production project and a separate Super Web App Staging project. Integrations made at the organization level will be available to both projects.

To create a new project:

  1. In the sidebar, click Create.

  2. Click Create project.

  3. Name your project and, if you'd like, give it a description.

To track deployments, Sleuth must have access to the code you deploy. In order to access all of your commits, issues and pull request information, Sleuth needs to authorize with a full read and write scope of your code deployments and any other change source integrations.

Select the code repository from the dropdown and specify the branch that you deploy from. Sleuth will initialize the project with your last commit until further deploys are detected.

Change sources

Sleuth uses your code repos as its main sources of change. By analyzing past behavior (i.e., commits, pull requests, issues, feature flags, etc.) and comparing it with your current and future deploys, Sleuth paints a picture of your entire project's health status, giving you instant feedback on the impact of the changes you and your team are making. Sleuth can also look at feature flags and infrastructure environments, and provide you with actionable metrics, such as error logs, CPU utilization, and other information obtained from those platforms.

Adding a change source

To add a source of change, first make sure you have the necessary permissions.

See Change Sources to see which sources of change Sleuth supports.

Notifying Sleuth when you deploy

How does Sleuth know when you have deployed? There are three different ways Sleuth can be notified:

Manually registering your deploy

Ping Sleuth with a Git commit SHA or a tag to mark your deploy by making a POST request. You'll need to provide theses values when making the call:

  • YOUR_API_KEY

  • YOUR_SHA

  • ORG_NAME

  • PROJECT_NAME

You can find your API Key in Organization Settings > Details > Api key:

Locating your Sleuth API key

You can find YOUR_SHA using the commands:

git checkout YOUR_BRANCH
git rev-parse HEAD

Get more detailed information on manually registering a deploy via the Sleuth API.

Automatic tracking for each push to the configured branch

When this option is selected Sleuth will add a POST-commit hook to your repository.

This will ping Sleuth every time a commit is made. When we detect a commit against your projects branc, Sleuth will register a new deploy.

Automatic tracking for each tag made against the configured branch

When this option is selected, Sleuth will add a POST-commit hook to your repository.

This will ping Sleuth every time a commit is made. When we detect a tag against your projects branch, Sleuth will register a new deploy.

Tagging your code

A tag name can be anything, but we suggest something like: production_2015-04-18--16-15

To tag your code and push your changes to your remote repository, use a similar command to:

git tag production_2015-04-18--16-15
git push git@github.com:joeuser/myrepo.git production_2015-04-18--16-15

Editing a Project

After creating a project, you might want to make changes to its configuration, such as pointing to a different repo or adding or deleting an integration. This can be done by selecting your project in the sidebar.

In the screenshot below, Documentation is the currently the active project.

With the project selected, click on the gear icon and select Edit Project.

On the Edit Project dialog, you can change the project name or add/edit a description.