Skip to content

Commit

Permalink
docs: Clarify config for console decision logger
Browse files Browse the repository at this point in the history
Clarify the requirements/caveats for using the local decision logger
and include a blurb on the decision log.

Signed-off-by: Patrick East <east.patrick@gmail.com>
  • Loading branch information
patrick-east committed Jun 26, 2019
1 parent 096670b commit 1b6ee8d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/content/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ services:
| `decision_logs.reporting.max_delay_seconds` | `int64` | No (default: `600`) | Maximum amount of time to wait between uploads. |
| `decision_logs.mask_decision` | `string` | No (default: `system/log/mask`) | Set path of masking decision. |
| `decision_logs.plugin` | `string` | No | Use the named plugin for decision logging. If this field exists, the other configuration fields are not required. |
| `decision_logs.console` | `boolean` | No (default: `false`) | Log the decisions locally at `info` level to the console. If enabled a `service` or `plugin` _must_ be specified |
| `decision_logs.console` | `boolean` | No (default: `false`) | Log the decisions locally at `info` level to the console. When enabled alongside a remote decision logging API the `service` must be configured, the default `service` selection will be disabled. |

## Discovery

Expand Down
15 changes: 15 additions & 0 deletions docs/content/decision-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,21 @@ Decision log updates contain the following fields:
| `[_].metrics` | `object` | Key-value pairs of [performance metrics](../rest-api#performance-metrics). |
| `[_].erased` | `array[string]` | Set of JSON Pointers specifying fields in the event that were erased. |


## Local Decision Logs

Local console logging of decisions can be enabled via the `console` config option.
This does not require any remote server. Example of minimal config to enable:

```yaml
decision_logs:
console: true
```
This will dump all decision through the OPA logging system at the `info` level. See
[Configuration Reference](../configuration) for more details.


## Masking Sensitive Data

Policy queries may contain sensitive information in the `input` document that
Expand Down

0 comments on commit 1b6ee8d

Please sign in to comment.