Set up analytics dashboards

5 minute read

Configure comprehensive analytics data collection across CloudBees Unify workflows, integrations, and platform operations to enable DORA metrics, flow metrics, and operational insights. This guide covers end-to-end setup from essential integrations through dashboard configuration and data validation.

Before you begin, ensure you have Admin permissions in your organization and at least one active component with workflow runs.

Configure essential integrations

CloudBees Unify analytics require external tool integrations to collect comprehensive performance data.

Set up Jira integration for flow metrics

Flow metrics depend on Jira project management integration to track work item lifecycle data. To connect your Jira instance to CloudBees Unify:

  1. Navigate to Configurations  Integrations.

  2. Select Add integration.

  3. Choose Jira from the integration options.

  4. Complete the Jira connection configuration:

    1. Enter your Jira server URL.

    2. Provide authentication credentials (username and API token).

    3. Test the connection to verify access.

  5. Select Save to create the integration. The integration appears in your integrations list with a Connected status.

You need administrative access to your Jira instance to retrieve the API token required for integration.

Configure CI tool integrations for CI insights

CI insights require integration with Jenkins or CloudBees CI instances to collect platform operational data. To connect your CI tool to CloudBees Unify:

  1. Navigate to Configurations  Integrations.

  2. Select Add integration.

  3. Choose your CI tool type:

    1. Jenkins for open source Jenkins instances

    2. CloudBees CI for CloudBees CI installations

  4. Complete the CI tool connection configuration:

    1. Enter the controller URL.

    2. Provide authentication credentials.

    3. Configure webhook settings for real-time data collection.

  5. Select Test connection to verify access.

  6. Select Save to create the integration. The integration status changes to Active when connection succeeds.

Verify source code management integrations

Analytics dashboards require source code management (SCM) integration for commit and pull request data collection. To verify your SCM integration:

  1. Navigate to Configurations  Integrations.

  2. Confirm you have active SCM integrations (GitHub, GitLab, or Bitbucket).

  3. If SCM integration is missing:

    1. Select Add integration.

    2. Choose your SCM provider.

    3. Complete the authentication and repository access configuration.

    4. Test the connection and save.

Your SCM integration must have access to repositories used in your components for complete analytics data collection.

Configure analytics-specific settings

Analytics dashboards require additional configuration beyond basic integrations.

Set up analytics configuration for flow metrics

Flow metrics require explicit mapping between Jira issue types and flow item categories. To configure flow item mapping:

Complete Jira integration setup before configuring analytics settings.
  1. Navigate to Analytics  Analytics configuration.

  2. Select your Jira instance from the dropdown.

  3. Choose a Jira project for flow metrics configuration.

  4. Configure flow items mapping:

    1. Select Feature and map to appropriate Jira issue types (Story, Epic).

    2. Select Defect and map to bug-related issue types.

    3. Select Risk and map to security or compliance issue types.

    4. Select Tech Debt and map to technical improvement issue types.

  5. Configure work status mapping:

    1. Map Jira statuses to Active work time (In Progress, In Development).

    2. Map Jira statuses to Wait time (Blocked, Under Review, Waiting for Approval).

  6. Select SAVE to create the project configuration.

The analytics configuration validates your mappings and displays any configuration warnings.

Include Jira issue keys in commit messages to enable correlation between development activity and work item tracking.

Configure workflow annotations for DORA metrics

DORA metrics require workflow step annotations to identify build and deployment activities. To add workflow annotations:

  1. Open your workflow YAML files for editing.

  2. Add kind annotations to appropriate workflow steps:

    jobs: build: steps: - name: Build application uses: ... kind: build deploy: steps: - name: Deploy to production uses: ... kind: deploy env: production
  3. Ensure deployment steps specify target environments using the env parameter.

  4. Commit and push workflow changes to activate DORA data collection.

DORA calculations begin with the next workflow runs that include proper annotations.

Create and configure environments

DORA metrics require environment configuration to track deployment targets. To create and configure environments:

  1. Navigate to Configurations  Environments.

  2. Select Create environment for each deployment target:

    1. Enter environment name (development, staging, production).

    2. Select environment type from dropdown.

    3. Configure environment-specific settings.

  3. Associate environments with components:

    1. Navigate to your component settings.

    2. Select Environments tab.

    3. Add relevant environments to the component.

Environment associations enable DORA metrics to calculate deployment frequency and lead time per environment.

