IBM Bob
EnterpriseSelf-hosted

Usage metrics

Learn how IBM Bob reports usage metrics to IBM via the IBM Usage Metering Service and IBM Software Central.

IBM Bob uses the IBM Usage Metering Service (UMS) to collect and report usage metrics. UMS is configured automatically during installation.

What data is reported

Bob reports a single metric: the total number of active users. No user identities, prompts, code snippets, or behavioral data are collected or transmitted.

Obtaining the audit snapshot

To obtain the audit snapshot from UMS, follow the instructions in the IBM Foundational Services documentation.
Note:

The IBM Foundational Services documentation uses kubectl commands. When working with Red Hat OpenShift, use oc in place of kubectl.

Forwarding data to IBM Software Central

You can forward usage data from UMS to IBM Software Central in either online or offline mode.
Note:

IBM License Reporter is not required for Bob.

Online mode (connected clusters)

For clusters connected to the internet, UMS automatically forwards usage data to IBM Software Central on a 24-hour cadence at 12:05 AM UTC.

Offline mode (air-gapped clusters)

For air-gapped or disconnected environments, you must manually download the usage payload from UMS and upload it to IBM Software Central.

Download the usage payload from UMS:

curl \
  --header "Authorization: Bearer <UMS_TOKEN>" \
  --cacert ca.crt \
  --output swc_payload.tar.gz \
  "<UMS_URL>/api/v1/swc"

Where:

  • <UMS_TOKEN> is the token value from the ibm-usage-metering-upload-token secret.
  • <UMS_URL> is the Location value of the ibm-usage-metering-fetch route.
  • ca.crt is the CA certificate obtained while generating an audit snapshot.

Transfer swc_payload.tar.gz to a system with internet access and upload it to IBM Software Central:

curl -X POST \
  "https://swc.saas.ibm.com/metering/api/v2/metrics" \
  -H "Authorization: Bearer <IBM_ENTITLEMENT_KEY>" \
  -F "file=@swc_payload.tar.gz;type=application/gzip"

Where <IBM_ENTITLEMENT_KEY> is your IBM Entitlement Key.

Note:

For test uploads, use https://sandbox.swc.saas.ibm.com instead of the production endpoint.

After the upload completes, the reported usage data is available in IBM Software Central. An IBM Software Central account is required to view uploaded data. If you do not have one, register at swc.saas.ibm.com before your first upload.

How is this topic?

Managing entitlements

Learn how Bob self-hosted uses backend and frontend entitlements to control Premium Package deployment and user access.

Accessing Bob self-hosted

Connect bob-ide or bob-shell to an IBM Bob self-hosted deployment by configuring certificate trust, the client endpoint, and user authentication.

On this page

What data is reportedObtaining the audit snapshotForwarding data to IBM Software CentralOnline mode (connected clusters)Offline mode (air-gapped clusters)