Skip to content

Commit

Permalink
GitBook: [master] 35 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
woop authored and gitbook-bot committed Nov 23, 2020
1 parent 280d87f commit 6646b59
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/advanced/audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
This page applies to Feast 0.7. The content may be out of date for Feast 0.8+
{% endhint %}

### Introduction
## Introduction

Feast provides audit logging functionality in order to debug problems and to trace the lineage of events.

### Audit Log Types
## Audit Log Types

Audit Logs produced by Feast come in three favors:

Expand All @@ -18,15 +18,15 @@ Audit Logs produced by Feast come in three favors:
| Transition Audit Log | Logs transitions in status in resources managed by Feast \(ie an Ingestion Job becoming RUNNING\). |
| Action Audit Log | Logs actions performed on a specific resource managed by Feast \(ie an Ingestion Job is aborted\). |

### Configuration
## Configuration

| Audit Log Type | Description |
| :--- | :--- |
| Message Audit Log | Enabled when both `feast.logging.audit.enabled` and `feast.logging.audit.messageLogging.enabled` is set to `true` |
| Transition Audit Log | Enabled when `feast.logging.audit.enabled` is set to `true` |
| Action Audit Log | Enabled when `feast.logging.audit.enabled` is set to `true` |

### JSON Format
## JSON Format

Audit Logs produced by Feast are written to the console similar to normal logs but in a structured, machine parsable JSON. Example of a Message Audit Log JSON entry produced:

Expand Down Expand Up @@ -56,7 +56,7 @@ Audit Logs produced by Feast are written to the console similar to normal logs b
}
```

### Log Entry Schema
## Log Entry Schema

Fields common to all Audit Log Types:

Expand Down Expand Up @@ -95,11 +95,11 @@ Fields in Transition Audit Log Type
| `resource.type` | Type of resource of which the transition occurred \(i.e `FeatureTable`\) |
| `resource.id` | Identifier specifying the specific resource of which the transition occurred. |

### Log Forwarder
## Log Forwarder

Feast currently only supports forwarding Request/Response \(Message Audit Log Type\) logs to an external fluentD service with `feast.**` Fluentd tag.

#### Request/Response Log Example
### Request/Response Log Example

```text
{
Expand All @@ -118,7 +118,7 @@ Feast currently only supports forwarding Request/Response \(Message Audit Log Ty
}
```

#### Configuration
### Configuration

The Fluentd Log Forwarder configured with the with the following configuration options in `application.yml`:

Expand Down
1 change: 1 addition & 0 deletions docs/contributing/development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ The following software is required for Feast development
* Java SE Development Kit 11
* Python version 3.6 \(or above\) and pip
* [Maven](https://maven.apache.org/install.html) version 3.6.x
* PySpark 2.4.2

### **Services**

Expand Down

0 comments on commit 6646b59

Please sign in to comment.