Configure security and test insights

Security and test insights require workflow integration with scanning and testing tools.

Enable security scanning data collection

Security insights collect data from security scanners integrated into workflow runs. To enable security scanning:

  1. Add security scanning actions to your workflows:

    - name: Run SAST scan uses: cloudbees-unify/sast-scan@v1 with: scanner: sonarqube - name: Run container scan uses: cloudbees-unify/container-scan@v1 with: scanner: trivy
  2. Ensure scanners publish results in supported formats (SARIF, JSON).

  3. Verify scan results appear in workflow run details.

Security insights populate automatically when workflows execute with proper security scanning configuration.

Configure test result publishing

Test insights require test result data from workflow executions. To configure test result publishing:

  1. Add test result publishing to workflows that execute tests:

    - name: Run tests run: npm test - name: Publish test results uses: cloudbees-unify/publish-test-results@v1 with: test-results: test-results.xml format: junit
  2. Support test result formats include JUnit XML, TestNG, and NUnit.

  3. Verify test results appear in workflow run details after execution.

Test insights dashboard populates with data from subsequent test executions.

Validate dashboard functionality

Confirm all analytics dashboards display data correctly after configuration completion.

Execute workflows to generate data

Analytics dashboards require active workflow execution to populate with performance data. To generate analytics data:

  1. Trigger workflow runs on components with analytics configuration:

    1. Make code changes and commit with Jira issue keys.

    2. Push changes to trigger automated workflow execution.

    3. Manually trigger workflow runs if needed.

  2. Execute workflows that include:

    1. Build steps with kind: build annotations.

    2. Deployment steps with kind: deploy annotations.

    3. Security scanning actions.

    4. Test execution and result publishing.

Allow 10-15 minutes for data processing and dashboard population after workflow completion.

Check dashboard data population

Verify each analytics dashboard displays expected data:

  1. Navigate to Analytics  DORA metrics:

    1. Confirm deployment frequency calculations appear.

    2. Verify deployment lead time data displays.

    3. Check change failure rate and MTTR calculations.

  2. Navigate to Analytics  Flow metrics:

    1. Verify work item data populates from Jira integration.

    2. Check cycle time and efficiency calculations.

    3. Confirm flow item distribution displays correctly.

  3. Navigate to Analytics  Software delivery activity:

    1. Verify commit and pull request data appears.

    2. Check build and deployment statistics.

    3. Confirm component activity tracking.

  4. Navigate to Analytics  Security insights:

    1. Verify security scan results populate.

    2. Check vulnerability trend analysis.

    3. Confirm scan type categorization.

  5. Navigate to Analytics  Test insights:

    1. Verify test execution data displays.

    2. Check test failure analysis.

    3. Confirm test suite performance tracking.

Troubleshoot data collection issues

Address common analytics data collection problems:

Problem: DORA metrics show no deployment data

Solution: Verify workflow steps include kind: deploy annotations and specify target environments. Check that environments are configured and associated with components.

Problem: Flow metrics display incomplete data

Solution: Confirm Jira integration is active and analytics configuration maps issue types correctly. Verify commit messages include Jira issue keys for correlation.

Problem: Security insights show no scan results

Solution: Check that security scanners publish results in supported formats and that workflow runs complete successfully. Verify scanner configuration and output formatting.

Problem: Test insights display no test data

Solution: Confirm test result publishing actions are configured in workflows and that test executions generate supported result formats.

Maintain analytics data quality

Establish ongoing practices to ensure analytics dashboards provide accurate performance insights.

Monitor integration health

Regular monitoring prevents analytics data gaps from integration failures.

  1. Check integration status weekly in Configurations  Integrations.

  2. Monitor integration connection health indicators.

  3. Refresh authentication credentials before expiration.

  4. Update integration configurations when external tools change.

Set up notifications for integration failures to address data collection issues promptly.

Update analytics configuration

Analytics configuration requires maintenance as Jira projects and workflow patterns evolve. To maintain analytics configuration:

  1. Review flow item mappings quarterly:

    1. Verify Jira issue types remain correctly categorized.

    2. Add mappings for new issue types.

    3. Update status mappings as workflow processes change.

  2. Expand analytics scope to new components and teams:

    1. Configure analytics settings for new components.

    2. Add environment associations for new deployment targets.

    3. Extend integration coverage to additional repositories.

Regular configuration updates ensure analytics accuracy as your development practices evolve.