Cassandra agent
Prerequisites
- For prerequisite checks for agent installation, see Prerequisite checks for agent installation.
- URL/IP of the SixthSense collector (your tenant URL which will be provided by Customer Support).
- Access token from the SixthSense portal. For accessing the token, see Accessing your Access Token under Getting started with the Observability Portal.
- Cassandra agent version "latest".
- database details (host name, port, database name, database user credentials).
- Package token to download agent which will be provided by Customer Support.
- Database User Permissions: Grant SELECT permission for all keyspaces to <db_user>.
Downloading the agent
For Windows and Linux based servers, use the following link.
curl --header "PRIVATE-TOKEN:{TOKEN}" --output meter-agent.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/METER-AGENT/latest/meter-agent.zip"
note
Agent depends on the OS and architecture.
Configuring the agent
- Extract CassandraDB_Linux.zip file.
- Edit the configuration in yaml file as follows.
In the yaml file, add the following configuration details:
- service_name: Service name will display on UI
- authentication: Get access token from dashboard under setting
- sixthsense_backend: Backend collector URL
- hostname: hostname
- port: port
- user: db_user
- password: db_user_password
- keyspace: keyspace_name
- queryLimit: 10 (no of queries)
- queryThresholdTime: 1 #millisecond
Running the agent
For Linux:
Run Cassandra agent in the terminal using the following commnad.
./meter-agent-linux path/to/config/ss-cassandra-config.yaml
In case of network restrictions, pass proxy to the meter-agent process so that you can connect to the sixthsense-backend.
HTTPS_PROXY=proxy-server:port./meter-agent-linux path/to/config/ss-cassandra-config.yaml
For Windows:
- Extract CassandraDB_Windows.zip file.
- Edit configuration in the yaml file as follows.
- Open command prompt with run as Administrator and enter following command:
nssm.exe install “Service_Name”
- In the NSSM service installer window, the Application tab is selected by default.
- Enter the following details:
- Path: meter-agent.exe full path
- Startup directory: folder path
- Arguments: yaml full name
- Click the Details tab.
- Enter the following details:
- Display name: service display name
- Description: service description
- Setup type: select type for setup such as automatic.
- Click the Log on tab.
- Select Local System account radio button.
- Select Allow service to interact with desktop check box.
- Click Install service.
Editing the configuration in the yaml file
In the yaml file, add the following configuration details:
- service_name: Service name will display on UI
- authentication: Get access token from dashboard under setting
- sixthsense_backend: Backend collector URL
- hostname: hostname
- port: port
- user: db_user
- password: db_user_password
note
It supports instance name also with hostname