Skip to content

Commit 63db0e3

Browse files
woopgitbook-bot
woop
authored and
gitbook-bot
committed
GitBook: [master] 58 pages modified
1 parent 862f344 commit 63db0e3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2929
-146
lines changed

‎docs/README.md‎

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Introduction
22

3-
{% hint style="success" %}
4-
_Would you prefer a lighter-weight, pip-install, no-Kubernetes deployment of Feast?_ The Feast maintainers are currently building a new deployment experience for Feast. If you have thoughts on Feast's deployment, [chat with the maintainers](https://calendly.com/d/gc29-y88c/feast-chat-w-willem-and-jay) to learn more and provide feedback.
5-
{% endhint %}
6-
73
## What is Feast?
84

95
Feast \(**Fea**ture **St**ore\) is an operational data system for managing and serving machine learning features to models in production.
@@ -47,16 +43,16 @@ Feast addresses this problem by introducing feature reuse through a centralized
4743
## How can I get started?
4844

4945
{% hint style="info" %}
50-
The best way to learn Feast is to use it. Head over to our [Quickstart](quickstart.md) and try out our examples!
46+
The best way to learn Feast is to use it. Head over to our [Quickstart](feast-on-kubernetes/getting-started/install-feast/quickstart.md) and try out our examples!
5147
{% endhint %}
5248

5349
Explore the following resources to get started with Feast:
5450

