Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shazron authored Oct 26, 2020
1 parent 30b32f4 commit b742a0e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,19 @@ For example:
}
```

Log file name format: `{processname}.out.log` and `{processname}`.err.log,
Log file name format: `{processname}.out.log` and `{processname}`.err.log.

In this example, your `stdout` log will be called `long-running-process.sh.out.log` and
your `stderr` log will be called `long-running-process.sh.err.log`.

Both files will be appended to, and will be created if they don't exist, and both will be created inside a `logs` folder in your current working folder. Make sure you put your `logs` folder in your `.gitignore` in case there are secrets being logged.
Both files will be appended to, and will be created if they don't exist, and both will be created inside a `logs` folder in your current working folder. Make sure you put your `logs` folder in your `.gitignore` in case there are secrets being logged. Newly generated templates will have this folder added in .gitignore.

Since the logs are appended to the file, it is recommended that your logs include a timestamp to differentiate between different runs of the process.
On every run, a timestamp is logged to the log file to differentiate runs.

## Contributing

Contributions are welcome! Read the [Contributing Guide](./.github/CONTRIBUTING.md) for more information.

## Licensing

This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.
This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.

0 comments on commit b742a0e

Please sign in to comment.