Go to file
David Roberts 15e7b06b79
[ML] Add inference cache hit count to inference node stats (#88807)
The inference node stats for deployed PyTorch inference
models now contain two new fields: `inference_cache_hit_count`
and `inference_cache_hit_count_last_minute`.

These indicate how many inferences on that node were served
from the C++-side response cache that was added in
https://github.com/elastic/ml-cpp/pull/2305. Cache hits
occur when exactly the same inference request is sent to the
same node more than once.

The `average_inference_time_ms` and
`average_inference_time_ms_last_minute` fields now refer to
the time taken to do the cache lookup, plus, if necessary,
the time to do the inference. We would expect average inference
time to be vastly reduced in situations where the cache hit
rate is high.
2022-07-26 17:53:43 +01:00
.ci Fix CI job naming 2022-07-21 13:22:28 -07:00
.github Remove GitHub action for syncing main branch with master 2022-07-22 16:19:58 -07:00
.idea Stop versioning Checkstyle IDE config (#87285) 2022-06-02 08:58:11 +01:00
benchmarks Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
build-conventions Fix checkstyle version drift and API change (#88283) 2022-07-05 21:37:16 +01:00
build-tools Reinstate test cluster throttling behavior (#88664) 2022-07-21 12:24:24 +02:00
build-tools-internal Update references to master branch in build benchmark configuration (#88787) 2022-07-26 09:51:42 -07:00
ccr/images [DOCS] Update remote cluster docs (#77043) 2021-09-22 16:02:33 -04:00
client Setup elasticsearch dependency monitoring with Snyk for production code (#88036) 2022-06-29 13:29:14 +02:00
dev-tools
distribution Add support for reading stable plugin descriptors (#88731) 2022-07-26 10:28:24 +09:30
docs [ML] Add inference cache hit count to inference node stats (#88807) 2022-07-26 17:53:43 +01:00
gradle Remove random runner from build tools (internal) tests (#88577) 2022-07-20 08:04:26 +02:00
libs Add package cache to EmbeddedImplClassLoader (#88537) 2022-07-25 15:31:58 +01:00
licenses
modules Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
plugins Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
qa Add support for reading stable plugin descriptors (#88731) 2022-07-26 10:28:24 +09:30
rest-api-spec Add min_* conditions to rollover (#83345) 2022-07-26 11:46:39 -04:00
server Add min_* conditions to rollover (#83345) 2022-07-26 11:46:39 -04:00
test Add FieldDataContext (#88779) 2022-07-26 14:47:50 +01:00
x-pack [ML] Add inference cache hit count to inference node stats (#88807) 2022-07-26 17:53:43 +01:00
.backportrc.json Update backport config file to use main as default branch 2022-07-22 16:26:55 -07:00
.dir-locals.el
.editorconfig SQL: Fix FORMAT function to better comply with Microsoft SQL Server specification (#86225) 2022-05-18 12:03:00 +02:00
.git-blame-ignore-revs Fix typo in instructions for ignore-revs (#80058) 2021-11-04 12:10:55 +11:00
.gitattributes Assert no carriage returns in release notes test samples (#77238) 2021-09-07 20:45:23 +01:00
.gitignore Stop versioning Checkstyle IDE config (#87285) 2022-06-02 08:58:11 +01:00
BUILDING.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
CHANGELOG.md Add changelog (#83830) 2022-02-11 13:29:22 +00:00
CONTRIBUTING.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
LICENSE.txt
NOTICE.txt Remove Joda dependency (#79007) 2021-10-13 17:37:31 -07:00
README.asciidoc [DOCS] Refactor quick start guide and README (#71331) 2021-04-20 09:32:21 -04:00
REST_API_COMPATIBILITY.md Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
TESTING.asciidoc Update references to master branch in developer documentation 2022-07-25 10:59:08 -07:00
Vagrantfile Introduce ES_JAVA_HOME (#68954) 2021-02-17 12:41:23 -05:00
build.gradle Add noop placeholder checkPart3 task 2022-07-25 10:39:38 -07:00
gradle.properties Allow easing testing of java ea versions using gradle java tool chain support (#88188) 2022-07-04 08:43:18 +02:00
gradlew Update to to Gradle wrapper 7.5 (#85141) 2022-07-19 08:12:19 +02:00
gradlew.bat Update to to Gradle wrapper 7.5 (#85141) 2022-07-19 08:12:19 +02:00
settings.gradle Remove duplicate definition of checkstyle version in use (#88339) 2022-07-15 19:31:50 +02:00

README.asciidoc

= Elasticsearch

Elasticsearch is the distributed, RESTful search and analytics engine at the
heart of the https://www.elastic.co/products[Elastic Stack]. You can use
Elasticsearch to store, search, and manage data for:

* Logs
* Metrics
* A search backend
* Application monitoring
* Endpoint security

\... and more!

To learn more about Elasticsearch's features and capabilities, see our
https://www.elastic.co/products/elasticsearch[product page].

[[get-started]]
== Get started

The simplest way to set up Elasticsearch is to create a managed deployment with
https://www.elastic.co/cloud/as-a-service[Elasticsearch Service on Elastic
Cloud].

If you prefer to install and manage Elasticsearch yourself, you can download
the latest version from 
https://www.elastic.co/downloads/elasticsearch[elastic.co/downloads/elasticsearch].

For more installation options, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html[Elasticsearch installation
documentation].

[[upgrade]]
== Upgrade

To upgrade from an earlier version of Elasticsearch, see the
https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html[Elasticsearch upgrade
documentation].

[[build-source]]
== Build from source

Elasticsearch uses https://gradle.org[Gradle] for its build system.

To build a distribution for your local OS and print its output location upon
completion, run:
----
./gradlew localDistro
----

To build a distribution for another platform, run the related command:
----
./gradlew :distribution:archives:linux-tar:assemble
./gradlew :distribution:archives:darwin-tar:assemble
./gradlew :distribution:archives:windows-zip:assemble
----

To build distributions for all supported platforms, run:
----
./gradlew assemble
----

Distributions are output to `distributions/archives`.

To run the test suite, see xref:TESTING.asciidoc[TESTING].

[[docs]]
== Documentation

For the complete Elasticsearch documentation visit
https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html[elastic.co].

For information about our documentation processes, see the
xref:docs/README.asciidoc[docs README].

[[contribute]]
== Contribute

For contribution guidelines, see xref:CONTRIBUTING.md[CONTRIBUTING]. 

[[questions]]
== Questions? Problems? Suggestions?

* To report a bug or request a feature, create a
https://github.com/elastic/elasticsearch/issues/new/choose[GitHub Issue]. Please
ensure someone else hasn't created an issue for the same topic.

* Need help using Elasticsearch? Reach out on the
https://discuss.elastic.co[Elastic Forum] or https://ela.st/slack[Slack]. A
fellow community member or Elastic engineer will be happy to help you out.