55-
* [Getting Started](getting-started/) provides guides on [Installing Feast](getting-started/install-feast/) and [Connecting to Feast](getting-started/connect-to-feast/).
56-
* [Concepts](concepts/overview.md) describes all important Feast API concepts.
57-
* [User guide](user-guide/define-and-ingest-features.md) provides guidance on completing Feast workflows.
51+
* [Getting Started](feast-on-kubernetes/getting-started/) provides guides on [Installing Feast](feast-on-kubernetes/getting-started/install-feast/) and [Connecting to Feast](feast-on-kubernetes/getting-started/connect-to-feast/).
52+
* [Concepts](feast-on-kubernetes/concepts/overview.md) describes all important Feast API concepts.
53+
* [User guide](feast-on-kubernetes/user-guide/define-and-ingest-features.md) provides guidance on completing Feast workflows.
5854
* [Examples](https://github.com/feast-dev/feast/tree/master/examples) contains a Jupyter notebook that you can run on your Feast deployment.
59-
* [Advanced](advanced/troubleshooting.md) contains information about both advanced and operational aspects of Feast.
60-
* [Reference](reference/api/) contains detailed API and design documents for advanced users.
55+
* [Advanced](feast-on-kubernetes/advanced-1/troubleshooting.md) contains information about both advanced and operational aspects of Feast.
56+
* [Reference](feast-on-kubernetes/reference-1/api/) contains detailed API and design documents for advanced users.
6157
* [Contributing](contributing/contributing.md) contains resources for anyone who wants to contribute to Feast.
6258

‎docs/SUMMARY.md‎

Lines changed: 68 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,65 +2,87 @@
22

33
* [Introduction](README.md)
44
* [Quickstart](quickstart.md)
5-
* [Getting Started](getting-started/README.md)
6-
* [Install Feast](getting-started/install-feast/README.md)
7-
* [Kubernetes \(with Helm\)](getting-started/install-feast/kubernetes-with-helm.md)
8-
* [Amazon EKS \(with Terraform\)](getting-started/install-feast/kubernetes-amazon-eks-with-terraform.md)
9-
* [Azure AKS \(with Helm\)](getting-started/install-feast/kubernetes-azure-aks-with-helm.md)
10-
* [Azure AKS \(with Terraform\)](getting-started/install-feast/kubernetes-azure-aks-with-terraform.md)
11-
* [Google Cloud GKE \(with Terraform\)](getting-started/install-feast/google-cloud-gke-with-terraform.md)
12-
* [IBM Cloud Kubernetes Service \(IKS\) \(with Helm\)](getting-started/install-feast/ibm-cloud-iks-with-helm.md)
13-
* [Connect to Feast](getting-started/connect-to-feast/README.md)
14-
* [Python SDK](getting-started/connect-to-feast/python-sdk.md)
15-
* [Feast CLI](getting-started/connect-to-feast/feast-cli.md)
16-
* [Learn Feast](getting-started/learn-feast.md)
175
* [Roadmap](roadmap.md)
186
* [Changelog](https://github.com/feast-dev/feast/blob/master/CHANGELOG.md)
197
* [Community](community.md)
208

21-
## Concepts
22-
23-
* [Overview](concepts/overview.md)
24-
* [Architecture](concepts/architecture.md)
25-
* [Entities](concepts/entities.md)
26-
* [Sources](concepts/sources.md)
27-
* [Feature Tables](concepts/feature-tables.md)
28-
* [Stores](concepts/stores.md)
29-
* [Glossary](concepts/glossary.md)
9+
## Tutorials
3010

31-
## User Guide
11+
## How-to Guides
3212

33-
* [Overview](user-guide/overview.md)
34-
* [Define and ingest features](user-guide/define-and-ingest-features.md)
35-
* [Getting training features](user-guide/getting-training-features.md)
36-
* [Getting online features](user-guide/getting-online-features.md)
13+
---
3714

38-
## Tutorials
15+
* [Create a feature repository](create-a-feature-repository.md)
16+
* [Deploy a feature store](deploy-a-feature-store.md)
17+
* [Load data into the online store](load-data-into-the-online-store.md)
18+
* [Build a training dataset](build-a-training-dataset.md)
19+
* [Read features from the online store](read-features-from-the-online-store.md)
3920

40-
* [Minimal Ride Hailing Example](https://github.com/feast-dev/feast/blob/master/examples/minimal/minimal_ride_hailing.ipynb)
21+
## Concepts
4122

42-
## Advanced
23+
---
4324

44-
* [Upgrading Feast](advanced/upgrading.md)
45-
* [Security](advanced/security.md)
46-
* [Audit Logging](advanced/audit-logging.md)
47-
* [Metrics](advanced/metrics.md)
48-
* [Telemetry](advanced/telemetry.md)
49-
* [Troubleshooting](advanced/troubleshooting.md)
25+
* [Architecture](architecture.md)
26+
* [Feature Views](feature-views.md)
27+
* [Entities](entities.md)
28+
* [Sources](sources.md)
5029

5130
## Reference
5231

53-
* [API Reference](reference/api/README.md)
54-
* [Go SDK](https://godoc.org/github.com/feast-dev/feast/sdk/go)
55-
* [Java SDK](https://javadoc.io/doc/dev.feast/feast-sdk)
56-
* [Core gRPC API](https://api.docs.feast.dev/grpc/feast/core/coreservice.pb.html)
57-
* [Python SDK](https://api.docs.feast.dev/python/)
58-
* [Serving gRPC API](https://api.docs.feast.dev/grpc/feast/serving/servingservice.pb.html)
59-
* [gRPC Types](https://api.docs.feast.dev/grpc/feast/types/value.pb)
60-
* [Configuration Reference](reference/configuration-reference.md)
61-
* [Feast and Spark](reference/feast-and-spark.md)
62-
* [Metrics Reference](reference/metrics-reference.md)
63-
* [Limitations](reference/limitations.md)
32+
---
33+
34+
* [Repository Config](repository-config.md)
35+
* [Python API reference](http://rtd.feast.dev/)
36+
37+
## Feast on Kubernetes
38+
39+
* [Getting Started](feast-on-kubernetes/getting-started/README.md)
40+
* [Install Feast](feast-on-kubernetes/getting-started/install-feast/README.md)
41+
* [Docker Compose](feast-on-kubernetes/getting-started/install-feast/quickstart.md)
42+
* [Kubernetes \(with Helm\)](feast-on-kubernetes/getting-started/install-feast/kubernetes-with-helm.md)
43+
* [Amazon EKS \(with Terraform\)](feast-on-kubernetes/getting-started/install-feast/kubernetes-amazon-eks-with-terraform.md)
44+
* [Azure AKS \(with Helm\)](feast-on-kubernetes/getting-started/install-feast/kubernetes-azure-aks-with-helm.md)
45+
* [Azure AKS \(with Terraform\)](feast-on-kubernetes/getting-started/install-feast/kubernetes-azure-aks-with-terraform.md)
46+
* [Google Cloud GKE \(with Terraform\)](feast-on-kubernetes/getting-started/install-feast/google-cloud-gke-with-terraform.md)
47+
* [IBM Cloud Kubernetes Service \(IKS\) \(with Helm\)](feast-on-kubernetes/getting-started/install-feast/ibm-cloud-iks-with-helm.md)
48+
* [Connect to Feast](feast-on-kubernetes/getting-started/connect-to-feast/README.md)
49+
* [Python SDK](feast-on-kubernetes/getting-started/connect-to-feast/python-sdk.md)
50+
* [Feast CLI](feast-on-kubernetes/getting-started/connect-to-feast/feast-cli.md)
51+
* [Learn Feast](feast-on-kubernetes/getting-started/learn-feast.md)
52+
* [Concepts](feast-on-kubernetes/concepts/README.md)
53+
* [Overview](feast-on-kubernetes/concepts/overview.md)
54+
* [Architecture](feast-on-kubernetes/concepts/architecture.md)
55+
* [Entities](feast-on-kubernetes/concepts/entities.md)
56+
* [Sources](feast-on-kubernetes/concepts/sources.md)
57+
* [Feature Tables](feast-on-kubernetes/concepts/feature-tables.md)
58+
* [Stores](feast-on-kubernetes/concepts/stores.md)
59+
* [Glossary](feast-on-kubernetes/concepts/glossary.md)
60+
* [Tutorials](feast-on-kubernetes/tutorials-1/README.md)
61+
* [Minimal Ride Hailing Example](https://github.com/feast-dev/feast/blob/master/examples/minimal/minimal_ride_hailing.ipynb)
62+
* [User Guide](feast-on-kubernetes/user-guide/README.md)
63+
* [Overview](feast-on-kubernetes/user-guide/overview.md)
64+
* [Getting online features](feast-on-kubernetes/user-guide/getting-online-features.md)
65+
* [Getting training features](feast-on-kubernetes/user-guide/getting-training-features.md)
66+
* [Define and ingest features](feast-on-kubernetes/user-guide/define-and-ingest-features.md)
67+
* [Reference](feast-on-kubernetes/reference-1/README.md)
68+
* [Configuration Reference](feast-on-kubernetes/reference-1/configuration-reference.md)
69+
* [Feast and Spark](feast-on-kubernetes/reference-1/feast-and-spark.md)
70+
* [Metrics Reference](feast-on-kubernetes/reference-1/metrics-reference.md)
71+
* [Limitations](feast-on-kubernetes/reference-1/limitations.md)
72+
* [API Reference](feast-on-kubernetes/reference-1/api/README.md)
73+
* [Go SDK](https://godoc.org/github.com/feast-dev/feast/sdk/go)
74+
* [Java SDK](https://javadoc.io/doc/dev.feast/feast-sdk)
75+
* [Core gRPC API](https://api.docs.feast.dev/grpc/feast/core/coreservice.pb.html)
76+
* [Python SDK](https://api.docs.feast.dev/python/)
77+
* [Serving gRPC API](https://api.docs.feast.dev/grpc/feast/serving/servingservice.pb.html)
78+
* [gRPC Types](https://api.docs.feast.dev/grpc/feast/types/value.pb)
79+
* [Advanced](feast-on-kubernetes/advanced-1/README.md)
80+
* [Troubleshooting](feast-on-kubernetes/advanced-1/troubleshooting.md)
81+
* [Metrics](feast-on-kubernetes/advanced-1/metrics.md)
82+
* [Audit Logging](feast-on-kubernetes/advanced-1/audit-logging.md)
83+
* [Security](feast-on-kubernetes/advanced-1/security.md)
84+
* [Upgrading Feast](feast-on-kubernetes/advanced-1/upgrading.md)
85+
* [Telemetry](feast-on-kubernetes/advanced-1/telemetry.md)
6486

6587
## Contributing
6688

‎docs/architecture.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Architecture
2+

‎docs/build-a-training-dataset.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Build a training dataset
2+

‎docs/contributing/release-process.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For Feast maintainers, these are the concrete steps for making a new release.
3737
2. Add the change log by applying the change log commit created in step 2.
3838
3. Check that versions are updated with `env TARGET_MERGE_BRANCH=master make lint-versions`
3939
7. Create a [GitHub release](https://github.com/feast-dev/feast/releases) which includes a summary of im~~p~~ortant changes as well as any artifacts associated with the release. Make sure to include the same change log as added in [CHANGELOG.md](https://github.com/feast-dev/feast/blob/master/CHANGELOG.md). Use `Feast vX.Y.Z` as the title.
40-
8. Update the[ Upgrade Guide](../advanced/upgrading.md) to include the action required instructions for users to upgrade to this new release. Instructions should include a migration for each breaking change made to this release.
40+
8. Update the[ Upgrade Guide](../feast-on-kubernetes/advanced-1/upgrading.md) to include the action required instructions for users to upgrade to this new release. Instructions should include a migration for each breaking change made to this release.
4141
9. Update[ Feast Supported Versions]() to include the supported versions of each component.
4242

4343
When a tag that matches a Semantic Version string is pushed, CI will automatically build and push the relevant artifacts to their repositories or package managers \(docker images, Python wheels, etc\). JVM artifacts are promoted from Sonatype OSSRH to Maven Central, but it sometimes takes some time for them to be available. The `sdk/go/v tag` is required to version the Go SDK go module so that users can go get a specific tagged release of the Go SDK.

‎docs/create-a-feature-repository.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Create a feature repository
2+

‎docs/deploy-a-feature-store.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Deploy a feature store
2+

‎docs/entities.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Entities
2+

‎docs/feast-on-kubernetes/advanced-1/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Advanced
2+

‎docs/feast-on-kubernetes/advanced-1/audit-logging.md‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Audit Logging
2+
3+
{% hint style="warning" %}
4+
This page applies to Feast 0.7. The content may be out of date for Feast 0.8+
5+
{% endhint %}
6+
7+
## Introduction
8+
9+
Feast provides audit logging functionality in order to debug problems and to trace the lineage of events.
10+
11+
## Audit Log Types
12+
13+
Audit Logs produced by Feast come in three favors:
14+
15+
| Audit Log Type | Description |
16+
| :--- | :--- |
17+
| Message Audit Log | Logs service calls that can be used to track Feast request handling. Currently only gRPC request/response is supported. Enabling Message Audit Logs can be resource intensive and significantly increase latency, as such is not recommended on Online Serving. |
18+
| Transition Audit Log | Logs transitions in status in resources managed by Feast \(ie an Ingestion Job becoming RUNNING\). |
19+
| Action Audit Log | Logs actions performed on a specific resource managed by Feast \(ie an Ingestion Job is aborted\). |
20+
21+
## Configuration
22+
23+
| Audit Log Type | Description |
24+
| :--- | :--- |
25+
| Message Audit Log | Enabled when both `feast.logging.audit.enabled` and `feast.logging.audit.messageLogging.enabled` is set to `true` |
26+
| Transition Audit Log | Enabled when `feast.logging.audit.enabled` is set to `true` |
27+
| Action Audit Log | Enabled when `feast.logging.audit.enabled` is set to `true` |
28+
29+
## JSON Format
30+
31+
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:
32+
33+
```text
34+
{
35+
"message": {
36+
"logType": "FeastAuditLogEntry",
37+
"kind": "MESSAGE",
38+
"statusCode": "OK",
39+
"request": {
40+
"filter": {
41+
"project": "dummy",
42+
}
43+
},
44+
"application": "Feast",
45+
"response": {},
46+
"method": "ListFeatureTables",
47+
"identity": "105960238928959148073",
48+
"service": "CoreService",
49+
"component": "feast-core",
50+
"id": "45329ea9-0d48-46c5-b659-4604f6193711",
51+
"version": "0.10.0-SNAPSHOT"
52+
},
53+
"hostname": "feast.core"
54+
"timestamp": "2020-10-20T04:45:24Z",
55+
"severity": "INFO",
56+
}
57+
```
58+
59+
## Log Entry Schema
60+
61+
Fields common to all Audit Log Types:
62+
63+
| Field | Description |
64+
| :--- | :--- |
65+
| `logType` | Log Type. Always set to `FeastAuditLogEntry`. Useful for filtering out Feast audit logs. |
66+
| `application` | Application. Always set to `Feast`. |
67+
| `component` | Feast Component producing the Audit Log. Set to `feast-core` for Feast Core and `feast-serving` for Feast Serving. Use to filtering out Audit Logs by component. |
68+
| `version` | Version of Feast producing this Audit Log. Use to filtering out Audit Logs by version. |
69+
70+
Fields in Message Audit Log Type
71+
72+
| Field | Description |
73+
| :--- | :--- |
74+
| `id` | Generated UUID that uniquely identifies the service call. |
75+
| `service` | Name of the Service that handled the service call. |
76+
| `method` | Name of the Method that handled the service call. Useful for filtering Audit Logs by method \(ie `ApplyFeatureTable` calls\) |
77+
| `request` | Full request submitted by client in the service call as JSON. |
78+
| `response` | Full response returned to client by the service after handling the service call as JSON. |
79+
| `identity` | Identity of the client making the service call as an user Id. Only set when Authentication is enabled. |
80+
| `statusCode` | The status code returned by the service handling the service call \(ie `OK` if service call handled without error\). |
81+
82+
Fields in Action Audit Log Type
83+
84+
| Field | Description |
85+
| :--- | :--- |
86+
| `action` | Name of the action taken on the resource. |
87+
| `resource.type` | Type of resource of which the action was taken on \(i.e `FeatureTable`\) |
88+
| resource.id | Identifier specifying the specific resource of which the action was taken on. |
89+
90+
Fields in Transition Audit Log Type
91+
92+
| Field | Description |
93+
| :--- | :--- |
94+
| `status` | The new status that the resource transitioned to |
95+
| `resource.type` | Type of resource of which the transition occurred \(i.e `FeatureTable`\) |
96+
| `resource.id` | Identifier specifying the specific resource of which the transition occurred. |
97+
98+
## Log Forwarder
99+
100+
Feast currently only supports forwarding Request/Response \(Message Audit Log Type\) logs to an external fluentD service with `feast.**` Fluentd tag.
101+
102+
### Request/Response Log Example
103+
104+
```text
105+
{
106+
"id": "45329ea9-0d48-46c5-b659-4604f6193711",
107+
"service": "CoreService"
108+
"status_code": "OK",
109+
"identity": "105960238928959148073",
110+
"method": "ListProjects",
111+
"request": {},
112+
"response": {
113+
"projects": [
114+
"default", "project1", "project2"
115+
]
116+
}
117+
"release_name": 506.457.14.512
118+
}
119+
```
120+
121+
### Configuration
122+
123+
The Fluentd Log Forwarder configured with the with the following configuration options in `application.yml`:
124+
125+
| Settings | Description |
126+
| :--- | :--- |
127+
| `feast.logging.audit.messageLogging.destination` | `fluentd` |
128+
| `feast.logging.audit.messageLogging.fluentdHost` | `localhost` |
129+
| `feast.logging.audit.messageLogging.fluentdPort` | `24224` |
130+
131+
When using Fluentd as the Log forwarder, a Feast `release_name` can be logged instead of the IP address \(eg. IP of Kubernetes pod deployment\), by setting an environment variable `RELEASE_NAME` when deploying Feast.
132+

0 commit comments

Comments
 (0)