> ## Documentation Index
> Fetch the complete documentation index at: https://sourcebot-michael-docker-registry-domain.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Service Ping

<Note>
  No sensitive data (source code, AI inputs/outputs, credentials, user information, etc) is ever transmitted.
</Note>

By default, all Sourcebot deployments will send a Service Ping, which is an HTTPS encrypted ping to `https://deployments.sourcebot.dev/ping` at port 443, every 24 hours.

The data contained within the Service Ping is limited to:

| Field                       | Type      | Description                                                         |
| --------------------------- | --------- | ------------------------------------------------------------------- |
| `installId`                 | `string`  | Random UUID generated for your deployment.                          |
| `hostname`                  | `string`  | Hostname of your Sourcebot deployment.                              |
| `version`                   | `string`  | Sourcebot version (e.g. `v5.3.0`).                                  |
| `userCount`                 | `integer` | Total registered users.                                             |
| `repoCount`                 | `integer` | Total indexed repositories.                                         |
| `dauCount`                  | `integer` | Daily active users.                                                 |
| `wauCount`                  | `integer` | Weekly active users.                                                |
| `mauCount`                  | `integer` | Monthly active users.                                               |
| `deploymentType`            | `string`  | Deployment flavor (e.g. `docker`, `helm`).                          |
| `isTelemetryEnabled`        | `boolean` | Whether anonymous product telemetry is enabled.                     |
| `isLanguageModelConfigured` | `boolean` | Whether at least one language model is configured.                  |
| `activationCode`            | `string`  | Activation code, if your instance has one bound.                    |
| `systemInfo`                | `object`  | Resource facts about the deployment (CPU, memory, disk). See below. |

The `systemInfo` object contains a best-effort snapshot of the resources the deployment is running with. It is used to diagnose resource issues (e.g. insufficient RAM). Any field that cannot be read is reported as `null`.

| Field            | Type             | Description                                                  |
| ---------------- | ---------------- | ------------------------------------------------------------ |
| `platform`       | `string`         | Operating system platform (e.g. `linux`).                    |
| `arch`           | `string`         | CPU architecture (e.g. `x64`, `arm64`).                      |
| `cpuQuota`       | `number \| null` | Effective cgroup CPU limit in cores, or `null` if unlimited. |
| `memoryLimitMiB` | `number \| null` | cgroup memory limit in MiB, or `null` if unlimited.          |
| `memoryUsedMiB`  | `number \| null` | Current cgroup memory usage, in MiB.                         |
| `diskTotalMiB`   | `number \| null` | Total disk space for the data volume, in MiB.                |
| `diskFreeMiB`    | `number \| null` | Free disk space for the data volume, in MiB.                 |

You can fetch the schema for the Service Ping by submitting a GET request to `https://deployments.sourcebot.dev/schema`

```json wrap icon="wifi" Example Service Ping theme={null}
{
  "method": "POST",
  "url": "http://localhost:3003/ping",
  "path": "/ping",
  "headers": {
    "accept": "*/*",
    "accept-encoding": "gzip, deflate",
    "accept-language": "*",
    "connection": "keep-alive",
    "content-length": "253",
    "content-type": "application/json",
    "host": "localhost:3003",
    "sec-fetch-mode": "cors",
    "user-agent": "node"
  },
  "query": {}
}
body: {
  "installId": "524a8f59-90aa-480d-a571-92dd8bzzzzze",
  "version": "v4.17.2",
  "userCount": 1,
  "repoCount": 3,
  "dauCount": 1,
  "wauCount": 1,
  "mauCount": 1,
  "deploymentType": "other",
  "isTelemetryEnabled": true,
  "isLanguageModelConfigured": true,
  "systemInfo": {
    "platform": "linux",
    "arch": "x64",
    "cpuQuota": 4,
    "memoryLimitMiB": 8192,
    "memoryUsedMiB": 3072,
    "diskTotalMiB": 102400,
    "diskFreeMiB": 54968
  },
  "activationCode": "sb_act_3a925f51...."
}
```