Estimated time to read: 3 minutes
Starting with EraSearch v1.23.0, an optional Usage Service is included with EraSearch. This service tracks the volume of data ingested per index for billing and monitoring purposes. The Usage Service automatically writes data to EraSearch, letting you generate reports on byte-level volumes of data ingested over time.
This page outlines how to deploy the Usage Service and how to configure it with EraSearch RBAC.
Deploying the Usage Service¶
To deploy the Usage Service alongside an EraSearch deployment:
Add the following
usagesection to your Helm values file (
Upgrade your EraSearch deployment with the command below. Successful upgrade commands return several deployment details and
The Usage Service now tracks data ingestion, and you can query the data in the
usageindex. If you're using EraSearch RBAC, continue to the next section to finish setting up the new service.
Configuring RBAC for the Usage Service¶
If you're using EraSearch RBAC, then you need to add an API key with both read and write privileges on the
usage index to the Usage Service configuration. The steps below show how to do that with a Kubernetes secret.
Create a role and API key for the usage service. If using the
eractlCLI tool, create the role and API key with the commands below. The last command writes the API key to the local file
To create the Kubernetes secret, collect the API key value from the
api_keyfield from the
With the API key created, create the Kubernetes secret with the
Add the relevant information to the Helm values file under the
secretKeyoptions so that the Usage Service can use it:
helm upgradecommand as referenced in the section above to deploy the Usage Service with the updated configuration.
- For security purposes, remove the local file you created in step 1 (
You're all set. The Usage Service is tracking data ingestion and writing the data to the