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
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,34 +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></br>
45
+
<summary><strong>Linux</strong></summary></br>
46
46
47
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)
48
48
49
-
<storng>2. Extract:</storng> Unzip the package and navigate to the linux directory:
49
+
<strong>2. Extract:</strong> Unzip the package and navigate to the linux directory:
50
50
51
51
```sh
52
52
unzip yc-360-latest.zip
53
53
cd linux
54
54
```
55
55
56
-
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
56
+
<strong>3. Execute yc-360 Script:</strong> Run the script with your target application's process ID:
57
57
58
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'.
59
59
60
60
```sh
61
61
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
62
62
```
63
63
64
-
<storng>INFO:</storng>
64
+
<strong>INFO:</strong>
65
65
66
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)
67
67
68
68
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
69
69
70
70
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
71
71
72
-
<storng>IMPORTANT TIP:<storng>
72
+
<strong>IMPORTANT TIP:<strong>
73
73
74
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.
75
75
@@ -79,34 +79,34 @@ When you execute the below command, the yc-360 script will capture all the artif
79
79
80
80
</details>
81
81
<details>
82
-
<summary><strong>MacOS</storng></summary></br>
82
+
<summary><strong>MacOS</strong></summary></br>
83
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).
84
+
<strong>1. Download:</strong> Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
85
85
86
-
<storng>2. Extract:</storng> Unzip the package and navigate to the mac directory:
86
+
<strong>2. Extract:</strong> Unzip the package and navigate to the mac directory:
87
87
88
88
```sh
89
89
unzip yc-360-latest.zip
90
90
cd mac
91
91
```
92
92
93
-
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
93
+
<strong>3. Execute yc-360 Script:</strong> Run the script with your target application's process ID:
94
94
95
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'.
96
96
97
97
```sh
98
98
./yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
99
99
```
100
100
101
-
<storng>INFO:</storng>
101
+
<strong>INFO:</strong>
102
102
103
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)
104
104
105
105
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
106
106
107
107
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
108
108
109
-
<storng>IMPORTANT TIP:</storng>
109
+
<strong>IMPORTANT TIP:</strong>
110
110
111
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.
112
112
@@ -117,33 +117,33 @@ When you execute the below command, the yc-360 script will capture all the artif
117
117
</details>
118
118
119
119
<details>
120
-
<summary><strong>Windows</storng></summary></br>
120
+
<summary><strong>Windows</strong></summary></br>
121
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).
122
+
<strong>1. Download:</strong> Download the latest version of the yc-360 script from [here](https://tier1app.com/dist/ycrash/yc-360-latest.zip).
123
123
124
-
<storng>2. Extract:</storng> Unzip the package and navigate to the windows directory:
124
+
<strong>2. Extract:</strong> Unzip the package and navigate to the windows directory:
125
125
126
126
```
127
127
cd windows
128
128
```
129
129
130
-
<storng>3. Execute yc-360 Script:</storng> Run the script with your target application's process ID:
130
+
<strong>3. Execute yc-360 Script:</strong> Run the script with your target application's process ID:
131
131
132
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'.
133
133
134
134
```sh
135
135
.\yc -onlyCapture -p {PID} -j {JAVA_HOME} -a {APPLICATION_NAME}
136
136
```
137
137
138
-
<storng>INFO:</storng>
138
+
<strong>INFO:</strong>
139
139
140
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)
141
141
142
142
+`{JAVA_HOME}`: The directory path where Java is installed in your environment.
143
143
144
144
+`{APPLICATION_NAME}`: Friendly name for the application (displayed in the yCrash dashboard).
145
145
146
-
<storng>IMPORTANT TIP:</storng>
146
+
<strong>IMPORTANT TIP:</strong>
147
147
148
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.
149
149
@@ -153,7 +153,7 @@ When you execute the below command, the yc-360 script will capture all the artif
153
153
</details>
154
154
155
155
<details>
156
-
<summary><strong>Docker</storng></summary></br>
156
+
<summary><strong>Docker</strong></summary></br>
157
157
158
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:
159
159
@@ -165,7 +165,7 @@ 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:
171
171
@@ -175,15 +175,15 @@ 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:
181
181
182
182
[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.
0 commit comments