Skip to content

Commit 450b426

Browse files
author
Alagappan21
committed
Format issues fixed in README.md document
1 parent ce14cf2 commit 450b426

File tree

1 file changed

+38
-31
lines changed

1 file changed

+38
-31
lines changed

README.md

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -42,33 +42,34 @@
4242
It's easy to get started with the yc-360 script. Just follow the simple steps given below. In a matter of seconds, you’ll be able to trigger the script and collect all the critical artifacts needed for troubleshooting.
4343

4444
<details>
45-
<summary><strong>Linux</storng></summary>
46-
**1. Download:** Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
45+
<summary><strong>Linux</storng></summary></br>
46+
47+
<strong>1. Download:</strong> Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip)
4748

48-
**2. Extract:** Unzip the package and navigate to the linux directory:
49+
<storng>2. Extract:</storng> Unzip the package and navigate to the linux directory:
4950

5051
```sh
5152
unzip yc-360-latest.zip
5253
cd linux
5354
```
5455

55-
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
56+
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
5657

5758
When you execute the below command, the yc-360 script will capture all the artifacts/logs from the target JVM & host for analysis. Captured artifacts will be compressed into a zip file and stored in the directory where the above command was executed. The zip file will have the name in the format: 'yc-YYYY-MM-DDTHH-mm-ss.zip'. **Example**: 'yc-2024-09-23T14-02-42.zip'.
5859

5960
```sh
6061
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
6162
```
6263

63-
**INFO:**
64+
<storng>INFO:</storng>
6465

