Almost all aspects of DeepSearch stack are documented via its settings:
in the case of helm deployment -
.yamlfile included in the stack helm chart (see Helm configuration for more details).
in the case of docker-compose deployment - (
.env) file included in the stack tarball we provide (see Docker compose configuration for more details).
We try to keep our documentation on settings and options as close to the “code” as possible here.
That file should be self explanatory, with settings and comments talking about what they do.
This document should be considered an addendum to information in the
.env files respectively.
Monitoring your instances is imperative to understanding the general health of the system and if more resources are necessary. At a minimum, one should monitor:
CPU and LA
Additionally, NGSearch stack itself exposes quite a few metrics about its load characteristics (such as number of assets that awaits processing, number of processed assets, memory and CPU load, etc).
We recommend to take advantage of these metrics. We expose them to be consumable by Prometheus. As usual, the ports for scraping metrics can be found in the Stack`s
.env file. We also summarize them here for clarity:
Prometheus metrics port
NGSearch Search service
NGSearch Storage service
NGSearch Nucleus indexing
NGSearch Tags Crawling
Farm Worker service
Non Farm Worker service
Model Updater service
For more information about individual services please refer to Components.