Call-home Metrics

This website/page will be End-of-life (EOL) after 31 August 2024. We recommend you to visit OpenEBS Documentation for the latest Mayastor documentation (v2.6 and above).

Mayastor is now also referred to as OpenEBS Replicated PV Mayastor.

Mayastor default information collection

By default, Mayastor collects basic information related to the number and scale of user-deployed instances. The collected data is anonymous and is encrypted at rest. This data is used to understand storage usage trends, which in turn helps maintainers prioritize their contributions to maximize the benefit to the community as a whole.

No user-identifiable information, hostnames, passwords, or volume data are collected. ONLY the below-mentioned information is collected from the cluster.

A summary of the information collected is given below:

Cluster information

K8s cluster ID: This is a SHA-256 hashed value of the UID of your Kubernetes cluster's kube-system namespace.

K8s node count: This is the number of nodes in your Kubernetes cluster.

Product name: This field displays the name Mayastor

Product version: This is the deployed version of Mayastor.

Deploy namespace: This is a SHA-256 hashed value of the name of the Kubernetes namespace where Mayastor Helm chart is deployed.

Storage node count: This is the number of nodes on which the Mayastor I/O engine is scheduled.

Pool information

Pool count: This is the number of Mayastor DiskPools in your cluster.

Pool maximum size: This is the capacity of the Mayastor DiskPool with the highest capacity.

Pool minimum size: This is the capacity of the Mayastor DiskPool with the lowest capacity.

Pool mean size: This is the average capacity of the Mayastor DiskPools in your cluster.

Pool capacity percentiles: This calculates and returns the capacity distribution of Mayastor DiskPools for the 50th, 75th and the 90th percentiles.

Pools created: This is the number of successful pool creation attempts.

Pools deleted: This is the number of successful pool deletion attempts.

Volume information

Volume count: This is the number of Mayastor Volumes in your cluster.

Volume minimum size: This is the capacity of the Mayastor Volume with the lowest capacity.

Volume mean size: This is the average capacity of the Mayastor Volumes in your cluster.

Volume capacity percentiles: This calculates and returns the capacity distribution of Mayastor Volumes for the 50th, 75th and the 90th percentiles.

Volumes created: This is the number of successful volume creation attempts.

Volumes deleted: This is the number of successful volume deletion attempts.

Replica Information

Replica count: This is the number of Mayastor Volume replicas in your cluster.

Average replica count per volume: This is the average number of replicas each Mayastor Volume has in your cluster.

Storage location of collected data

The collected information is stored on behalf of the OpenEBS project by DataCore Software Inc. in data centers located in Texas, USA.

---

Disable specific data collection

To disable collection of usage data or generation of events, the following Helm command, along with the flag, can either be executed during installation or can be re-executed post-installation.

Disable collection of usage data

To disable the collection of data metrics from the cluster, add the following flag to the Helm install command.

--set obs.callhome.enabled=false

Disable generation of events data

When eventing is enabled, NATS pods are created to gather various events from the cluster, including statistical metrics such as pools created. To deactivate eventing within the cluster, include the following flag in the Helm installation command.

--set eventing.enabled=false