Configuring the CloudBees Analytics server

4 minute readDeveloper productivityData analytics

After the installation is complete, the following items are created during the first server startup:

  • The CloudBees Software Delivery Automation license to grant access to CloudBees CD/RO data and the API that is required to pull and view CloudBees Analytics data.

    To view licenses, from the CloudBees navigation, select CD/RO. In the left pane, go to Administration ConfigurationsLicenses.

  • The CloudBees Software Delivery Automation persona menu items, configured for the CloudBees Analytics context.

    To view personas, in the left pane, go to Administration ServerPersonas.

  • An admin user that has the CloudBees Software Delivery Automation persona and license associated with it.

    For traditional platforms, the default password for the admin user is changeme. For Kubernetes installations, a random initial password is created.

Ensuring that the CloudBees Analytics server is active

To ensure that your dashboards start to populate with data, you must make sure that the CloudBees Analytics server is installed.

  1. From the CloudBees navigation, ensure Analytics is active.

If it is not active, click Learn more for licensing information.

Setting up connectivity and authentication

Once you have installed the CloudBees Analytics server you need to set up connectivity and authentication. The data that populates the dashboards is transmitted from CloudBees CI to the CloudBees CD/RO server, and then on to the CloudBees Analytics server.

The CloudBees Analytics server uses the Elasticsearch search engine and the Logstash data-collection and log-parsing engine to gather data from the CloudBees CD/RO server. This data is used by the Workload Insights and Plugin Usage dashboards.

Only the data that is created or updated in CloudBees Software Delivery Automation after you configure CloudBees Analytics is synced with the CloudBees Analytics server.

This restriction does not apply to existing data that CloudBees Software Delivery Automation does not create or update. For example, data collected using plugins from external systems such as Jira or HP ALM.

To configure the CloudBees Analytics server:

  1. From the CloudBees navigation, select CD/RO.

  2. Select Administration Configurations, and then select Analytics Server.

  3. Use the following settings to set up connectivity and authentication.

    Checkbox or fieldDescription

    Enable CloudBees Analytics

    Specifies whether to enable CloudBees Analytics. This is enabled by default.

    URL for Logstash service on the CloudBees Analytics server

    URL where Logstash receives data from the CloudBees Software Delivery Automation server. This is required if CloudBees Analytics is enabled.

    URL for Elasticsearch service on the CloudBees Analytics server

    URL where the CloudBees Software Delivery Automation server retrieves data from Elasticsearch. This is required if CloudBees Analytics is enabled.

    Authentication Credentials

    User name and password for authenticating with the CloudBees Analytics server. The default user name is reportuser. Use the password that was defined during CloudBees Analytics installation.

    Test Connection

    (Optional) Specifies whether to test the connection to the CloudBees Analytics server before you save the configuration. This is disabled by default.

  4. Click Save.

Registering the CloudBees CI URL

This section only applies to CloudBees CI users adding CloudBees Analytics.

To register the CloudBees CI URL:

  1. From the CloudBees navigation, select CD/RO.

  2. Select Administration Configurations.

  3. In the left pane, select CI configurations.

  4. Under CloudBees CI operations center configurations, click New +.

  5. On the New CI configuration screen, Create New CI Configuration.

    • Enter a name and a description.

    • Under Configuration type, select CloudBees CI operations center.

    • In Server URL, type the URL of the CloudBees CI server. Be sure this is the complete URL of the Operations Center. You should be able to visit the URL and see the Operations Center dashboard. A connectivity check is not performed.

  6. Click OK.

Once the Operations Center configuration is created (automatically or manually), data received from connected controllers is processed in CloudBees Analytics after a one-time verification of the connected controller. This requires the CloudBees CD/RO server to make a connection to the Operations Center, as well as to the connected controller, to verify its identity. In case CloudBees CD/RO cannot communicate with either instance—​the Operations Center or a connected controller—​for any reason such as network topology or self-signed certificate verification, this verification fails. The solution in this case is Creating a CloudBees CI configuration manually.

Creating a CloudBees CI configuration manually

To manually create CloudBees CI configurations for the controllers and to register their public keys, use the following command.

  • For traditional installations:

     ectool createCIConfiguration <controller-name-to-use-as-ci-config-name> \
            --ciConfigurationType CI_CONTROLLER --serverUrl <controller-url> \
            --publicKey $(curl -Iks <controller-url>instance-identity/ | \
            fgrep X-Instance-Identity | cut -d' ' -f2)
  • For modern installations (Kubernetes cluster environments):

    kubectl exec deploy/flow-server -- \
            ectool createCIConfiguration <controller-name-to-use-as-ci-config-name> \
                   --ciConfigurationType CI_CONTROLLER \
                   --serverUrl <controller-url> \
                   --publicKey $(curl -Iks <controller-url>instance-identity/ | \
                   fgrep X-Instance-Identity | cut -d' ' -f2)

Learn about using ectool here.

Setting up the connection to CloudBees Software Delivery Automation in CloudBees CI

This procedure is required only in the following situations:

  • CloudBees CI on traditional platforms is installed.

  • You installed CloudBees CI on modern cloud platforms, but omitted ci.OperationsCenter.Hostname.

To enable CloudBees CI to send analytics events, set up the connection between CloudBees Software Delivery Automation and CloudBees CI:

  1. From the CloudBees navigation, select CI.

  2. Select Manage Jenkins Configure System, and then scroll down to Connection to CloudBees Software Delivery Automation.

  3. In URL of the CloudBees Software Delivery Automation server, enter the URL for the CloudBees Software Delivery Automation server. For example, https://your.hostname/.

  4. Select Allow analytics events to be sent.

  5. Skip the remaining fields.

  6. Click Save.