Skip to content

Commit 7024d8e

Browse files
authored
Update Logging.md
Reviewed and updated some verbage.
1 parent 7e3b98b commit 7024d8e

File tree

1 file changed

+9
-45
lines changed

1 file changed

+9
-45
lines changed

docs/Logging.md

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
_For the Doc-A-Thon_
2-
3-
**NOTES TO EDITOR:**
4-
- There are [sections at the bottom](#todo-move-the-sections-below-to-the-configuration-page) that should be moved into configuration.
51

62
**Questions to answer and things to consider:**
73

@@ -20,9 +16,9 @@ _For the Doc-A-Thon_
2016

2117
---
2218

23-
## Logging properties
19+
## Logging Properties
2420

25-
### Setting logging properties
21+
### Setting Logging Properties
2622

2723
Cromwell accepts two properties for controlling logging. You can set these properties via a Java system property on the command line using `-D`:
2824

@@ -37,15 +33,15 @@ export LOG_LEVEL=DEBUG
3733
java -jar cromwell.jar server
3834
```
3935

40-
If you set same property via a system property and an environment variable, the system property overrides the environment variable.
36+
*If you set same property via a system property, and an environment variable, the system property overrides the environment variable.*
4137

4238
### Log Format
4339

44-
Cromwell outputs logs in one of two formats, either `pretty` or `standard`. You can change the format of the logs by setting the property `LOG_MODE`.
40+
Cromwell outputs log in one of two formats, either `pretty` or `standard`. You can change the format of the logs by setting the property to `LOG_MODE`.
4541

46-
In `standard` mode, your logs will be written without ANSI escape code coloring, with a layout more appropriate for server logs.
42+
* In `standard` mode, your logs will be written without ANSI escape code coloring, with a layout more appropriate for server logs.
4743

48-
In `pretty` mode, your logs are output is a colorful, easier to read output more appropriate for a single workflow run.
44+
* In `pretty` mode, your logs are output in a colorful, easier to read format, more appropriate for a single workflow run.
4945

5046
The default mode for server is `standard`, while the default when running a single worklow is `pretty`. You can explicitly specify the format by running cromwell with:
5147

@@ -55,7 +51,7 @@ java -DLOG_MODE=pretty -jar cromwell.jar server
5551

5652
### Log Level
5753

58-
By default Cromwell outputs messages at a `LOG_LEVEL` of `INFO`. Sometimes, you may want more or less information logged. For example, while debugging an issue you may want to increase the amount information in the logs temporarily. Or, in some situations, the standard level may be too verbose, and you may only want Cromwell to log warnings and errors.
54+
By default, Cromwell outputs messages at a `LOG_LEVEL` of `INFO`. Sometimes, you may want more or less information logged. For example, while debugging an issue you may want to increase the amount information in the logs temporarily. Alternatively, the standard level may be too verbose, and you may only want Cromwell to log warnings and errors.
5955

6056
You can set the level via the property `LOG_LEVEL` to any one of the values: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, or `OFF`. The default log level is `INFO`.
6157

@@ -65,44 +61,12 @@ java -DLOG_LEVEL=DEBUG -jar cromwell.jar server
6561

6662
## Workflow Logs
6763

68-
While a workflow is running, Cromwell generates a log file specifically for the workflow. After the workflow completes, to clear up local disk space, cromwell deletes the local copy of this log file. See the [configuration](Configuring) section on Logs for more information on preventing cromwell from deleting each workflow log.
64+
While a workflow is running, Cromwell generates a log file specifically for the workflow. After the workflow completes, to clear up local disk space, Cromwell deletes the local copy of this log file. See the [configuration](Configuring) section on logs for more information on preventing cromwell from deleting each workflow log.
6965

70-
After the workflow completes, but before Cromwell deletes the files, you can configure Cromwell to copy the workflow logs to various locations. Normally, you'll want to copy the log to a remote bucket or directory. To specify the remote directory to copy the logs to use the separate [workflow option](WorkflowOptions) `final_workflow_log_dir`. Workflow logs may also be copied via [Sentry](https://docs.sentry.io) by setting the [configuration](Configuring) value `sentry.dsn`.
66+
Before Cromwell deletes teh files and before the workflow completes, you can configure Cromwell to copy the workflow logs to various locations. Normally, you'll want to copy the log to a remote bucket or directory. To specify the remote directory to copy the logs to use the separate [workflow option](WorkflowOptions) `final_workflow_log_dir`. Workflow logs may also be copied via [Sentry](https://docs.sentry.io) by setting the [configuration](Configuring) value `sentry.dsn`.
7167

7268
## Call Logs
7369

7470
As each call in a workflow runs, it generates output to the standard output and standard error. This output is stored per call in call log files. Additionally, depending on the backend, specific per call backand logs may be generated.
7571

7672
All of these call logs may be copied at the end of a workflow to a remote directory. Configure this directory by setting the [workflow option](WorkflowOptions) `final_call_logs_dir`.
77-
78-
# TODO MOVE THE SECTIONS BELOW TO THE CONFIGURATION PAGE
79-
80-
### Workflow Log Directory
81-
82-
To change the directory where cromwell writes workflow logs, change the directory location via the setting:
83-
84-
```hocon
85-
workflow-options {
86-
workflow-log-dir = "cromwell-workflow-logs"
87-
}
88-
```
89-
90-
### Preserving Workflow Logs
91-
92-
By default Cromwell erases the per workflow logs when the workflow completes to reduce disk usage. You can change this behavior by setting the following value to `false`:
93-
94-
```hocon
95-
workflow-options {
96-
workflow-log-temporary = true
97-
}
98-
```
99-
100-
### Exporting workflow logs via Sentry
101-
102-
Cromwell supports [Sentry](https://docs.sentry.io) for copying workflow logs. Sentry is a service that can be used to monitor exceptions reported in an application's logs.
103-
104-
To send the cromwell logs to Sentry, enter your DSN URL into the configuration value:
105-
106-
```hocon
107-
sentry.dsn = DSN_URL
108-
```

0 commit comments

Comments
 (0)