Skip to content

Commit

Permalink
Add note about number of shards and replicas for ES (#330)
Browse files Browse the repository at this point in the history
  • Loading branch information
mh-park authored Aug 10, 2017
1 parent c75dce8 commit b381705
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ ElasticSearch does not require initialization other than
[installing and running ElasticSearch](https://www.elastic.co/downloads/elasticsearch).
Once it is running, pass the correct configuration values to the Jaeger collector and query service.

#### Shards and Replicas for ElasticSearch indices

Shards and replicas are some configuration values to take special attention to, because this is decided upon
index creation. [This article](https://qbox.io/blog/optimizing-elasticsearch-how-many-shards-per-index) goes into
more information about choosing how many shards should be chosen for optimization.

## Query Service & UI

**jaeger-query** serves the API endpoints and a React/Javascript UI.
Expand Down
6 changes: 6 additions & 0 deletions plugin/storage/es/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ The conversion is done automatically.
ElasticSearch schema used for Jaeger. This allows for better search capabilities and data retention. However, because
ElasticSearch creates a new document for every nested field, there is currently a limit of 50 nested fields per document.

### Shards and Replicas
Number of shards and replicas per index can be specified as parameters to the writer and/or through configs under
`./pkg/es/config/config.go`. If not specified, it defaults to ElasticSearch defaults: 5 shards and 1 replica.
[This article](https://qbox.io/blog/optimizing-elasticsearch-how-many-shards-per-index) goes into more information
about choosing how many shards should be chosen for optimization.

## Limitations

### Separation of Spans and Service:Operation Pairs
Expand Down

0 comments on commit b381705

Please sign in to comment.