Skip to content

Commit 81f32da

Browse files
aishwarya24aishwarya24
authored
[DOC-535] [YBA] [2024.2] Support bundle phase 3 (yugabyte#24708)
* support bundle phase 3 * renamed component as its in the UI * review comments * review comments * more review comments
1 parent ae0af56 commit 81f32da

File tree

4 files changed

+100
-55
lines changed

4 files changed

+100
-55
lines changed

‎docs/content/preview/yugabyte-platform/troubleshoot/universe-issues.md‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -104,25 +104,25 @@ The focus is to ensure that support bundle generation is successful in most case
104104

105105
You can create a support bundle as follows:
106106

107-
- Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
107+
1. Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
108108

109-
- If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
109+
1. If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
110110

111-
![Create support bundle](/images/yp/support-bundle-1.png)
111+
![Create support bundle](/images/yp/support-bundle-1.png)
112112

113-
- Select the date range and the types of files to be included in the bundle, as per the following illustration:
113+
1. Select the date range and the types of files to be included in the bundle, as per the following illustration:
114114

115-
![Create support bundle](/images/yp/support-bundle-2.png)
115+
![Create support bundle](/images/yp/support-bundle-2.png)
116116

117-
For information about the components, see [Support bundle components](#support-bundle-components).
117+
For information about the components, see [Support bundle components](#support-bundle-components).
118118

119-
- Click **Create Bundle**.
119+
1. Click **Create Bundle**.
120120

121-
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
121+
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
122122

123-
![Create support bundle](/images/yp/support-bundle-3.png)
123+
![Create support bundle](/images/yp/support-bundle-3.png)
124124

125-
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
125+
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
126126

127127
### Support bundle components
128128

@@ -135,7 +135,9 @@ Logs generated by YBA.
135135

136136
#### YBA Metadata
137137

138-
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward. Following are the included metadata sub-components in this phase:
138+
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward.
139+
140+
This metadata includes the following:
139141

140142
- Customer metadata
141143
- Cloud providers metadata
@@ -190,18 +192,15 @@ Node agent logs generated in the YugabyteDB nodes (if node agent is enabled).
190192

191193
#### Core Files
192194

193-
The Core Files component collects all the core files and mitigates two issues that may happen when collecting files such as the following:
194-
195-
- Files can be very large (for example, 200GB+)
196-
- There can be a huge number of files (for example, when a crashloop happens)
195+
If you select the Core Files option (the default), the support bundle will include all core files generated within the specified date range.
197196

198-
When you create a support bundle, if you select the Core Files component (by default, the component is selected), there are two optional Core files properties:
197+
When the Core Files option is selected, you can specify the following additional options:
199198

200-
- Maximum number of recent core files: YugabyteDB Anywhere (YBA) collects the most recent "N" number of files. "N" is set to a default value of collecting 1 file.
199+
- Maximum number of recent core files: In some instances (for example, when a crashloop happens), there can be a large number of files. Specify the maximum number of files to include; YugabyteDB Anywhere collects the most recent files up to this value (default is 1).
201200

202-
- Maximum core file size: This field collects the recent core files only if the core file size is below the specified size limit. It is set to a default value of 25000000000 bytes (25GB).
201+
- Maximum core file size: Specify the maximum file size for core files to be collected, in bytes. Only core files smaller than the specified size are collected (default is 25000000000 bytes (25GB)).
203202

204-
YBA also provides a runtime flag `yb.support_bundle.allow_cores_collection`, which is used to globally disable cores collection across any new support bundles generated on the platform. This flag can only be set by the SuperAdmin and is true by default.
203+
You can disable core collection globally by setting the global runtime configuration flag `yb.support_bundle.allow_cores_collection` to false. You must be a Super Admin to set global runtime configuration flags.
205204

206205
#### YB-Controller logs
207206

‎docs/content/stable/yugabyte-platform/troubleshoot/universe-issues.md‎

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -101,25 +101,25 @@ The focus is to ensure that support bundle generation is successful in most case
101101

102102
You can create a support bundle as follows:
103103

104-
- Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
104+
1. Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
105105

106-
- If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
106+
1. If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
107107

108-
![Create support bundle](/images/yp/support-bundle-1.png)
108+
![Create support bundle](/images/yp/support-bundle-1.png)
109109

110-
- Select the date range and the types of files to be included in the bundle, as per the following illustration:
110+
1. Select the date range and the types of files to be included in the bundle, as per the following illustration:
111111

112-
![Create support bundle](/images/yp/support-bundle-2.png)
112+
![Create support bundle](/images/yp/support-bundle-2.png)
113113

114-
For information about the components, see [Support bundle components](#support-bundle-components).
114+
For information about the components, see [Support bundle components](#support-bundle-components).
115115

116-
- Click **Create Bundle**.
116+
1. Click **Create Bundle**.
117117

118-
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
118+
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
119119

120-
![Create support bundle](/images/yp/support-bundle-3.png)
120+
![Create support bundle](/images/yp/support-bundle-3.png)
121121

122-
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
122+
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
123123

124124
### Support bundle components
125125

@@ -132,14 +132,20 @@ Logs generated by YBA.
132132

133133
#### YBA Metadata
134134

135-
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward. Following are the included metadata sub-components in this phase:
135+
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward.
136+
137+
This metadata includes the following:
136138

137139
- Customer metadata
138140
- Cloud providers metadata
139141
- Universes metadata
140142
- Users metadata
141143
- Instance_type metadata (sizing info, cores)
142144
- Customer_task table metadata
145+
- Audit logs
146+
- High availability metadata
147+
- xCluster metadata
148+
- Tasks metadata
143149

144150
An example of the YBA metadata directory structure is as follows:
145151

@@ -187,18 +193,19 @@ Node agent logs generated in the YugabyteDB nodes (if node agent is enabled).
187193

188194
#### Core Files
189195

190-
The Core Files component collects all the core files and mitigates two issues that may happen when collecting files such as the following:
196+
If you select the Core Files option (the default), the support bundle will include all core files generated within the specified date range.
197+
198+
When the Core Files option is selected, you can specify the following additional options:
191199

192-
- Files can be very large (for example, 200GB+)
193-
- There can be a huge number of files (for example, when a crashloop happens)
200+
- Maximum number of recent core files: In some instances (for example, when a crashloop happens), there can be a large number of files. Specify the maximum number of files to include; YugabyteDB Anywhere collects the most recent files up to this value (default is 1).
194201

195-
When you create a support bundle, if you select the Core Files component (by default, the component is selected), there are two optional Core files properties:
202+
- Maximum core file size: Specify the maximum file size for core files to be collected, in bytes. Only core files smaller than the specified size are collected (default is 25000000000 bytes (25GB)).
196203

197-
- Maximum number of recent core files: YugabyteDB Anywhere (YBA) collects the most recent "N" number of files. "N" is set to a default value of collecting 1 file.
204+
You can disable core collection globally by setting the global runtime configuration flag `yb.support_bundle.allow_cores_collection` to false. You must be a Super Admin to set global runtime configuration flags.
198205

199-
- Maximum core file size: This field collects the recent core files only if the core file size is below the specified size limit. It is set to a default value of 25000000000 bytes (25GB).
206+
#### Manifest file
200207

201-
YBA also provides a runtime flag `yb.support_bundle.allow_cores_collection`, which is used to globally disable cores collection across any new support bundles generated on the platform. This flag can only be set by the SuperAdmin and is true by default.
208+
The `manifest.json` file, which contains the parameters that were used to create the support bundle.
202209

203210
#### YB-Controller logs
204211

@@ -231,6 +238,22 @@ Note that YBA will only collect files if you have sufficient permissions to requ
231238
- Statefulsets.yaml
232239
- Persistentvolumeclaims.yaml
233240

241+
#### Prometheus metrics
242+
243+
The Prometheus metrics for the selected universe. You can customize the timeframe and the metrics to collect.
244+
245+
You can include the following metrics with the support bundle:
246+
247+
- Master Export - YB-Master metrics.
248+
- Node Export - System-level metrics for various hardware and OS parameters, such as CPU, memory, disk, and network usage, collected by Prometheus Node Exporter.
249+
- Platform - YugabyteDB Anywhere metrics.
250+
- Prometheus - metrics for Prometheus.
251+
- TServer Export - YB-TServer metrics; these are scraped from the TServer processes, and mostly cover the storage layer.
252+
- YSQL Export - YSQL query layer metrics.
253+
- YCQL Export - YCQL query layer metrics.
254+
255+
The Prometheus metrics are stored in JSON files in the `support_bundle/YBA/promdump` directory.
256+
234257
</details>
235258

236259
## Debug crashing YugabyteDB pods in Kubernetes

‎docs/content/v2024.2/yugabyte-platform/troubleshoot/universe-issues.md‎

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -101,25 +101,25 @@ The focus is to ensure that support bundle generation is successful in most case
101101

102102
You can create a support bundle as follows:
103103

104-
- Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
104+
1. Open the universe that needs to be diagnosed and click **Actions > Support Bundles**.
105105

106-
- If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
106+
1. If the universe already has support bundles, they are displayed by the **Support Bundle** dialog. If there are no bundles for the universe, use the **Support Bundles** dialog to generate a bundle by clicking **Create Support Bundle**, as per the following illustration:
107107

108-
![Create support bundle](/images/yp/support-bundle-1.png)
108+
![Create support bundle](/images/yp/support-bundle-1.png)
109109

110-
- Select the date range and the types of files to be included in the bundle, as per the following illustration:
110+
1. Select the date range and the types of files to be included in the bundle, as per the following illustration:
111111

112-
![Create support bundle](/images/yp/support-bundle-2.png)
112+
![Create support bundle](/images/yp/support-bundle-2.png)
113113

114-
For information about the components, see [Support bundle components](#support-bundle-components).
114+
For information about the components, see [Support bundle components](#support-bundle-components).
115115

116-
- Click **Create Bundle**.
116+
1. Click **Create Bundle**.
117117

118-
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
118+
YugabyteDB Anywhere starts collecting files from all the nodes in the cluster into an archive. Note that this process might take several minutes. When finished, the bundle's status is displayed as **Ready**, as per the following illustration:
119119

120-
![Create support bundle](/images/yp/support-bundle-3.png)
120+
![Create support bundle](/images/yp/support-bundle-3.png)
121121

122-
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
122+
The **Support Bundles** dialog allows you to either download the bundle or delete it if it is no longer needed. By default, bundles expire after ten days to free up space.
123123

124124
### Support bundle components
125125

@@ -132,14 +132,20 @@ Logs generated by YBA.
132132

133133
#### YBA Metadata
134134

135-
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward. Following are the included metadata sub-components in this phase:
135+
This component collects a fingerprint of the YBA data. The metadata is collected at a customer level, rather than a global level (like [PG_dump](https://support.yugabyte.com/hc/en-us/articles/4412743193741-How-to-create-a-credential-free-dump-of-YugabyteDB-Anywhere-Database)) to ensure multi-tenancy is respected going forward.
136+
137+
This metadata includes the following:
136138

137139
- Customer metadata
138140
- Cloud providers metadata
139141
- Universes metadata
140142
- Users metadata
141143
- Instance_type metadata (sizing info, cores)
142144
- Customer_task table metadata
145+
- Audit logs
146+
- High availability metadata
147+
- xCluster metadata
148+
- Tasks metadata
143149

144150
An example of the YBA metadata directory structure is as follows:
145151

@@ -187,18 +193,19 @@ Node agent logs generated in the YugabyteDB nodes (if node agent is enabled).
187193

188194
#### Core Files
189195

190-
The Core Files component collects all the core files and mitigates two issues that may happen when collecting files such as the following:
196+
If you select the Core Files option (the default), the support bundle will include all core files generated within the specified date range.
197+
198+
When the Core Files option is selected, you can specify the following additional options:
191199

192-
- Files can be very large (for example, 200GB+)
193-
- There can be a huge number of files (for example, when a crashloop happens)
200+
- Maximum number of recent core files: In some instances (for example, when a crashloop happens), there can be a large number of files. Specify the maximum number of files to include; YugabyteDB Anywhere collects the most recent files up to this value (default is 1).
194201

195-
When you create a support bundle, if you select the Core Files component (by default, the component is selected), there are two optional Core files properties:
202+
- Maximum core file size: Specify the maximum file size for core files to be collected, in bytes. Only core files smaller than the specified size are collected (default is 25000000000 bytes (25GB)).
196203

197-
- Maximum number of recent core files: YugabyteDB Anywhere (YBA) collects the most recent "N" number of files. "N" is set to a default value of collecting 1 file.
204+
You can disable core collection globally by setting the global runtime configuration flag `yb.support_bundle.allow_cores_collection` to false. You must be a Super Admin to set global runtime configuration flags.
198205

199-
- Maximum core file size: This field collects the recent core files only if the core file size is below the specified size limit. It is set to a default value of 25000000000 bytes (25GB).
206+
#### Manifest file
200207

201-
YBA also provides a runtime flag `yb.support_bundle.allow_cores_collection`, which is used to globally disable cores collection across any new support bundles generated on the platform. This flag can only be set by the SuperAdmin and is true by default.
208+
The `manifest.json` file, which contains the parameters that were used to create the support bundle.
202209

203210
#### YB-Controller logs
204211

@@ -231,6 +238,22 @@ Note that YBA will only collect files if you have sufficient permissions to requ
231238
- Statefulsets.yaml
232239
- Persistentvolumeclaims.yaml
233240

241+
#### Prometheus metrics
242+
243+
The Prometheus metrics for the selected universe. You can customize the timeframe and the metrics to collect.
244+
245+
You can include the following metrics with the support bundle:
246+
247+
- Master Export - YB-Master metrics.
248+
- Node Export - System-level metrics for various hardware and OS parameters, such as CPU, memory, disk, and network usage, collected by Prometheus Node Exporter.
249+
- Platform - YugabyteDB Anywhere metrics.
250+
- Prometheus - metrics for Prometheus.
251+
- TServer Export - YB-TServer metrics; these are scraped from the TServer processes, and mostly cover the storage layer.
252+
- YSQL Export - YSQL query layer metrics.
253+
- YCQL Export - YCQL query layer metrics.
254+
255+
The Prometheus metrics are stored in JSON files in the `support_bundle/YBA/promdump` directory.
256+
234257
</details>
235258

236259
## Debug crashing YugabyteDB pods in Kubernetes

‎docs/static/images/yp/support-bundle-2.png‎

11.7 KB
Loading

0 commit comments

Comments
 (0)