Knowledge Base: Features

  • Action Center Dashboard

    The new dashboard is split into two groups - the action list and the watch list. The action list shows alerts and action items that are sorted by priority, so you can handle them from top to bottom. It includes broken build and release pipelines, incoming pull requests, and work items. You can define your own priority rules in settings. The action list will not show any items that are in a good state and don't need your attention. Use a watch list to keep track of things that you care about, but which are not actionable at the moment. By default, it includes

  • How to configure CatLight Action Center

    This article applies to CatLight V3. Before configuring the settings, you can learn more about how Action Center works in CatLight V3.

    On the dashboard, click on settings on any of the panels to configure item groups and priority rules.

    Action list settings

    Use the item groups section, to select specific things that you want to monitor (build and release pipelines, pull requests for repositories, work items). Then you can create priority rules that will apply additional filters to the item group. The dashboard panel will display items that match the rules.

    Priority rule settings:

    • Item group dropdown - this
  • How to change the team in CatLight

    Sometimes you might need to change the team that you are currently on. For example, if your current team does not have an active subscription, and you want to join the one that has.

    To change the team:

    1. In the CatLight app, click on the "Team" button, then on "Leave team".
    2. Click on "Enable collaboration" button on the dashboard and select the new team to join. If you don't see the right team on the list, ask the team admin to add you to the team at https://service.catlight.io 
  • Status icon

    CatLight shows a status icon in the tray on Windows and the menu bar on Mac OS X.

    When your attention is needed, CatLight will show a solid icon    . The icon will match the color of the top item on the action list.

    When something is broken, but you don't need to check it, the icon will change to an outline    . This happens when all items on the dashboard are being investigated or acknowledged.

    When everything is good, the icon is green 

    When focus mode is activated, CatLight will stop showing you notifications, and the icon will turn to .

  • Build investigations

    When a build is broken, all team members will see a button inviting them to investigate the build and fix it.

    When the build is being investigated, the tray icon will change to its acknowledged state for the whole team.

      =>  

    Build investigation status is displayed on the dashboard.

    After the build is fixed, the investigation will be automatically removed.

    Build investigations expire in 24 hours. So, if someone pressed the button and forgot about it, CatLight will raise an alarm on the next day.

    This feature is available for all continuous integration servers that we support. User need

  • Separate build history for branches

    CatLight works with GIT branches. It will show a separate build history for each branch and pull request.

     We divide branches in four categories:

    • Primary - they will be always visible on the dashboard. They include branches like master, develop, trunk, etc.
    • Short-lived - those are branches for pull requests. CatLight will show them for one day on the dashboard.
    • Other - this is a category for feature, bugfix and release branches. They will be tracked while they are active, and had at least one build in the past week.
    • Ignored - those branches will not be monitored. You can
  • Release monitoring

    CatLight app can monitor release definition status in TFS and VSTS/Azure Devops.

    Features:

    • Notifications about the status of every release environment
    • Separate notification when release is waiting for your approval
    • Overall status and history on the dashboard
    • Release investigations
  • Work item monitoring

    CatLight can monitor work items (tasks & bugs) in a TFS/VSTS project. It will notify you about the changes and show the current status in tray.

    You can use existing work item queries to select tasks and bugs that you want to monitor. Choose one of two modes:

    • Show all - use this for queries that should return empty result when everything is OK, and for queues of short-term work. For example: “Important open bugs”, “Urgent tasks”, “Bugs to verify today”, “Bugs to review”.
    • Show changes - use this to track changes in long-term queues of work, like “My tasks”,
  • See only relevant notifications

    By default, CatLight can show you a lot of notifications, so that you can see how the app works.

    To change this, go to the edit menu/settings.

    For long-term use you can make the following changes

    • Notifications
      • Choose "My Builds" to see less notifications. You can still see the statuses of all monitored builds in the  tray.
      • Uncheck "Show notifications when I change a work item"
    • Dashboard
      • Check "Don't show work item changes that I made myself"
    • Branches
      • Choose "Track My Branches"
  • Accelerated notifications

    By default, CatLight will poll your server every minute to check for updates. You can configure push notifications using webhooks for Azure DevOps, TFS, and Jenkins. After that CatLight app will significantly reduce polling frequency, and check for changes when it receives the push notification. You can expect to get notifications about 10x faster and reduce your server load by about 30x.

    Next steps:

    Configure accelerated notifications for Azure DevOps/TFS

    Configure accelerated notifications for Jenkins

  • How to configure accelerated notifications for Azure DevOps

    By default, CatLight will poll your server every minute to check for updates. For Azure DevOps/TFS, you can configure push notifications using webhooks. After that CatLight app will significantly reduce polling frequency, and check for changes when it receives the push notification. You can expect to get notifications about 10x faster and reduce your server load by about 30x.

    How to enable accelerated notifications

    • Install the CatLight Azure DevOps extension from the Visual Studio Marketplace
    • Go to Azure DevOps web UI. Every project should now have "CatLight" hub on the left. 

    • In the CatLight hub, click on "Enable accelerated notifications".
  • How to configure accelerated notifications for Jenkins

    By default, CatLight will poll your server every minute to check for updates. For Azure DevOps/TFS, you can configure push notifications using webhooks. After that CatLight app will significantly reduce polling frequency, and check for changes when it receives the push notification. You can expect to get notifications about 10x faster and reduce your server load by about 30x.

    How to enable accelerated notifications

    • Install the CatLight Jenkins plugin.
    • Go to Jenkins web UI, and click on the CatLight link in the left bar. 

    • Click on the "global settings" link, set a CatLight team id in Jenkins settings, and save
  • Search and filtering on the dashboard

    You can use wildcards and extglob expressions to filter items on the dashboard.

    Syntax:

    • * - matches any number of characters
    • ? - matches a single character
    • […] - matches any of the enclosed characters. For example: [a-z] , [a-d1-9]
    • ?(pattern-list) - Matches zero or one occurrence of the given patterns. pattern-list is a list of one or more patterns separated by a ‘|’. 
    • *(pattern-list) - Matches zero or more occurrences of the given patterns.
    • +(pattern-list) - Matches one or more occurrences of the given patterns.
    • @(pattern-list)  - Matches one of the given patterns.
    • !(pattern-list) - Matches anything except one of the given patterns

    Examples:

    • MyProject*Build
  • Team status

    CatLight can show the status of your team members 

    For every user, this report will show the number of items in different states on their dashboards.

    To add this report, go to teams menu > show team status.