Skip to content
GitLab

EAR commands · Changes

Page history
ear-4.3b commit authored by Oriol Vidal Teruel's avatar Oriol Vidal Teruel
Hide whitespace changes
Inline Side-by-side
EAR-commands.md
View page @ 447cd3f1
...@@ -16,7 +16,7 @@ Some options are disabled when the user is not authorized. ...@@ -16,7 +16,7 @@ Some options are disabled when the user is not authorized.
[[_TOC_]] [[_TOC_]]
## EAR job Accounting (eacct) # EAR job Accounting (eacct)
The `eacct` command shows accounting information stored in the EAR DB for jobs The `eacct` command shows accounting information stored in the EAR DB for jobs
(and step) IDs. (and step) IDs.
...@@ -166,7 +166,7 @@ at the CSV file. ...@@ -166,7 +166,7 @@ at the CSV file.
However, the iteration time (in seconds) is present on each loop as *ITER_TIME_SEC*, However, the iteration time (in seconds) is present on each loop as *ITER_TIME_SEC*,
as well as a timestamp (i.e., *TIMESTAMP*) with the elapsed time in seconds since the EPOCH. as well as a timestamp (i.e., *TIMESTAMP*) with the elapsed time in seconds since the EPOCH.
## EAR system energy Report (ereport) # EAR system energy Report (ereport)
The ereport command creates reports from the energy accounting data from nodes stored in the EAR DB. It is intended to use for energy consumption analysis over a set period of time, with some additional (optional) criteria such as node name or username. The ereport command creates reports from the energy accounting data from nodes stored in the EAR DB. It is intended to use for energy consumption analysis over a set period of time, with some additional (optional) criteria such as node name or username.
...@@ -190,7 +190,7 @@ Options are as follows: ...@@ -190,7 +190,7 @@ Options are as follows:
-h shows this message. -h shows this message.
``` ```
### Examples ## Examples
The following example uses the 'all' nodes option to display information for each node, as well as a start_time so it will give the accumulated energy from that moment until the current time. The following example uses the 'all' nodes option to display information for each node, as well as a start_time so it will give the accumulated energy from that moment until the current time.
...@@ -232,7 +232,7 @@ Energy% Warning lvl Timestamp INC th p_state ENERGY T1 ...@@ -232,7 +232,7 @@ Energy% Warning lvl Timestamp INC th p_state ENERGY T1
111.554 0 2019-05-22 09:41:34 0 0 837 1012019 907200 600 604800 EnergyBudget 111.554 0 2019-05-22 09:41:34 0 0 837 1012019 907200 600 604800 EnergyBudget
``` ```
### EAR Control (econtrol) ## EAR Control (econtrol)
The `econtrol` command modifies cluster settings (temporally) related to power policy settings. The `econtrol` command modifies cluster settings (temporally) related to power policy settings.
These options are sent to all the nodes in the cluster. These options are sent to all the nodes in the cluster.
...@@ -292,9 +292,9 @@ Node id Job-Step M-Rank DC power CPI GBS Gflops Time Avg ...@@ -292,9 +292,9 @@ Node id Job-Step M-Rank DC power CPI GBS Gflops Time Avg
node3 6878-0 1 245.44 0.37 24.29 136.40 56.00 2.59 node3 6878-0 1 245.44 0.37 24.29 136.40 56.00 2.59
``` ```
## Database commands # Database commands
### edb_create ## edb_create
Creates the EAR DB used for accounting and for the global energy control. Requires root access to the MySQL server. It reads the `ear.conf` to get connection details (server IP and port), DB name (which may or may not have been previously created) and EAR's default users (which will be created or altered to have the necessary privileges on EAR's database). Creates the EAR DB used for accounting and for the global energy control. Requires root access to the MySQL server. It reads the `ear.conf` to get connection details (server IP and port), DB name (which may or may not have been previously created) and EAR's default users (which will be created or altered to have the necessary privileges on EAR's database).
...@@ -306,7 +306,7 @@ Usage:edb_create [options] ...@@ -306,7 +306,7 @@ Usage:edb_create [options]
-h Shows this message. -h Shows this message.
``` ```
### edb_clean_pm ## edb_clean_pm
Cleans periodic metrics from the database. Used to reduce the size of EAR's database, it will remove every Periodic_metrics entry older than `num_days`: Cleans periodic metrics from the database. Used to reduce the size of EAR's database, it will remove every Periodic_metrics entry older than `num_days`:
...@@ -320,7 +320,7 @@ Usage:./src/commands/edb_clean_pm [options] ...@@ -320,7 +320,7 @@ Usage:./src/commands/edb_clean_pm [options]
-v Show current EAR version. -v Show current EAR version.
``` ```
### edb_clean_apps ## edb_clean_apps
Removes applications from the database. It is intended to remove old applications to speed up queries and free up space. It can also be used to remove specific applications from database. It removes ALL the information related to those jobs (the following tables will be modified for each job: Loops, if they exist; GPU_signatures, if they exist; Signatures, if they exist; Power signatures, Applications, and Jobs). Removes applications from the database. It is intended to remove old applications to speed up queries and free up space. It can also be used to remove specific applications from database. It removes ALL the information related to those jobs (the following tables will be modified for each job: Loops, if they exist; GPU_signatures, if they exist; Signatures, if they exist; Power signatures, Applications, and Jobs).
...@@ -339,7 +339,7 @@ Usage:edb_clean_apps [-j/-d] [options] ...@@ -339,7 +339,7 @@ Usage:edb_clean_apps [-j/-d] [options]
-h Displays this message -h Displays this message
``` ```
## erun # erun
`erun` is a program that simulates all the SLURM and EAR SLURM Plug-in pipeline. `erun` is a program that simulates all the SLURM and EAR SLURM Plug-in pipeline.
It was designed to provide compatibility between MPI implementations not fully compatible with It was designed to provide compatibility between MPI implementations not fully compatible with
...@@ -389,7 +389,7 @@ Also you have to load the EAR environment module or define its environment varia ...@@ -389,7 +389,7 @@ Also you have to load the EAR environment module or define its environment varia
| EAR_ETC=\<path\> | sysconfdir=\<path\> | | EAR_ETC=\<path\> | sysconfdir=\<path\> |
| EAR_DEFAULT=\<on/off\> | default=<on/off\> | | EAR_DEFAULT=\<on/off\> | default=<on/off\> |
## ear-info # ear-info
`ear-info` is a tool created to quickly view useful information about the current EAR installation of the system. `ear-info` is a tool created to quickly view useful information about the current EAR installation of the system.
It shows relevant details for both users and administrators, such as configuration defaults, installation paths, etc. It shows relevant details for both users and administrators, such as configuration defaults, installation paths, etc.
...@@ -461,4 +461,4 @@ The `--node-conf` flag can be used to request additional information about a spe ...@@ -461,4 +461,4 @@ The `--node-conf` flag can be used to request additional information about a spe
Configuration related to EAR's power capping sub-system, default optimization policies configuration and other parameters associated with the node requested are retrieved. Configuration related to EAR's power capping sub-system, default optimization policies configuration and other parameters associated with the node requested are retrieved.
You can read the [EAR configuration section](Configuration) for more details about how EAR uses tags to identify and configure different kind of nodes on a given heterogeneous system. You can read the [EAR configuration section](Configuration) for more details about how EAR uses tags to identify and configure different kind of nodes on a given heterogeneous system.
Contact with ear-support@bsc.es for more information about the nomenclature used by `ear-info`'s output. Contact with ear-support@bsc.es for more information about the nomenclature used by `ear-info`'s output.
\ No newline at end of file