-
Notifications
You must be signed in to change notification settings - Fork 1.3k
feat: Add document of Go feature server. #5697
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Go feature server (Alpha) | ||
|
|
||
| ## Overview | ||
| The Go feature server is an HTTP/gRPC endpoint that serves features. It is written in Go. | ||
|
|
||
| ## Configuration of `feature_store.yaml` | ||
| The current Go feature server needs a Python based feature Transforamtion service support. Please refer to the following code as an example: | ||
| ``` | ||
| # -*- coding: utf-8 -*- | ||
| from feast.feature_store import FeatureStore | ||
|
|
||
|
|
||
| def main(): | ||
| # Init the Feature Store | ||
| store = FeatureStore(repo_path="./feature_repo/") | ||
|
|
||
| # Start the feature transformation server | ||
| # default port is 6569 | ||
| store.serve_transformations(6569) | ||
|
|
||
| if __name__ == "__main__": | ||
| main() | ||
| ``` | ||
| At the same time, we need to configure the `feature_store.yaml` as following: | ||
|
|
||
| ``` | ||
| ... | ||
| entity_key_serialization_version: 3 | ||
| feature_server: | ||
| type: local | ||
| transformation_service_endpoint: "localhost:6569" | ||
| ... | ||
| ``` | ||
| ## Supported APIs | ||
| Here is the list of supported APIs: | ||
| | Method | API | Comment | | ||
| |:---: | :---: | :---: | | ||
| | POST | /get-online-features | Retrieve features of one or many entities | | ||
| | GET | /health | Status of the Go Feature Server | | ||
|
|
||
| ## OTEL based Observability | ||
| The Go feature server support [OTEL](https://opentelemetry.io/) based Observabilities. | ||
| To enable it, we need to set the global env `ENABLE_OTEL_TRACING` to `"true"` (as a string type!) in the contianer or your local OS. | ||
shuchu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
| export ENABLE_OTEL_TRACING='true' | ||
| ``` | ||
| There are example OTEL infra setup under the `/go/infra/docker/otel` folder. | ||
|
|
||
| ## Demo | ||
| Please check the Reference[2] for a local demo of Go feature server. If you want to see a real word example of applying Go feature server in Production, please check Reference[1]. | ||
shuchu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Reference | ||
| 1. [Expedia Group's Go Feature Server Implementation (in Production)](https://github.com/EXPEbdodla/feast) | ||
| 2. [A Go Feature server demo from Feast](https://github.com/feast-dev/feast-credit-score-local-tutorial) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.