Skip to content

Commit

Permalink
GitBook: [master] 12 pages modified
Browse files Browse the repository at this point in the history
  • Loading branch information
woop authored and gitbook-bot committed Nov 2, 2020
1 parent c3d0d43 commit 34811e7
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 213 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The best way to learn Feast is to use it. Jump over to our [Quickstart](quicksta
* The [Concepts](./) section describes all important Feast API concepts.
* The [User guide](user-guide/data-ingestion.md) section provides guidance on completing Feast workflows.
* The [Examples](https://github.com/feast-dev/feast/tree/master/examples) section contains Jupyter notebooks that you can run on your Feast deployment.
* The [Advanced](advanced/stores.md) section contains information about both advanced and operational aspects of Feast.
* The [Advanced]() section contains information about both advanced and operational aspects of Feast.
* The [Reference](reference/api/) section contains detailed API and design documents for advanced users.
* The [Contributing](contributing/contributing.md) section contains resources for anyone who wants to contribute to Feast.

3 changes: 0 additions & 3 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@

## Advanced

* [Stores](advanced/stores.md)
* [Security](advanced/security.md)
* [Audit Logging](advanced/audit-logging.md)
* [Metrics](advanced/metrics.md)
Expand All @@ -52,10 +51,8 @@
* [Go SDK](https://godoc.org/github.com/feast-dev/feast/sdk/go)
* [Metrics Reference](reference/metrics-reference/README.md)
* [Java SDK](https://javadoc.io/doc/dev.feast/feast-sdk)
* [API, Supported Versions & Deprecation](reference/api-supported-versions-and-deprecation/README.md)
* [Python SDK](https://api.docs.feast.dev/python/)
* [Limitations](reference/limitations.md)
* [Design Decisions](reference/design-decisions.md)

## Contributing

Expand Down
16 changes: 8 additions & 8 deletions docs/advanced/metrics.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Metrics

## 0. Overview
### Overview

Feast Components export metrics that can provide insight into Feast behavior:

* [Feast Ingestion Jobs can be configured to push metrics into StatsD](metrics.md#2-exporting-feast-metrics-to-prometheus)
* [Prometheus can be configured to scrap metrics from Feast Core and Serving.](metrics.md#2-exporting-feast-metrics-to-prometheus)
* [Prometheus can be configured to scrape metrics from Feast Core and Serving.](metrics.md#2-exporting-feast-metrics-to-prometheus)

See the [Metrics Reference ](../reference/metrics-reference/)for documentation on metrics are exported by Feast.

{% hint style="info" %}
Feast Job Controller currently does not export any metrics on its own. However its `application.yml` is used to configure metrics export for ingestion jobs.
{% endhint %}

## 1. Pushing Ingestion Metrics to StatsD
### Pushing Ingestion Metrics to StatsD

**Feast Ingestion Job**
#### **Feast Ingestion Job**

Feast Ingestion Job can be configured to push Ingestion metrics to a StatsD instance. Metrics export to StatsD for Ingestion Job is configured in Job Controller's `application.yml` under `feast.jobs.metrics`:
Feast Ingestion Job can be configured to push Ingestion metrics to a StatsD instance. Metrics export to StatsD for Ingestion Job is configured in Job Controller's `application.yml` under `feast.jobs.metrics`

```yaml
feast:
Expand All @@ -35,9 +35,9 @@ Feast Ingestion Job can be configured to push Ingestion metrics to a StatsD inst
If you need Ingestion Metrics in Prometheus or some other metrics backend, use a metrics forwarder to forward Ingestion Metrics from StatsD to the metrics backend of choice. \(ie Use [`prometheus-statsd-exporter`](https://github.com/prometheus/statsd_exporter) to forward metrics to Prometheus\).
{% endhint %}

## 2. Exporting Feast Metrics to Prometheus
### Exporting Feast Metrics to Prometheus

**Feast Core and Serving**
#### **Feast Core and Serving**

Feast Core and Serving exports metrics to a Prometheus instance via Prometheus scraping its `/metrics` endpoint. Metrics export to Prometheus for Core and Serving can be configured via their corresponding `application.yml`

Expand All @@ -49,7 +49,7 @@ server:

[Direct Prometheus](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) to scrape directly from Core and Serving's `/metrics` endpoint.

## 3. Futher Reading.
### Further Reading

See the [Metrics Reference ](../reference/metrics-reference/)for documentation on metrics are exported by Feast.

Expand Down
37 changes: 0 additions & 37 deletions docs/advanced/stores.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ Streaming systems can also ingest data into Feast. This is done by publishing to

Stores are nothing more than databases used to store feature data. Feast loads data into stores through an ingestion process, after which the data can be served through the [Feast Online Serving API](https://api.docs.feast.dev/grpc/feast.serving.pb.html). Stores are documented in the following section.

{% page-ref page="../advanced/stores.md" %}

### **Feast Online Serving**

`Feast Online Serving` is the data-access layer through which end users and production systems retrieve feature data. Each `Serving` instance is backed by a [store](../advanced/stores.md).
`Feast Online Serving` is the data-access layer through which end users and production systems retrieve feature data. Each `Serving` instance is backed by a [store]().

Because Feast supports multiple store types \(online, historical\), multiple instances of a deployed `Feast Online Serving` is common: those for online serving and those for historical. This means Feast allows for any number of `Feast Online Serving` deployments, presenting the possibility to use a `Feast Online Serving` deployment per production system, with its own stores and population jobs.

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Feature creators model the data within their organization into Feast through the

Feature tables are both a schema and a means of identifying data sources for features. They allow Feast to know how to interpret your data, and optionally where to find it. Feature tables allow you to define domain [entities](entities.md) along with the features that are available on these entities. Feature tables also allow you to define schemas that describe properties of the respective data, which in turn can be used for validation purposes.

After you register a feature table, Feast creates the relevant schemas to store feature data within its feature [stores](../advanced/stores.md). These stores are then populated by [ingestion jobs](../user-guide/data-ingestion.md) that ingest data from data [sources](sources.md). The now data-rich stores enable Feast to provide access to features for training and serving. Alternatively, you can [ingest](../user-guide/data-ingestion.md) data into Feast instead of using an external source.
After you register a feature table, Feast creates the relevant schemas to store feature data within its feature [stores](). These stores are then populated by [ingestion jobs](../user-guide/data-ingestion.md) that ingest data from data [sources](sources.md). The now data-rich stores enable Feast to provide access to features for training and serving. Alternatively, you can [ingest](../user-guide/data-ingestion.md) data into Feast instead of using an external source.

Visit [feature tables](feature-tables.md) to learn more about them.

Expand Down Expand Up @@ -58,7 +58,7 @@ The logical grouping of these resources is important for namespacing and retriev

[Feature Tables](feature-tables.md) are schemas that define logical groupings of features, data sources, and other related metadata.

[Stores](../advanced/stores.md) are databases that maintain feature data that gets served to models during training or inference.
[Stores]() are databases that maintain feature data that gets served to models during training or inference.

[Ingestion](../user-guide/data-ingestion.md) is the process of loading data into Feast.

2 changes: 1 addition & 1 deletion docs/contributing/development-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ docker run --name redis --rm -it -d -p 6379:6379 redis:5-alpine
* Redis is running locally and accessible from `localhost:6379`
* \(optional\) The local environment has been authentication with Google Cloud Platform and has full access to BigQuery. This is only necessary for BigQuery testing/development.

Next, clone Feast repository.
Clone Feast repository.

```bash
git clone https://github.com/feast-dev/feast.git && cd feast
Expand Down
9 changes: 4 additions & 5 deletions docs/contributing/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Contributors are encouraged to understand our branch workflow described below, f

A release branch should be substantially _feature complete_ with respect to the intended release. Code that is committed to `master` may be merged or cherry-picked on to a release branch, but code that is directly committed to a release branch should be solely applicable to that release \(and should not be committed back to master\).

In general, unless you're committing code that only applies to a particular release stream \(for example, temporary hotfixes, backported security fixes, or image hashes\), you should base changes from `master` and then merge or cherry-pick to the release branch.
In general, unless you're committing code that only applies to a particular release stream \(for example, temporary hot-fixes, back-ported security fixes, or image hashes\), you should base changes from `master` and then merge or cherry-pick to the release branch.

## Release process

Expand All @@ -38,7 +38,7 @@ For Feast maintainers, these are the concrete steps for making a new release.
3. Check that versions are updated with `env TARGET_MERGE_BRANCH=master make lint-versions`
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.
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.
9. Update[ Feast Supported Versions](../reference/api-supported-versions-and-deprecation/#3-supported-versions) to include the supported versions of each component.
9. Update[ Feast Supported Versions]() to include the supported versions of each component.

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.

Expand Down Expand Up @@ -75,8 +75,7 @@ docker run -it --rm ferrarimarco/github-changelog-generator \

### Flag Breaking Changes & Deprecations

It's important to flag breaking changes and deprecation to the API for each release so that we can maintain [API compatibility](../reference/api-supported-versions-and-deprecation/#2-api-compatibility).
It's important to flag breaking changes and deprecation to the API for each release so that we can maintain API compatibility.

* Developers should have flagged PRs with breaking changes with the `compat/breaking` label. However, it's important to double check each PR's release notes and contents for changes that will break [API compatibility](https://app.gitbook.com/@feast/s/docs/~/drafts/-MGstXoieRglzkPw_d1Q/v/master/reference/api-supported-versions-and-deprecation#2-api-compatibility) and manually label `compat/breaking` to PRs with undeclared breaking changes. The change log will have to be regenerated if any new labels have to be added.
* Record any deprecation in [Deprecations Page](../reference/api-supported-versions-and-deprecation/#4-deprecations).
Developers should have flagged PRs with breaking changes with the `compat/breaking` label. However, it's important to double check each PR's release notes and contents for changes that will break API compatibility and manually label `compat/breaking` to PRs with undeclared breaking changes. The change log will have to be regenerated if any new labels have to be added.

2 changes: 1 addition & 1 deletion docs/getting-started/learn-feast.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Explore the following resources to learn more about Feast:
* The [Concepts](../) section describes all important Feast API concepts.
* The [User guide](../user-guide/data-ingestion.md) section provides guidance on completing Feast workflows.
* The [Examples](https://github.com/feast-dev/feast/tree/master/examples) section contains Jupyter notebooks that you can run on your Feast deployment.
* The [Advanced](../advanced/stores.md) section contains information about both advanced and operational aspects of Feast.
* The [Advanced]() section contains information about both advanced and operational aspects of Feast.
* The [Reference](../reference/api/) section contains detailed API and design documents for advanced users.
* The [Contributing](../contributing/contributing.md) section contains resources for anyone who wants to contribute to Feast.

Expand Down
Loading

0 comments on commit 34811e7

Please sign in to comment.