Which operating systems are supported?
Supported Linux distributions based on Debian 6 and RedHat 6 and above for i386 and x86_64 platforms, with a dependency on glibc library version 2.11
Starting with 0.3.3 an experimental version is shipped for Windows platform. The agents runs as 32bit application.
Starting with 0.4.5 an experimental version is shipped for amd64 FreeBSD 9.3+ platform.
For Linux and FreeBSD platforms,starting with version 0.4.4, mpstat utility from sysstat package is used to improve the wide_cpu_percent metric.
Which Sphinx versions are supported?
Sphinx Tools is tested on Sphinx 2.1.x , 2.2.x and 2.3.x. We try to incorporate new features on new released Sphinx versions as fast as possible. Also Sphinx Tools will have support for the upcoming 3.0.
You can use Sphinx Tools with older versions, however you could get unexpected behaviours, especially on creating/editing indexes.
If you are using Sphinx 2.0.x or older we recommend upgrading at least to 2.1.x.
If you need support for an older Sphinx version, please contact us.
What's the difference between managed and monitor node?
The managed node requires installing the Manager Agent, which allows you editing the Sphinx configuration and perform operations on indexes.
Please note that it requires an open port to our servers, for the Tools service to be able to communicate with the installed agent.
The monitor node requires installing the Monitor Agent, which is only a monitoring tool which sends statistical data to Tools servers.
Please note that the Manager Agent comes with the monitor Agent included, so it's not needed to install them both
What is the Demo Node?
The Demo Node allows you to preview the features of a Managed Node without installing anything on your server
A Sphinx instance is created on our servers, containing several indexes.
Please note that, while the Demo Node use a Manager Agent, several functions like editing the Sphinx listen ports are disabled.
Also, the Demo Node contains only a Sphinx instance used to demonstrate the usage of Tools and is not intended as a free Sphinx instance.
Without notice, we may recreate, modify or shutdown the Demo node.
How many nodes can I add ?
Regular beta users can add up to 3 nodes.
After this beta program, we will offer a free user account. The number of free nodes is not yet established.
In addition, we will offer posibility to upgrade to a premium account. If you need more nodes during the beta, please let us know.
How do I upgrade an agent?
To perform an upgrade of an already installed Agent, just re-run the install command, which can be found on the Node View page.
The upgrade will keep the settings of the current Agent configuration.
How can I configure manually the Agents?
The agents are configured and configure themselves some working parameters. However, if you need to modify some of the built-in settings,please check this configuration help page for more information.
Can I use it in production?
Node Agent creates a backup of the
sphinx.conf before doing any editing. Using it on production boxes at this beta stage is on your risk.
Using it for operations that don't involve any changes for a Sphinx instance should be risk-free.
However, since it's a beta we recommend using it on development/testing instances only.
How this can impact my Sphinx server?
If monitoring is disabled, there is little impact on your server.
Monitoring runs every minute and can have a very low to small impact on the server, depending on the workload of the Sphinx service and the enabled monitoring features.
The monitor agent performs several SphinxQL commands and also some system metrics (like cpu, memory) are collected. Their impact should be very low.
Query analysis is done right now by reading the query.log, which can use a bit of CPU for the processing in case of high QPS.
Is the connection between Tools and my server secure?
All connections made between our server and the Agent use
We DO NOT STORE or CACHE your
sphinx.conf also, so any db credentials that you have in your
sphinx.conf are safe.
I want to improve the security. Which are the Tools servers IPs?
Sphinx Tools runs on the following IP(s):
More IPs will can be added in future.
Why can't I connect to my Agent?
Check if the port choosen for the Agent is not blocked.
Check if the API Key found in conf/sphinxagent.json is the same with the one from Account page.
Are shebang syntax configurations supported?
No. Doing any changes to a shebang syntax configuration can lead to wipe of the 'dynamic' sections in the file and corruption of the entire configuration.
Using for read-only operations only is not properly tested at this moment and can lead to unexpected behaviours of functionality of Tools (yet, without any harm for the Sphinx instance)
If I change my Sphinx configuration, will the Agent still work?
Every Sphinx instance a.k.a a node gets an unique UUID which is based on the machine ID and the SphinxQL port.
If you want to have several Agents running on the same machine, you need to edit sphinxagent.json file and point to proper Sphinx configuration for each Sphinx instance.
If you change the SphinxQL, you need to declare explicit in the sphinxagent.con the NODEID and NODEKEY that can be taken from the Node View page.
What is the retention of the monitored data?
The data has a retention of 3 months. This can be a subject of change in future and we'll notify all users if case.
In future, for premium users we will offer the option for a longer retention.
What is the organization?
The organization allows collaboration same nodes to different user accounts. When you register, an organization is also attached to your account and you are the owner of the organization.
You can add a number of users to your organization, depending on your account type.
You can also be added to other organizations.
The API KEY is shared among all users of the organizations, so any user can add a new node, but only the owner can delete nodes.
The owner is the one that can set the alerts for each node, but each user (including the owner) can choose whenever to receive or not alerts.
What is the Actions page for?
Some operations can take some time, like restarting searchd or rotating an index. The Node Agent informs the UI of Tools when the operation is finished.
The output of the operation ( either it's from searchd or indexer ) is logged as well, regardless if the operation was successful or failed.
This feature is currently in an early stage.
Can I have a self-hosted version of Tools?
Right now, we don't offer this option, but we are still testing a self-hosted version. If you are interested about it, please drop us an email and we'll let you know when it's ready.