Statistics Reporting

Version greater than or equal to v0.88.0

SigNoz reports non-sensitive information that helps us understand how the community uses SigNoz - such as which versions you're on, which features matter, and where we should focus on improvements and fixes. It's the best signal we have for prioritizing bug fixes, documentation, and new capabilities.

We keep this information minimal and do not record any sensitive user traffic, queries, or payloads. The only data we collect is listed below - nothing more, nothing less.

The information is collected by statsreporter and is enabled by default, managed by the following configuration in the SigNoz Configuration:

##################### StatsReporter #####################
statsreporter:
  # Whether to enable stats reporter. This is used to provide valuable insights to the SigNoz team. It does not collect any sensitive/PII data.
  enabled: true
  # The interval at which the stats are collected.
  interval: 6h
  collect:
    # Whether to collect identities and traits (emails).
    identities: true

When the stats reporter is enabled, SigNoz collects the following information at an interval specified in the configuration:

  • Details regarding the environment where SigNoz is running
    • The deployment platform, such as GCP, etc., where SigNoz is deployed
    • The operating system, such as Linux, etc.
    • The system architecture, such as AMD, etc.
  • Information regarding the SigNoz cluster and version
    • The build version of SigNoz, such as v0.88.0, etc.
    • The git branch used for the build, such as main, etc.
    • The build variant of SigNoz, such as Community Edition or Enterprise
    • The deployment method used for installation, such as Docker, Kubernetes, etc.
  • Details about the scope at which SigNoz is running:
    • The number of dashboards, panels, saved views, alerts, and users
    • The volume of logs, traces, and metrics ingested
    • SigNoz does not collect the actual queries or user requests
  • When identities is enabled in the statsreporter configuration, we collect the identities and traits (emails).
Info

The SigNoz team continually reviews this aggregated telemetry and promises to notify the community in advance of any changes, including additions or removals, to the data we collect.

Disable the statistics reporting

Info

If possible, we kindly ask you to keep the usage reporting feature enabled, as it helps us better understand how the open source community runs SigNoz.

In case you want to opt out, we request you to disable the identities, which will stop collecting traits or personally identifiable information (PII) and will only send information about the Environment, Scale, and Version anonymously. You can set the following configuration for this:

statsreporter:
  enabled: true
  collect:
    identities: false

Please keep the usage reporting feature enabled if possible, as it helps us learn more about how the open source community uses SigNoz. To entirely disable statistics collection, you can turn off the statsreporter by adjusting the configuration.

statsreporter:
  enabled: false
Version less than 0.88.0

Version less than v0.88.0

The following telemetry collection has been removed in versions greater than 0.87.0. Please check the Github Issue for more information.

Docker Installation

During the installation process, we collect stats of which installations were successful, which were unsuccessful and need our help. This is used to analyze the following:

  • Installation Started
  • Installation Success
  • Installation Errors
  • Installation Support

Sample Event

{
  "anonymousId": "57348733c8f3310a27ca6e07149d3a64d17e66ac",
  "event": "Installation Success",
  "integrations": {},
  "messageId": "api-25CYlWEssuKD6V2H9f393QQ515h",
  "properties": {
    "os": "Mac",
    "setup_type": "clickhouse"
  },
  "receivedAt": "2022-02-16T17:31:26.365Z",
  "timestamp": "2022-02-16T17:31:26.365Z",
  "type": "track"
}

SigNoz Server

The SigNoz backend server sends a keep-alive ping every 6 hours to indicate that it is still running without any errors. We also send some metrics around usage like the number of spans and timeseries to understand the scale at which SigNoz is being deployed and hence helps us to proactively run benchmarks on a similar scale and fix any performance issues that users might be facing.

Sample event

{
  "event": "Heart Beat",
  "integrations": {},
  "messageId": "61b423f7-3faa-4ed8-9be0-2b1f58b5bfde",
  "originalTimestamp": "2022-02-16T17:26:21.680714337Z",
  "properties": {
      "deploymentType": "kubernetes-helm",
      "getSamplesInfoInLastHeartBeatInterval": 94297,
      "maxTS": 2527,
      "spansInLastHeartBeatInterval": 774662,
      "totalSpans": 9328025,
      "totalTS": 3702,
      "version": "v0.9.2"
  },
  "receivedAt": "2022-02-16T17:26:26.665Z",
  "sentAt": "2022-02-16T17:26:25.490Z",
  "timestamp": "2022-02-16T17:26:22.855Z",
  "type": "track",
  "userId": "49.207.216.180",
}

SigNoz UI

You can anonymize the following data during the setup process.

SigNoz UI captures behavioral data around navigation, clicks and the total number of services. No data about your services or payload is captured.

Sample Event

{
  "event": "API Call",
  "integrations": {},
  "messageId": "d7c5d487-798f-4116-bdfc-804bffbd679c",
  "originalTimestamp": "2022-02-11T18:11:07.195662884Z",
  "properties": {
    "path": "/api/v1/rules",
    "version": "v0.6.1"
  },
  "receivedAt": "2022-02-11T18:11:10.044Z",
  "sentAt": "2022-02-11T18:11:09.971Z",
  "timestamp": "2022-02-11T18:11:07.267Z",
  "type": "track",
  "userId": "73.188.32.135"
}

Disable Telemetry

Set the below env variable in query-service in docker-compose.yaml or helm chart and restart query-service

TELEMETRY_ENABLED=false

Was this page helpful?