Skip to content

Commit ce14cf2

Browse files
author
Alagappan21
committed
1. Replace the 'Getting Started - How to run the yc-360 Script?' with the docs contents
2. Moved 'How to Build the yc-360 script?' to FAQ section
1 parent 532c158 commit ce14cf2

File tree

1 file changed

+145
-10
lines changed

1 file changed

+145
-10
lines changed

‎README.md‎

Lines changed: 145 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,147 @@
3939

4040
## Getting Started - How to run the yc-360 Script?
4141

42-
It’s easy to get started with the yc-360 script. Just follow the simple steps provided in our [Getting Started Guide](https://docs.ycrash.io/yc-360/launch-modes/only-capture-mode.html). In a matter of seconds, you’ll be able to trigger the script and collect all the critical artifacts needed for troubleshooting.
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.
4343

44-
Whether you're running on Linux, Windows, Mac, Docker, K8, … the guide walks you
45-
through the setup and execution process.
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).
4647

47-
## How to Analyze the Artifacts Generated by the yc-360-script?
48+
**2. Extract:** Unzip the package and navigate to the linux directory:
4849

49-
You can analyze the artifacts captured by yc-360-script either manually or through [yCrash server](https://ycrash.io/). yCrash server analyzes all the captured data and generates a root cause analysis report instantly. You can use the [Bundle upload](https://docs.ycrash.io/ycrash-features/bundle-upload.html#step-1-go-to-upload-incident-form) feature in the yCrash server to analyze the captured 360-degree data.
50+
```sh
51+
unzip yc-360-latest.zip
52+
cd linux
53+
```
5054

51-
## How to Build the yc-360-script?
55+
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
5256

53-
Please refer to any one of the following links if you want to build the yc-360-script in that corresponding operating system:
57+
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'.
5458

55-
1. Build yc-360-script in [Windows](/docs/build/build_yc_360_script_windows.md)
56-
2. Build yc-360-script in [Linux](/docs/build/build_yc_360_script_linux.md)
57-
3. Build yc-360-script in [MacOS](/docs/build/build_yc_360_script_macos.md)
59+
```sh
60+
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
61+
```
62+
63+
**INFO:**
64+
65+
+ `{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+
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
68+
69+
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
70+
71+
**IMPORTANT TIP:**
72+
73+
+ 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+
+ To detect memory-related issues, **GC logging** must be enabled for your application. You can enable GC logging by using the JVM arguments listed [here](https://docs.ycrash.io/yc-360/faq/how-to-enable-gc-logs.html).
76+
77+
+ The yc-360 script doesn't capture heap dump by default. Pass `-hd` argument to capture heap dump. For more information, please visit [How to Capture Heap Dump?](https://docs.ycrash.io/yc-360/faq/how-to-capture-heapdump.html)
78+
79+
</details>
80+
<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).
83+
84+
**2. Extract:** Unzip the package and navigate to the mac directory:
85+
86+
```sh
87+
unzip yc-360-latest.zip
88+
cd mac
89+
```
90+
91+
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
92+
93+
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+
95+
```sh
96+
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
97+
```
98+
99+
**INFO:**
100+
101+
+ `{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+
103+
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
104+
105+
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
106+
107+
**IMPORTANT TIP:**
108+
109+
+ 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+
111+
+ To detect memory-related issues, **GC logging** must be enabled for your application. You can enable GC logging by using the JVM arguments listed [here](https://docs.ycrash.io/yc-360/faq/how-to-enable-gc-logs.html).
112+
113+
+ The yc-360 script doesn't capture heap dump by default. Pass `-hd` argument to capture heap dump. For more information, please visit [How to Capture Heap Dump?](https://docs.ycrash.io/yc-360/faq/how-to-capture-heapdump.html)
114+
115+
</details>
116+
117+
<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+
121+
**2. Extract:** Unzip the package and navigate to the windows directory:
122+
123+
```
124+
cd windows
125+
```
126+
127+
**3. Execute yc-360 Script:** Run the script with your target application's process ID:
128+
129+
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+
131+
```sh
132+
.\yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
133+
```
134+
135+
**INFO:**
136+
137+
+ `{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+
139+
+ `{JAVA_HOME}`: The directory path where Java is installed in your environment.
140+
141+
+ `{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
142+
143+
**IMPORTANT TIP:**
144+
145+
+ 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+
147+
+ To detect memory-related issues, **GC logging** must be enabled for your application. You can enable GC logging by using the JVM arguments listed [here](https://docs.ycrash.io/yc-360/faq/how-to-enable-gc-logs.html).
148+
149+
+ The yc-360 script doesn't capture heap dump by default. Pass `-hd` argument to capture heap dump. For more information, please visit [How to Capture Heap Dump?](https://docs.ycrash.io/yc-360/faq/how-to-capture-heapdump.html)
150+
</details>
151+
152+
<details>
153+
<summary><strong>Docker</storng></summary>
154+
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+
156+
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.
157+
158+
2. [Run yc-360 Script in Same Container](https://docs.ycrash.io/yc-360/docker-container/deployment-options/run-yc-360-script-in-same-container.html) – Embed the yc-360 script directly inside the application container.
159+
160+
3. [Run yc-360 Script on Host](https://docs.ycrash.io/yc-360/docker-container/deployment-options/run-yc-360-script-on-host.html) – Run the script on the host that is running your Docker containers.
161+
</details>
162+
163+
<details>
164+
<summary><strong>Kubernetes</storng></summary>
165+
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+
167+
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.
168+
169+
2. [Run yc-360 Script in Same Container](https://docs.ycrash.io/yc-360/kubernetes/deployment-options/run-in-same-container.html) – Install and run the script directly inside your application container.
170+
</details>
171+
172+
<details>
173+
<summary><strong>OpenShift</storng></summary>
174+
To monitor applications running in OpenShift, deploy the yc-360 script using:
175+
176+
[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.
177+
</details>
178+
179+
180+
## How to Analyze the Artifacts Generated by the yc-360-script?
181+
182+
You can analyze the artifacts captured by yc-360-script either manually or through [yCrash server](https://ycrash.io/). yCrash server analyzes all the captured data and generates a root cause analysis report instantly. You can use the [Bundle upload](https://docs.ycrash.io/ycrash-features/bundle-upload.html#step-1-go-to-upload-incident-form) feature in the yCrash server to analyze the captured 360-degree data.
58183

59184
## FAQ
60185

@@ -133,3 +258,13 @@ Yes. The yc-360 script is designed as a modular shell script. You can clone the
133258

134259
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/).
135260
</details>
261+
262+
<details>
263+
<summary><strong>12. How to Build the yc-360-script?</strong></summary>
264+
265+
Please refer to any one of the following links if you want to build the yc-360-script in that corresponding operating system:
266+
267+
1. Build yc-360-script in [Windows](/docs/build/build_yc_360_script_windows.md)
268+
2. Build yc-360-script in [Linux](/docs/build/build_yc_360_script_linux.md)
269+
3. Build yc-360-script in [MacOS](/docs/build/build_yc_360_script_macos.md)
270+
</details>

0 commit comments

Comments
 (0)