6566
+ `{PID}`: This is the process ID of your Java application. Not sure how to find process Id? [Learn here](https://docs.ycrash.io/yc-360/faq/identifying-process.html). Alternatively, you can pass Unique Token that will uniquely identify the process in container. [What is Unique Token?](https://docs.ycrash.io/yc-360/faq/what-is-unique-token-in-process.html)
6667

6768
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
6869

6970
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
7071

71-
**IMPORTANT TIP:**
72+
<storng>IMPORTANT TIP:<storng>
7273

7374
+ The yc-360 script must be executed with the **same user privileges as the Java application**. For example, if the application runs under the `tomcat-user` user, yc-360 script must also be executed by `tomcat-user` user.
7475

@@ -78,33 +79,34 @@ When you execute the below command, the yc-360 script will capture all the artif
7879

7980
</details>
8081
<details>
81-
<summary><strong>MacOS</storng></summary>
82-
**1. Download:** Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
82+
<summary><strong>MacOS</storng></summary></br>
83+
84+
<storng>1. Download:</storng> Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
8385

84-
**2. Extract:** Unzip the package and navigate to the mac directory:
86+
<storng>2. Extract:</storng> Unzip the package and navigate to the mac directory:
8587

8688
```sh
8789
unzip yc-360-latest.zip
8890
cd mac
8991
```
9092

91-
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
93+
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
9294

9395
When you execute the below command, the yc-360 script will capture all the artifacts/logs from the target JVM & host for analysis. Captured artifacts will be compressed into a zip file and stored in the directory where the above command was executed. The zip file will have the name in the format: 'yc-YYYY-MM-DDTHH-mm-ss.zip'. **Example**: 'yc-2024-09-23T14-02-42.zip'.
9496

9597
```sh
9698
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
9799
```
98100

99-
**INFO:**
101+
<storng>INFO:</storng>
100102

101103
+ `{PID}`: This is the process ID of your Java application. Not sure how to find process Id? [Learn here](https://docs.ycrash.io/yc-360/faq/identifying-process.html). Alternatively, you can pass Unique Token that will uniquely identify the process in container. [What is Unique Token?](https://docs.ycrash.io/yc-360/faq/what-is-unique-token-in-process.html)
102104

103105
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
104106

105107
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
106108

107-
**IMPORTANT TIP:**
109+
<storng>IMPORTANT TIP:</storng>
108110

109111
+ The yc-360 script must be executed with the **same user privileges as the Java application**. For example, if the application runs under the `tomcat-user` user, yc-360 script must also be executed by `tomcat-user` user.
110112

@@ -115,32 +117,33 @@ When you execute the below command, the yc-360 script will capture all the artif
115117
</details>
116118

117119
<details>
118-
<summary><strong>Windows</storng></summary>
119-
**1. Download:** Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
120+
<summary><strong>Windows</storng></summary></br>
121+
122+
<storng>1. Download:</storng> Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
120123

121-
**2. Extract:** Unzip the package and navigate to the windows directory:
124+
<storng>2. Extract:</storng> Unzip the package and navigate to the windows directory:
122125

123126
```
124127
cd windows
125128
```
126129

127-
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
130+
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
128131

129132
When you execute the below command, the yc-360 script will capture all the artifacts/logs from the target JVM & host for analysis. Captured artifacts will be compressed into a zip file and stored in the directory where the above command was executed. The zip file will have the name in the format: 'yc-YYYY-MM-DDTHH-mm-ss.zip'. **Example**: 'yc-2024-09-23T14-02-42.zip'.
130133

131134
```sh
132135
.\yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
133136
```
134137

135-
**INFO:**
138+
<storng>INFO:</storng>
136139

137140
+ `{PID}`: This is the process ID of your Java application. Not sure how to find process Id? [Learn here](https://docs.ycrash.io/yc-360/faq/identifying-process.html). Alternatively, you can pass Unique Token that will uniquely identify the process in container. [What is Unique Token?](https://docs.ycrash.io/yc-360/faq/what-is-unique-token-in-process.html)
138141

139142
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
140143

141144
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
142145

143-
**IMPORTANT TIP:**
146+
<storng>IMPORTANT TIP:</storng>
144147

145148
+ The yc-360 script must be executed with the **same user privileges as the Java application**. For example, if the application runs under the `tomcat-user` user, yc-360 script must also be executed by `tomcat-user` user.
146149

@@ -150,7 +153,8 @@ When you execute the below command, the yc-360 script will capture all the artif
150153
</details>
151154

152155
<details>
153-
<summary><strong>Docker</storng></summary>
156+
<summary><strong>Docker</storng></summary></br>
157+
154158
You can run the yc-360 script in a Docker environment using one of the following approaches, depending on your deployment setup and monitoring preferences:
155159

156160
1. [Run yc-360 Script in Sidecar Container](https://docs.ycrash.io/yc-360/docker-container/deployment-options/run-yc-360-script-as-sidecar-container.html) – Run the script in a separate container alongside your application container.
@@ -161,7 +165,8 @@ You can run the yc-360 script in a Docker environment using one of the following
161165
</details>
162166

163167
<details>
164-
<summary><strong>Kubernetes</storng></summary>
168+
<summary><strong>Kubernetes</storng></summary></br>
169+
165170
You can run the yc-360 script in a Kubernetes environment using one of the following approaches, depending on your deployment setup and monitoring preferences:
166171

167172
1. [Run yc-360 Script in Sidecar Container](https://docs.ycrash.io/yc-360/kubernetes/deployment-options/run-as-sidecar-container.html) – Add yc-360 as a separate container in your pod spec.
@@ -170,7 +175,9 @@ You can run the yc-360 script in a Kubernetes environment using one of the follo
170175
</details>
171176

172177
<details>
173-
<summary><strong>OpenShift</storng></summary>
178+
179+
<summary><strong>OpenShift</storng></summary></br>
180+
174181
To monitor applications running in OpenShift, deploy the yc-360 script using:
175182

176183
[Run yc-360 Script in Sidecar Container](https://docs.ycrash.io/yc-360/openshift/deployment-options/run-as-sidecar-container.html)– Add yc-360 alongside your application within the pod template.
@@ -201,37 +208,37 @@ These metrics indicate that yc-360 script can safely run in production environme
201208
</details>
202209

203210
<details>
204-
<summary><strong>3. Is it Safe to Run yc-360 Script in Production Environments?</strong></summary>
211+
<summary><strong>3. Is it Safe to Run yc-360 Script in Production Environments?</strong></summary></br>
205212

206213
Absolutely. The yc-360 script is a non-intrusive, script. It doesn’t modify any application or system configuration. It only reads and collects diagnostics and is safe to run even in high-availability production environments.
207214
</details>
208215

209216
<details>
210-
<summary><strong>4. Can yc-360 Script be executed in containerized environments like Docker, Kubernetes, or OpenShift?</strong></summary>
217+
<summary><strong>4. Can yc-360 Script be executed in containerized environments like Docker, Kubernetes, or OpenShift?</strong></summary></br>
211218

212219
Yes, yc-360 script is designed to work seamlessly across all major environments — including bare-metal servers, virtual machines, Docker containers, Kubernetes, and OpenShift. You can execute the script directly inside your containers or use it as part of a sidecar or init container to collect diagnostic data. For detailed guidance on each supported environments, visit [https://docs.ycrash.io/yc-360/environment/introduction.html](https://docs.ycrash.io/yc-360/environment/introduction.html)
213220
</details>
214221

215222
<details>
216-
<summary><strong>5. What if I don’t have Direct Access to the Production Environment?</strong></summary>
223+
<summary><strong>5. What if I don’t have Direct Access to the Production Environment?</strong></summary></br>
217224

218225
That’s exactly what yc-360 script is built for. You can send the script to your customer or operations team and ask them to run it on your behalf. It generates a ZIP file with all the artifacts, which they can send back to you for analysis.
219226
</details>
220227

221228
<details>
222-
<summary><strong>6. How Much Time Does it Take to Run?</strong></summary>
229+
<summary><strong>6. How Much Time Does it Take to Run?</strong></summary></br>
223230

224231
In most environments, yc-360 script completes execution in under 30 seconds. However, collecting heap dumps may take longer depending on the heap size and system performance.
225232
</details>
226233

227234
<details>
228-
<summary><strong>7. What Kind of Issues Can yc-360 Script Help Troubleshoot?</strong></summary>
235+
<summary><strong>7. What Kind of Issues Can yc-360 Script Help Troubleshoot?</strong></summary></br>
229236

230237
The yc-360 script is effective in diagnosing memory leaks, GC pauses, CPU spikes, thread contention, application freezes, disk pressure, network latency, backend slowness, and more. It provides a 360° snapshot of your application and environment at the time of the issue.
231238
</details>
232239

233240
<details>
234-
<summary><strong>8. Where can I analyze the artifacts generated by the yc-360 script?</strong></summary>
241+
<summary><strong>8. Where can I analyze the artifacts generated by the yc-360 script?</strong></summary></br>
235242

236243
You have two options:
237244

@@ -242,25 +249,25 @@ For more details, refer to the [Bundle Upload](https://docs.ycrash.io/ycrash-fea
242249
</details>
243250

244251
<details>
245-
<summary><strong>9. How do I Schedule yc-360 Script to Run Periodically?</strong></summary>
252+
<summary><strong>9. How do I Schedule yc-360 Script to Run Periodically?</strong></summary></br>
246253

247254
You can schedule the script using cron (Linux/macOS), Task Scheduler (Windows), or Kubernetes CronJobs (in container environments). Just ensure the appropriate execution permission is set for the yc-360 script and Read/Write permissions for the output directory.
248255
</details>
249256

250257
<details>
251-
<summary><strong>10. Is yc-360 Script Customizable?</strong></summary>
258+
<summary><strong>10. Is yc-360 Script Customizable?</strong></summary></br>
252259

253260
Yes. The yc-360 script is designed as a modular shell script. You can clone the repository and customize individual collection commands or add/remove specific artifacts based on your organization’s requirements.
254261
</details>
255262

256263
<details>
257-
<summary><strong>11. Is Support Available for yc-360 Script?</strong></summary>
264+
<summary><strong>11. Is Support Available for yc-360 Script?</strong></summary></br>
258265

259266
For community support, please use the [GitHub Issues page](https://github.com/ycrash/yc-data-script/issues). For enterprise-grade support and integration assistance, visit [yCrash.io](https://ycrash.io/).
260267
</details>
261268

262269
<details>
263-
<summary><strong>12. How to Build the yc-360-script?</strong></summary>
270+
<summary><strong>12. How to Build the yc-360-script?</strong></summary></br>
264271

265272
Please refer to any one of the following links if you want to build the yc-360-script in that corresponding operating system:
266273

0 commit comments

Comments
 (0)