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
This article provides instructions for IT administrators on collecting Run:ai logs for support, including prerequisites, CLI commands, and log file retrieval. It also covers enabling verbose logging for Prometheus and the Run:ai Scheduler.
4
5
5
6
## Collect logs to send to support
6
7
7
-
To collect Run:ai logs, follow these steps precisely:
8
+
To collect Run:ai logs, follow these steps:
8
9
9
10
### Prerequisites
10
11
11
12
* Ensure that you have administrator-level access to the Kubernetes cluster where Run:ai is installed.
12
-
* The Run:ai Administrator Command-Line Interface (CLI) must be [installed](..//config/cli-admin-install.md).
13
-
* You must be logged into the Run:ai CLI with the correct permissions.
13
+
* The Run:ai[Administrator Command-Line Interface](../config/cli-admin-install.md) (CLI) must be installed.
14
14
15
-
### Step-by-Step Instructions
15
+
####Step-by-Step Instructions
16
16
17
-
1.Open a terminal on your local machine (or any machine that has network access to the Kubernetes cluster) where the Run:ai Administrator CLI is installed.
18
-
2. Log in to the Run:ai CLI (if required)
19
-
3. Collect the Logs:
20
-
Execute the command to collect the logs:
17
+
1.Run the Command from your local machine or a Bastion Host (secure server)
18
+
Open a terminal on your local machine (or any machine that has network access to the Kubernetes cluster) where the Run:aiAdministrator CLI is installed.
19
+
2. Collect the Logs
20
+
Execute the following command to collect the logs:
21
21
22
22
```bash
23
23
runai-adm collect-logs
24
24
```
25
25
26
26
This command gathers all relevant Run:ai logs from the system and generate a compressed file.
27
27
28
-
5. Locate the Generated File
28
+
3. Locate the Generated File
29
29
After running the command, note the location of the generated compressed log file. You can retrieve and send this file to Run:ai Support for further troubleshooting.
30
30
31
31
!!! Note
32
-
The tar file packages the logs of Run:ai components only. It does __not__ include logs of researcher containers that may contain private information.
32
+
The tar file packages the logs of Run:ai components only. It does not include logs of researcher containers that may contain private information
33
33
34
34
## Logs verbosity
35
35
@@ -44,70 +44,57 @@ Before you begin, ensure you have the following:
44
44
* kubectl installed and configured:
45
45
* The Kubernetes command-line tool, `kubectl`, must be installed and configured to interact with the cluster.
46
46
* Sufficient privileges to edit configurations and view logs.
47
-
* Administrative access to Run:ai’s installation settings.
48
47
* Monitoring Disk Space
49
48
* When enabling verbose logging, ensure adequate disk space to handle the increased log output, especially when enabling debug or high verbosity levels.
50
49
51
50
### Adding verbosity
52
51
53
-
#### Adding verbosity to Prometheus
52
+
???"Adding verbosity to Prometheus"
53
+
To increase the logging verbosity for Prometheus, follow these steps:
54
54
55
-
To increase the logging verbosity for Prometheus, follow these steps:
55
+
1. Edit the `RunaiConfig` to adjust Prometheus log levels. Copy the following command to your terminal:
56
56
57
-
1. Edit the `RunaiConfig` to adjust Prometheus log levels. Copy the following command to your terminal:
58
-
2. Bash
59
-
60
-
```
61
-
kubectl edit runaiconfig runai -n runai
62
-
```
57
+
``` bash
58
+
kubectl edit runaiconfig runai -n runai
59
+
```
63
60
64
-
4.
65
-
In the configuration file that opens, add or modify the following section to set the log level to `debug`:
66
-
5. Bash
61
+
2. In the configuration file that opens, add or modify the following section to set the log level to `debug`:
67
62
68
-
```
69
-
spec:
70
-
prometheus:
63
+
``` yaml
71
64
spec:
72
-
logLevel: debug
73
-
```
74
-
75
-
7.
76
-
Save the changes. To view the Prometheus logs with the new verbosity level, run:
77
-
8. Bash
78
-
79
-
```
80
-
kubectl logs -n runai prometheus-runai-0
81
-
```
65
+
prometheus:
66
+
spec:
67
+
logLevel: debug
68
+
```
69
+
70
+
3. Save the changes. To view the Prometheus logs with the new verbosity level, run:
82
71
83
-
10.
72
+
``` bash
73
+
kubectl logs -n runai prometheus-runai-0
74
+
```
75
+
84
76
This command streams the last 100 lines of logs from Prometheus, providing detailed information useful for debugging.
85
77
86
-
#### Adding verbosity to the scheduler
87
-
88
-
To enable extended logging for the Run:ai scheduler:
89
-
90
-
1. Edit the `RunaiConfig` to adjust scheduler verbosity:
91
-
2. Bash
78
+
???"Adding verbosity to the scheduler"
92
79
93
-
```
94
-
kubectl edit runaiconfig runai -n runai
95
-
```
80
+
To enable extended logging for the Run:ai scheduler:
96
81
97
-
4.
98
-
Add or modify the following section under the scheduler settings:
99
-
5. Bash
82
+
1. Edit the `RunaiConfig` to adjust scheduler verbosity:
100
83
101
-
```
102
-
runai-scheduler:
103
-
args:
104
-
verbosity: 6
105
-
```
84
+
``` bash
85
+
kubectl edit runaiconfig runai -n runai
86
+
```
87
+
88
+
2 Add or modify the following section under the scheduler settings:
106
89
107
-
7.
108
-
This increases the verbosity level of the scheduler logs to provide more detailed output.
90
+
``` yaml
91
+
runai-scheduler:
92
+
args:
93
+
verbosity: 6
94
+
```
109
95
110
-
Warning
96
+
This increases the verbosity level of the scheduler logs to provide more detailed output.
111
97
112
-
Enabling verbose logging can significantly increase disk space usage. Monitor your storage capacity and adjust the verbosity level as necessary.
98
+
!!! Warning
99
+
Enabling verbose logging can significantly increase disk space usage. Monitor your storage capacity and adjust the verbosity level as necessary.
Copy file name to clipboardExpand all lines: docs/home/overview.md
+1-7Lines changed: 1 addition & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -41,13 +41,7 @@ Run:ai cloud availability is monitored at [status.run.ai](https://status.run.ai)
41
41
42
42
## Collect Logs to Send to Support
43
43
44
-
As an IT Administrator, you can collect Run:ai logs to send to support:
45
-
46
-
* Install the [Run:ai Administrator command-line interface](../admin//config/cli-admin-install.md).
47
-
* Run `runai-adm collect-logs`. The command will generate a compressed file containing all of the existing Run:ai log files.
48
-
49
-
!!! Note
50
-
The tar file packages the logs of Run:ai components only. It does __not__ include logs of researcher containers that may contain private information.
44
+
As an IT Administrator, you can collect Run:ai logs to send to support. For more information see [logs collection](../admin/troubleshooting/logs-collection.md).
0 commit comments