You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-31Lines changed: 38 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,33 +42,34 @@
42
42
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.
43
43
44
44
<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)
47
48
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:
49
50
50
51
```sh
51
52
unzip yc-360-latest.zip
52
53
cd linux
53
54
```
54
55
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:
56
57
57
58
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'.
58
59
59
60
```sh
60
61
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
61
62
```
62
63
63
-
**INFO:**
64
+
<storng>INFO:</storng>
64
65
65
66
+`{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)
66
67
67
68
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
68
69
69
70
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
70
71
71
-
**IMPORTANT TIP:**
72
+
<storng>IMPORTANT TIP:<storng>
72
73
73
74
+ 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.
74
75
@@ -78,33 +79,34 @@ When you execute the below command, the yc-360 script will capture all the artif
78
79
79
80
</details>
80
81
<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).
83
85
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:
85
87
86
88
```sh
87
89
unzip yc-360-latest.zip
88
90
cd mac
89
91
```
90
92
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:
92
94
93
95
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'.
94
96
95
97
```sh
96
98
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
97
99
```
98
100
99
-
**INFO:**
101
+
<storng>INFO:</storng>
100
102
101
103
+`{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)
102
104
103
105
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
104
106
105
107
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
106
108
107
-
**IMPORTANT TIP:**
109
+
<storng>IMPORTANT TIP:</storng>
108
110
109
111
+ 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.
110
112
@@ -115,32 +117,33 @@ When you execute the below command, the yc-360 script will capture all the artif
115
117
</details>
116
118
117
119
<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).
120
123
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:
122
125
123
126
```
124
127
cd windows
125
128
```
126
129
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:
128
131
129
132
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'.
130
133
131
134
```sh
132
135
.\yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
133
136
```
134
137
135
-
**INFO:**
138
+
<storng>INFO:</storng>
136
139
137
140
+`{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)
138
141
139
142
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
140
143
141
144
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
142
145
143
-
**IMPORTANT TIP:**
146
+
<storng>IMPORTANT TIP:</storng>
144
147
145
148
+ 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.
146
149
@@ -150,7 +153,8 @@ When you execute the below command, the yc-360 script will capture all the artif
150
153
</details>
151
154
152
155
<details>
153
-
<summary><strong>Docker</storng></summary>
156
+
<summary><strong>Docker</storng></summary></br>
157
+
154
158
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:
155
159
156
160
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
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:
166
171
167
172
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
To monitor applications running in OpenShift, deploy the yc-360 script using:
175
182
176
183
[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
201
208
</details>
202
209
203
210
<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>
205
212
206
213
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.
207
214
</details>
208
215
209
216
<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>
211
218
212
219
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)
213
220
</details>
214
221
215
222
<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>
217
224
218
225
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.
219
226
</details>
220
227
221
228
<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>
223
230
224
231
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.
225
232
</details>
226
233
227
234
<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>
229
236
230
237
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.
231
238
</details>
232
239
233
240
<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>
235
242
236
243
You have two options:
237
244
@@ -242,25 +249,25 @@ For more details, refer to the [Bundle Upload](https://docs.ycrash.io/ycrash-fea
242
249
</details>
243
250
244
251
<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>
246
253
247
254
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.
248
255
</details>
249
256
250
257
<details>
251
-
<summary><strong>10. Is yc-360 Script Customizable?</strong></summary>
258
+
<summary><strong>10. Is yc-360 Script Customizable?</strong></summary></br>
252
259
253
260
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.
254
261
</details>
255
262
256
263
<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>
258
265
259
266
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/).
260
267
</details>
261
268
262
269
<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>
264
271
265
272
Please refer to any one of the following links if you want to build the yc-360-script in that corresponding operating system:
0 commit comments