Skip to content

Commit

Permalink
Merge pull request #39 from ghrcdaac/mlh0079-5202-subprocess-logging
Browse files Browse the repository at this point in the history
 - Updating readme and index for new version.
  • Loading branch information
camposeddie authored Jul 24, 2023
2 parents 598e2bf + 6a9c6d3 commit ac4e790
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
# Overview
DMR++ files generator is a cloud based activity that generate DMRPP files from netCDF4 and HDF files
## 📖 Documentation
- Release note [v4.0.9](https://ghrcdaac.github.io/dmrpp-generator/#v409).
- Release note [v4.0.8](https://ghrcdaac.github.io/dmrpp-generator/#v408).
- Release note [v4.0.7](https://ghrcdaac.github.io/dmrpp-generator/#v407).
- Release note [v4.0.6](https://ghrcdaac.github.io/dmrpp-generator/#v406).
Expand Down Expand Up @@ -212,4 +213,13 @@ if not configured. There are two ways to provide a custom value.
2. Adding `get_dmrpp_timeout` to the collection definition: `collection.meta.dmrpp`

If the value is provided in the collection definition this will take precedence over the environment
variable.
variable.

## Subprocess Logging Configuration
When making the subprocess call, stdout and stderr will default to `None` to prevent an issue from occurring where the
timeout is not respected. This can be configured in two ways.
1. Setting the `ENABLE_SUBPROCESS_LOGGING` environment variable in terraform
2. Adding `enable_subprocess_logging` to the collection definition: `collection.meta.dmrpp`. Can be `true` or `false`.

If the value is provided in the collection definition this will take precedence over the environment
variable.
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@

# 📖 Release notes
## v4.0.9
This release:
* The subprocess will have stdout and stderr default to None to reduce log spam. It can be enabled by passing
"enable_subprocess_logging": true into the event or setting the environment variable ENABLE_SUBPROCESS_LOGGING.
## 🏃 Migration Steps to v4.0.9
```code
module "dmrpp-generator" {
// Change the source url in your terraform file to point to v4.0.9
source = "https://github.com/ghrcdaac/dmrpp-generator/releases/download/v4.0.9/dmrpp-generator.zip"
...
}
```

## v4.0.8
This release:
* default_log_retention_days is now configurable
Expand Down

0 comments on commit ac4e790

Please sign in to comment.