diff --git a/quickstart/configure-mayastor.md b/quickstart/configure-mayastor.md index aa143f0..7cd4449 100644 --- a/quickstart/configure-mayastor.md +++ b/quickstart/configure-mayastor.md @@ -47,7 +47,7 @@ Using one or more the following examples as templates, create the required type {% tab title="Example DiskPool definition" %} ```text cat <` with the appropriate Kubernetes namespace where Mayastor is deployed. + +``` +kubectl mayastor upgrade -n --set-args 'io_engine.coreList={3,4}' ``` +In the above command, `io_engine.coreList={3,4}` specifies that Mayastor's reactors should operate on the third and fourth CPU cores. \ No newline at end of file diff --git a/quickstart/troubleshooting.md b/quickstart/troubleshooting.md index a68baa4..8bee2f5 100644 --- a/quickstart/troubleshooting.md +++ b/quickstart/troubleshooting.md @@ -295,3 +295,20 @@ Thread 1 (Thread 0x7f782559f040 (LWP 56)): {% endtab %} {% endtabs %} +------------- + +## Diskpool behaviour + +The below behaviour may be encountered while uprading from older releases to Mayastor 2.4 release and above. + +### Get Dsp + +Running `kubectl get dsp -n mayastor` could result in the error due to the `v1alpha1` schema in the discovery cache. To resolve this, run the command `kubectl get diskpools.openebs.io -n mayastor`. After this kubectl discovery cache will be updated with `v1beta1` object for dsp. + +### Create API + +When creating a Disk Pool with `kubectl create -f dsp.yaml`, you might encounter an error related to `v1alpha1` CR definitions. To resolve this, ensure your CR definition is updated to `v1beta1` in the YAML file (for example, `apiVersion: openebs.io/v1beta1`). + +{% hint style="note" %} +You can validate the schema changes by executing `kubectl get crd diskpools.openebs.io`. +{% endhint %} diff --git a/reference/call-home.md b/reference/call-home.md index c348da6..1c26163 100644 --- a/reference/call-home.md +++ b/reference/call-home.md @@ -1,15 +1,14 @@ # Call-home metrics - By default, Mayastor collects some 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. +## Mayastor default information collection -{% hint style="info" %} +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. +{% hint style="info" %} No user-identifiable information, hostnames, passwords, or volume data are collected. **ONLY** the below-mentioned information is collected from the cluster. - {% endhint %} - -A summary of the information collected is given below. +A summary of the information collected is given below: | **Cluster information** | | :--- | @@ -20,9 +19,6 @@ A summary of the information collected is given below. |**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.| @@ -30,10 +26,8 @@ A summary of the information collected is given below. |**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**| | :--- | @@ -41,9 +35,8 @@ A summary of the information collected is given below. |**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**| | :--- | @@ -51,10 +44,29 @@ A summary of the information collected is given below. |**Average replica count per volume**: This is the average number of replicas each Mayastor Volume has in your cluster.| -### How to disable the collection of usage data +### 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 -To disable the collection of data metrics from the cluster, add `--set obs.callhome.enabled=false` flag to the Helm install command. The Helm command, along with the flag, can either be executed during installation or can be re-executed post-installation. +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. -### Where is the collected data stored? +``` +--set eventing.enabled=false +``` -The collected information is stored on behalf of the OpenEBS project by DataCore Software Inc. in data centers located in Texas, USA. \ No newline at end of file diff --git a/reference/monitoring.md b/reference/monitoring.md index de3f377..e0815a7 100644 --- a/reference/monitoring.md +++ b/reference/monitoring.md @@ -4,7 +4,7 @@ The Mayastor pool metrics exporter runs as a sidecar container within every io-engine pod and exposes pool usage metrics in Prometheus format. These metrics are exposed on port 9502 using an HTTP endpoint /metrics and are refreshed every five minutes. -### Supported metrics +### Supported pool metrics | Name | Type | Unit | Description | | :--- | :--- | :--- | :--- | @@ -31,7 +31,27 @@ disk_pool_committed_size_bytes{node="worker-0", name="mayastor-disk-pool"} 96636 {% endtab %} -### Integrating exporter with Prometheus monitoring stack + +-------- + +## Stats exporter metrics + +When [eventing](reference/call-home.md) is activated, the stats exporter operates within the **obs-callhome-stats** container, located in the **callhome** pod. The statistics are made accessible through an HTTP endpoint at port `9090`, specifically using the `/stats` route. + + +### Supported stats metrics + +| Name | Type | Unit | Description | +| :--- | :--- | :--- | :--- | +| pools_created | Guage | Integer | Total successful pool creation attempts | +| pools_deleted | Guage | Integer | Total successful pool deletion attempts | +| volumes_created | Guage | Integer | Total successful volume creation attemtps | +| volumes_deleted | Guage | Integer | Total successful volume deletion attempts | + + +---- + +## Integrating exporter with Prometheus monitoring stack 1. To install, add the Prometheus-stack helm chart and update the repo. @@ -73,6 +93,7 @@ spec: Upon successful integration of the exporter with the Prometheus stack, the metrics will be available on the port 9090 and HTTP endpoint /metrics. {% endhint %} +--- ## CSI metrics exporter